App::IGameMode class

#include <Spore ModAPI/Spore/App/IGameMode.h>

Derived classes

class DefaultGameMode

A class that provides default implementation for all the methods in a IGameMode.

class GameSpace

class IGameModeObject

Same as App::IGameMode, but this one includes a Cast method similar to the one in the Object class.

class cCellModeStrategy

class cCreatureModeStrategy

class cScenarioMode

class Editors::cEditor

Main class for editors.

Constructors, destructors, conversion operators

~IGameMode() virtual

Public functions

auto AddRef() -> int pure virtual

Increases the reference count and returns it.

auto Release() -> int pure virtual

Decreases the reference count and returns it.

auto func0Ch() -> bool pure virtual

auto Initialize(IGameModeManager* pManager) -> bool pure virtual

This method is called once on every game mode when all modes have been added.

auto Dispose() -> bool pure virtual

This method is called once on every game mode when the game closes.

auto OnEnter() -> bool pure virtual

This method is called when the game mode is set as active, and therefore, entered.

auto OnExit() -> void pure virtual

This method is called when a different game mode is set as active, and therefore, this game mode is exited (no longer active).

auto func20h(int) -> void* pure virtual

auto OnKeyDown(int virtualKey, KeyModifiers modifiers) -> bool pure virtual

An event listener called every time a key is pressed while this mode is active.

auto OnKeyUp(int virtualKey, KeyModifiers modifiers) -> bool pure virtual

An event listener called every time a key is released while this mode is active.

auto OnMouseDown(MouseButton mouseButton, float mouseX, float mouseY, MouseState mouseState) -> bool pure virtual

An event listener called every time a mouse key is pressed while this mode is active.

auto OnMouseUp(MouseButton mouseButton, float mouseX, float mouseY, MouseState mouseState) -> bool pure virtual

An event listener called every time a mouse key is released while this mode is active.

auto OnMouseMove(float mouseX, float mouseY, MouseState mouseState) -> bool pure virtual

An event listener called every time the mouse is moved while this mode is active.

auto OnMouseWheel(int wheelDelta, float mouseX, float mouseY, MouseState mouseState) -> bool pure virtual

An event listener called every time the mouse wheel is moved while this mode is active.

auto Update(float delta1, float delta2) -> void pure virtual

An event listener called every game loop.

Function documentation