HPL3/Amnesia: Rebirth/Scripting/iScrUserModule Interface

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

Fields

iScrUserModule_Interface has no public fields.

Functions

Return Type	Function And Description
void	AppGotInputFocus()
void	AppLostInputFocus()
void	CreateWorldEntities(cLuxMap@ apMap)
void	DestroyWorldEntities(cLuxMap@ apMap)
cLuxUserModule	GetBase()
void	LoadUserConfig()
void	OnAction(int alAction, bool abPressed)
void	OnAnalogInput(int alAnalogId, const cVector3f &in avAmount)
void	OnDraw(float afFrameTime)
void	OnEnterContainer(const tString &in asOldContainer)
void	OnExitPressed()
void	OnLeaveContainer(const tString &in asNewContainer)
void	OnMapEnter(cLuxMap@ apMap)
void	OnMapLeave(cLuxMap@ apMap)
void	OnPostRender(float afFrameTime)
void	PostUpdate(float afTimeStep)
void	PreloadData(cLuxMap@ apMap)
void	Reset()
void	SaveUserConfig()
void	Update(float afTimeStep)
void	VariableUpdate(float afDeltaTime)

Details

AppGotInputFocus

void AppGotInputFocus()

Returns:

• void

AppLostInputFocus

void AppLostInputFocus()

Returns:

• void

CreateWorldEntities

void CreateWorldEntities(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

DestroyWorldEntities

void DestroyWorldEntities(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

GetBase

cLuxUserModule@ GetBase()

Returns:

• cLuxUserModule@—

LoadUserConfig

void LoadUserConfig()

Returns:

• void

OnAction

void OnAction(int alAction,
              bool abPressed)

Parameters

• alAction (int) —
• abPressed (bool) —

Returns:

• void

OnAnalogInput

void OnAnalogInput(int alAnalogId,
                   const cVector3f &in avAmount)

Parameters

• alAnalogId (int) —
• avAmount (cVector3f) —

Returns:

• void

OnDraw

void OnDraw(float afFrameTime)

Parameters

• afFrameTime (float) —

Returns:

• void

OnEnterContainer

void OnEnterContainer(const tString &in asOldContainer)

Parameters

• asOldContainer (tString) —

Returns:

• void

OnExitPressed

void OnExitPressed()

Returns:

• void

OnLeaveContainer

void OnLeaveContainer(const tString &in asNewContainer)

Parameters

• asNewContainer (tString) —

Returns:

• void

OnMapEnter

void OnMapEnter(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

OnMapLeave

void OnMapLeave(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

OnPostRender

void OnPostRender(float afFrameTime)

Parameters

• afFrameTime (float) —

Returns:

• void

PostUpdate

void PostUpdate(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

PreloadData

void PreloadData(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

Reset

void Reset()

Returns:

• void

SaveUserConfig

void SaveUserConfig()

Returns:

• void

Update

void Update(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

VariableUpdate

void VariableUpdate(float afDeltaTime)

Parameters

• afDeltaTime (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...