HPL3/SOMA/Scripting/Scripting Api/cEngine

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type	Function and Description
void	cEngine_Exit()
float	cEngine_GetAvgFrameTimeInMS()
float	cEngine_GetAvgLogicFrameTimeMS()
float	cEngine_GetAvgRenderFrameTimeMS()
float	cEngine_GetAvgVariableFrameTimeMS()
float	cEngine_GetFPS()
void	cEngine_GetFPSMinMax(float &out afMin, float &out afMax)
float	cEngine_GetFPSUpdateRate()
float	cEngine_GetFrameTime()
void	cEngine_GetFrameTimeMinMax(float &out afMin, float &out afMax)
double	cEngine_GetGameTime()
bool	cEngine_GetLimitFPS()
float	cEngine_GetMaxMS()
float	cEngine_GetMinMS()
uint	cEngine_GetPerFrameUpdateSteps()
uint	cEngine_GetSceneRenderFlags()
float	cEngine_GetStepSize()
int	cEngine_GetUpdatesPerSec()
bool	cEngine_GetWaitIfAppOutOfFocus()
void	cEngine_ResetLogicTimer()
void	cEngine_SetAllGlobalUpdatersPaused(bool abPaused)
void	cEngine_SetAllUpdatersPaused(const tString &in asContainer, bool abPaused)
void	cEngine_SetFPSUpdateRate(float afSec)
void	cEngine_SetGlobalUpdaterPaused(const tString &in asUpdate, bool abPaused)
void	cEngine_SetLimitFPS(bool abX)
void	cEngine_SetSceneRenderFlags(uint alFlags)
void	cEngine_SetUpdaterPaused(const tString &in asContainer, const tString &in asUpdate, bool abPaused)
void	cEngine_SetUpdatesPerSec(int alUpdatesPerSec)
void	cEngine_SetWaitIfAppOutOfFocus(bool abX)

Function Detail

cEngine_Exit

void cEngine_Exit()

Returns:

• void

cEngine_GetAvgFrameTimeInMS

float cEngine_GetAvgFrameTimeInMS()

Returns:

• float—

cEngine_GetAvgLogicFrameTimeMS

float cEngine_GetAvgLogicFrameTimeMS()

Returns:

• float—

cEngine_GetAvgRenderFrameTimeMS

float cEngine_GetAvgRenderFrameTimeMS()

Returns:

• float—

cEngine_GetAvgVariableFrameTimeMS

float cEngine_GetAvgVariableFrameTimeMS()

Returns:

• float—

cEngine_GetFPS

float cEngine_GetFPS()

Returns:

• float—

cEngine_GetFPSMinMax

void cEngine_GetFPSMinMax(float &out afMin,
                          float &out afMax)

Parameters

• afMin (float) —
• afMax (float) —

Returns:

• void

cEngine_GetFPSUpdateRate

float cEngine_GetFPSUpdateRate()

Returns:

• float—

cEngine_GetFrameTime

float cEngine_GetFrameTime()

Returns:

• float—

cEngine_GetFrameTimeMinMax

void cEngine_GetFrameTimeMinMax(float &out afMin,
                                float &out afMax)

Parameters

• afMin (float) —
• afMax (float) —

Returns:

• void

cEngine_GetGameTime

double cEngine_GetGameTime()

Returns:

• double—

cEngine_GetLimitFPS

bool cEngine_GetLimitFPS()

Returns:

• bool—

cEngine_GetMaxMS

float cEngine_GetMaxMS()

Returns:

• float—

cEngine_GetMinMS

float cEngine_GetMinMS()

Returns:

• float—

cEngine_GetPerFrameUpdateSteps

uint cEngine_GetPerFrameUpdateSteps()

Returns:

• uint—

cEngine_GetSceneRenderFlags

uint cEngine_GetSceneRenderFlags()

Returns:

• uint—

cEngine_GetStepSize

float cEngine_GetStepSize()

Returns:

• float—

cEngine_GetUpdatesPerSec

int cEngine_GetUpdatesPerSec()

Returns:

• int—

cEngine_GetWaitIfAppOutOfFocus

bool cEngine_GetWaitIfAppOutOfFocus()

Returns:

• bool—

cEngine_ResetLogicTimer

void cEngine_ResetLogicTimer()

Returns:

• void

cEngine_SetAllGlobalUpdatersPaused

void cEngine_SetAllGlobalUpdatersPaused(bool abPaused)

Parameters

• abPaused (bool) —

Returns:

• void

cEngine_SetAllUpdatersPaused

void cEngine_SetAllUpdatersPaused(const tString &in asContainer,
                                  bool abPaused)

Parameters

• asContainer (tString) —
• abPaused (bool) —

Returns:

• void

cEngine_SetFPSUpdateRate

void cEngine_SetFPSUpdateRate(float afSec)

Parameters

• afSec (float) —

Returns:

• void

cEngine_SetGlobalUpdaterPaused

void cEngine_SetGlobalUpdaterPaused(const tString &in asUpdate,
                                    bool abPaused)

Parameters

• asUpdate (tString) —
• abPaused (bool) —

Returns:

• void

cEngine_SetLimitFPS

void cEngine_SetLimitFPS(bool abX)

Parameters

• abX (bool) —

Returns:

• void

cEngine_SetSceneRenderFlags

void cEngine_SetSceneRenderFlags(uint alFlags)

Parameters

• alFlags (uint) —

Returns:

• void

cEngine_SetUpdaterPaused

void cEngine_SetUpdaterPaused(const tString &in asContainer,
                              const tString &in asUpdate,
                              bool abPaused)

Parameters

• asContainer (tString) —
• asUpdate (tString) —
• abPaused (bool) —

Returns:

• void

cEngine_SetUpdatesPerSec

void cEngine_SetUpdatesPerSec(int alUpdatesPerSec)

Parameters

• alUpdatesPerSec (int) —

Returns:

• void

cEngine_SetWaitIfAppOutOfFocus

void cEngine_SetWaitIfAppOutOfFocus(bool abX)

Parameters

• abX (bool) —

Returns:

• void