Frame of Reference Game API
1.0.3
|
Represents a running instance of the game More...
Public Member Functions | |
Game () | |
Creates a new game instance More... | |
override void | Run () |
override void | Debug () |
override Lua | NewLua () |
DialogRenderer | LoadDialog (string name) |
Loads and displays a new dialog. More... | |
DialogRenderer | LoadModalDialog (string name) |
Loads and displays a new modal (exclusivly focused) dialog. More... | |
DialogRenderer | LoadSplashDialog (string name) |
Loads a new exclusive displayed splash-screen dialog. More... | |
void | LoadMenu (string name) |
Loads a map into _menuUniverse and switches the CurrentState to GameState.Menu More... | |
void | LoadMap (string name) |
Loads a game map into CurrentSession and switches the CurrentState to GameState.InGame More... | |
void | ModifyMap (string name) |
Loads a game map into CurrentSession and switches the CurrentState to GameState.Modify More... | |
void | SaveSavegame (string name) |
Saves the CurrentSession as a savegame stored in the user's profile. More... | |
void | LoadSavegame (string name) |
Loads a savegame from user's profile to replace the CurrentSession. More... | |
IEnumerable< string > | GetSavegameNames () |
Lists the names of all stored Sessions. More... | |
void | SwitchToMenu () |
Switches to the main menu More... | |
void | SwitchToGame () |
Switches the game to in-game mode More... | |
void | SwitchToModify () |
Switches the game to map modification mode More... | |
void | TogglePause () |
Toggles CurrentState between GameState.InGame and GameState.Pause More... | |
Public Member Functions inherited from OmegaEngine::GameBase | |
void | Exit () |
void | AddInputReceiver (IInputReceiver receiver) |
void | RemoveInputReceiver (IInputReceiver receiver) |
void | Dispose () |
Protected Member Functions | |
override void | Dispose (bool disposing) |
override void | ResetEngine () |
override EngineConfig | BuildEngineConfig (bool fullscreen) |
override void | ApplyGraphicsSettings () |
override bool | Initialize () |
override void | Render (double elapsedTime) |
Protected Member Functions inherited from OmegaEngine::GameBase | |
GameBase (string name, Icon icon=null, Image background=null, bool stretch=false) | |
void | ToFullscreen () |
void | ToWindowed (Size size) |
void | UpdateStatus (string message) |
Properties | |
GuiManager | GuiManager [get] |
Manages all GUI dialogs displayed in the game More... | |
Session | CurrentSession [get] |
The current game session More... | |
Presenter | CurrentPresenter [get] |
The currently active presenter More... | |
GameState | CurrentState [get] |
The current state of the game More... | |
Properties inherited from OmegaEngine::GameBase | |
bool | Disposed |
Engine | Engine |
bool | Fullscreen |
bool? | Loading |
KeyboardInputProvider | KeyboardInputProvider |
MouseInputProvider | MouseInputProvider |
TouchInputProvider | TouchInputProvider |
Additional Inherited Members | |
Static Public Member Functions inherited from OmegaEngine::GameBase | |
static void | Crash () |
Protected Attributes inherited from OmegaEngine::GameBase | |
readonly GameForm | Form |
Represents a running instance of the game
|
inline |
Creates a new game instance
|
inline |
Lists the names of all stored Sessions.
|
inline |
Loads and displays a new dialog.
name | The XML file to load from. |
|
inline |
Loads a game map into CurrentSession and switches the CurrentState to GameState.InGame
name | The name of the map to load |
|
inline |
Loads a map into _menuUniverse and switches the CurrentState to GameState.Menu
name | The name of the map to load |
|
inline |
Loads and displays a new modal (exclusivly focused) dialog.
name | The XML file to load from. |
|
inline |
Loads a savegame from user's profile to replace the CurrentSession.
name | The name of the savegame to load. |
|
inline |
Loads a new exclusive displayed splash-screen dialog.
name | The XML file to load from |
Calling this method will close all other DialogRenderers.
|
inline |
Loads a game map into CurrentSession and switches the CurrentState to GameState.Modify
name | The name of the map to load |
|
inline |
Saves the CurrentSession as a savegame stored in the user's profile.
name | The name of the savegame to write. |
|
inline |
Switches the game to in-game mode
If CurrentState is already GameState.InGame, nothing will happen. Loading may take a while, subsequent calls will be a bit faster because the Engine cache will still be hot
|
inline |
Switches to the main menu
If CurrentState is already GameState.Menu, nothing will happen. Loading will take a while on first call, subsequent calls will be very fast, because _menuUniverse is preserved
|
inline |
Switches the game to map modification mode
If CurrentState is already GameState.Modify, nothing will happen. Loading may take a while, subsequent calls will be a bit faster because the Engine cache will still be hot
|
inline |
Toggles CurrentState between GameState.InGame and GameState.Pause
When called while CurrentState is neither GameState.InGame nor GameState.Pause nothing happens
|
get |
The currently active presenter
|
get |
The current game session
|
get |
The current state of the game
|
get |
Manages all GUI dialogs displayed in the game