An extendable basis for an editor main window.
More...
|
void | ShowToast (string message) |
| Displays a new toast messages to the user. Any exisiting messages are replaced.
|
|
|
readonly Dictionary< Tab, ToolStripButton > | Tabs = new Dictionary<Tab, ToolStripButton>() |
|
Tab | CurrentTab => (from pair in Tabs where pair.Value.Checked select pair.Key).FirstOrDefault() |
| The currently visible tab More...
|
|
System.Windows.Forms.ToolStripMenuItem | menuFileModProperties |
|
System.Windows.Forms.ToolStripMenuItem | menuFilePackageMod |
|
System.Windows.Forms.ToolStripMenuItem | menuLanguageEnglish |
|
System.Windows.Forms.ToolStripMenuItem | menuLanguageGerman |
|
System.Windows.Forms.ToolStrip | toolStrip |
|
|
bool | Loading [get, set] |
| Indicates the editor is currently loading something and the user must wait. More...
|
|
An extendable basis for an editor main window.
Implement the hooks Restart, LaunchGame and ChangeLanguage.
◆ ChangeLanguage()
virtual void AlphaFramework.Editor.MainFormBase.ChangeLanguage |
( |
string |
language | ) |
|
|
inlineprotectedvirtual |
Applies a new language to the editor GUI, game logic, etc..
- Parameters
-
language | A two-letter ISO language code. |
◆ Dispose()
override void AlphaFramework.Editor.MainFormBase.Dispose |
( |
bool |
disposing | ) |
|
|
inlineprotected |
Clean up any resources being used.
- Parameters
-
disposing | true if managed resources should be disposed; otherwise, false. |
◆ LaunchGame()
virtual void AlphaFramework.Editor.MainFormBase.LaunchGame |
( |
string |
arguments | ) |
|
|
inlineprotectedvirtual |
Launches the main game with the currently active mod.
- Parameters
-
arguments | Additional arguments to be passed; may be null . |
- Exceptions
-
Win32Exception | The game executable could not be launched. |
BadImageFormatException | The game executable is damaged. |
◆ OpenFileTab< T >()
void AlphaFramework.Editor.MainFormBase.OpenFileTab< T > |
( |
string |
type, |
|
|
string |
extension, |
|
|
Func< string, bool, T > |
getInstance |
|
) |
| |
|
inlineprotected |
Displays a file-editing tab.
- Template Parameters
-
T | The tab type to display. |
- Parameters
-
type | The type of file the tab edits (e.g. Textures, Sounds, ...). |
extension | The file extension of the file type with a dot, but without a asterisk (e.g. .xml, .png, ...). |
getInstance | A callback for creating an instance of the tab. |
◆ Restart()
virtual void AlphaFramework.Editor.MainFormBase.Restart |
( |
| ) |
|
|
inlineprotectedvirtual |
Restarts the editor to allow the user to choose a different mod.
◆ ShowSingleInstanceTab< T >()
void AlphaFramework.Editor.MainFormBase.ShowSingleInstanceTab< T > |
( |
| ) |
|
|
inlineprotected |
Displays a single-instance tab.
- Template Parameters
-
T | The tab type to display. |
◆ CurrentTab
Tab AlphaFramework.Editor.MainFormBase.CurrentTab => (from pair in Tabs where pair.Value.Checked select pair.Key).FirstOrDefault() |
|
protected |
The currently visible tab
◆ Loading
bool AlphaFramework.Editor.MainFormBase.Loading |
|
getset |
Indicates the editor is currently loading something and the user must wait.
The documentation for this class was generated from the following files:
- Editor/MainFormBase.cs
- Editor/MainFormBase.Designer.cs