Class MapEditor
- Namespace
- FrameOfReference.Editor.World
- Assembly
- FrameOfReference.Editor.dll
Allows the user to edit game maps
public class MapEditor : UndoCommandTab, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl
- Inheritance
-
MapEditor
- Implements
- Inherited Members
- Extension Methods
Constructors
MapEditor(string, bool)
Creates a new map editor.
public MapEditor(string filePath, bool overwrite)
Parameters
filePath
stringThe path to the file to be edited.
overwrite
booltrue
if an existing file supposed to be overwritten when SaveFile() is called.
Methods
Dispose(bool)
Clean up any resources being used.
protected override void Dispose(bool disposing)
Parameters
disposing
booltrue if managed resources should be disposed; otherwise, false.
OnDelete()
Hook to delete the currently selected object in this tab
protected override void OnDelete()
OnInitialize()
Called on startup to load the content for this tab.
protected override void OnInitialize()
Exceptions
- NotSupportedException
An unsupported graphics card feature is used.
- FileNotFoundException
A file could not be located.
- IOException
There was a problem reading a file.
- UnauthorizedAccessException
Read access to a file was denied.
- InvalidOperationException
There was a problem inside the engine.
- InvalidDataException
A file contained invalid data.
OnSaveFile()
Called when the content of this tab is to be saved to a file.
protected override void OnSaveFile()
Exceptions
- ArgumentException
The file path is invalid.
- NotSupportedException
The file path is invalid.
- IOException
There was a problem writing a file.
- UnauthorizedAccessException
Write access to a file was denied.
OnUpdate()
Called on startup, content updates and tab switch to refresh any on-screen displays
protected override void OnUpdate()
Redo()
Hook to redo the last undone change
public override void Redo()
Undo()
Hook to undo the last change
public override void Undo()