CryEngine.GameFramework

Classes | Public Member Functions | Static Public Member Functions | List of all members

Listens for engine sided updates and informs registered objects by calling their OnUpdate function. Objects may register here, in order to be invoked on global update calls. Controls target FPS. More...

Inherits IGameFrameworkListener.

Public Member Functions
override void	OnSaveGame (ISaveGame pSaveGame)
	Called when the engine saves the game. More...

override void	OnLoadGame (ILoadGame pLoadGame)
	Called by the engine when a game is loaded. More...

override void	OnForceLoadingWithFlash ()
	Called by the engine when loading is forced with Flash. More...

override void	OnLevelEnd (string nextLevel)
	Called by the engine when the level has ended. More...

override void	OnSavegameFileLoadedInMemory (string pLevelName)
	Called by the engine when the savegame file has loaded. More...

override void	OnActionEvent (SActionEvent arg0)
	Called by CryEngine. Do not call directly. More...

override void	OnPostUpdate (float fDeltaTime)
	Called by CryEngine. Do not call directly. More...

override void	OnPreRender ()
	Called by CryEngine. Do not call directly. More...

override void	Dispose ()
	Disposes of this instance. More...

Static Public Member Functions
static void	RegisterForUpdate (IGameUpdateReceiver obj)
	Registered object will be invoked on function OnUpdate if CryEngine's GameFramework raises OnPostUpdate. More...

static void	RegisterForRender (IGameRenderReceiver obj)
	Registered object will be invoked on function OnRender if CryEngine's GameFramework raises OnPreRender. More...

static void	UnregisterFromUpdate (IGameUpdateReceiver obj)
	Unregisters object from OnPostUpdate. More...

static void	UnregisterFromRender (IGameRenderReceiver obj)
	Unregisters object from OnPreRender. More...

Detailed Description

Listens for engine sided updates and informs registered objects by calling their OnUpdate function. Objects may register here, in order to be invoked on global update calls. Controls target FPS.

Member Function Documentation

◆ Dispose()

override void CryEngine.GameFramework.Dispose

(

)

inline

Disposes of this instance.

◆ OnActionEvent()

override void CryEngine.GameFramework.OnActionEvent

(

SActionEvent

arg0

)

inline

Called by CryEngine. Do not call directly.

◆ OnForceLoadingWithFlash()

override void CryEngine.GameFramework.OnForceLoadingWithFlash

(

)

inline

Called by the engine when loading is forced with Flash.

◆ OnLevelEnd()

override void CryEngine.GameFramework.OnLevelEnd

(

string

nextLevel

)

inline

Called by the engine when the level has ended.

Parameters

nextLevel

◆ OnLoadGame()

override void CryEngine.GameFramework.OnLoadGame

(

ILoadGame

pLoadGame

)

inline

Called by the engine when a game is loaded.

Parameters

pLoadGame

◆ OnPostUpdate()

override void CryEngine.GameFramework.OnPostUpdate

(

float

fDeltaTime

)

inline

Called by CryEngine. Do not call directly.

◆ OnPreRender()

override void CryEngine.GameFramework.OnPreRender

(

)

inline

Called by CryEngine. Do not call directly.

◆ OnSaveGame()

override void CryEngine.GameFramework.OnSaveGame

(

ISaveGame

pSaveGame

)

inline

Called when the engine saves the game.

Parameters

pSaveGame

◆ OnSavegameFileLoadedInMemory()

override void CryEngine.GameFramework.OnSavegameFileLoadedInMemory

(

string

pLevelName

)

inline

Called by the engine when the savegame file has loaded.

Parameters

pLevelName

◆ RegisterForRender()

static void CryEngine.GameFramework.RegisterForRender

(

IGameRenderReceiver

obj

)

inline

static

Registered object will be invoked on function OnRender if CryEngine's GameFramework raises OnPreRender.

◆ RegisterForUpdate()

static void CryEngine.GameFramework.RegisterForUpdate

(

IGameUpdateReceiver

obj

)

inline

static

Registered object will be invoked on function OnUpdate if CryEngine's GameFramework raises OnPostUpdate.

◆ UnregisterFromRender()

static void CryEngine.GameFramework.UnregisterFromRender

(

IGameRenderReceiver

obj

)

inline

static

Unregisters object from OnPreRender.

◆ UnregisterFromUpdate()

static void CryEngine.GameFramework.UnregisterFromUpdate

(

IGameUpdateReceiver

obj

)

inline

static

Unregisters object from OnPostUpdate.