HPL3/Amnesia: Rebirth/Scripting/iScrPlayerState Interface

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

Fields

iScrPlayerState_Interface has no public fields.

Functions

Return Type	Function And Description
bool	AllowBuoyancy(iPhysicsBody@ apBody)
void	CharBody_GravityCollide(iCharacterBody@ apCharBody, iPhysicsBody@ apBody, cCollideData@ apCollideData)
void	CharBody_HitGround(iCharacterBody@ apCharBody, const cVector3f &in avVel)
void	CreateWorldEntities(cLuxMap@ apMap)
void	DestroyWorldEntities(cLuxMap@ apMap)
float	DrawDebugOutput(cGuiSet@ apSet, iFontData@ apFont, float afStartY)
cLuxPlayerState	GetBase()
void	LoadUserConfig()
bool	OnAction(int alAction, bool abPressed)
bool	OnAnalogInput(int alAnalogId, const cVector3f &in avAmount)
void	OnEnterState(int alPrevStateId)
bool	OnExitPressed()
void	OnLeaveState(int alNextStateId)
void	OnMapEnter(cLuxMap@ apMap)
void	OnMapLeave(cLuxMap@ apMap)
void	PostUpdate(float afTimeStep)
void	Reset()
void	SaveUserConfig()
void	Update(float afTimeStep)

Details

AllowBuoyancy

bool AllowBuoyancy(iPhysicsBody@ apBody)

Parameters

• apBody (iPhysicsBody@) —

Returns:

• bool—

CharBody_GravityCollide

void CharBody_GravityCollide(iCharacterBody@ apCharBody,
                             iPhysicsBody@ apBody,
                             cCollideData@ apCollideData)

Parameters

• apCharBody (iCharacterBody@) —
• apBody (iPhysicsBody@) —
• apCollideData (cCollideData@) —

Returns:

• void

CharBody_HitGround

void CharBody_HitGround(iCharacterBody@ apCharBody,
                        const cVector3f &in avVel)

Parameters

• apCharBody (iCharacterBody@) —
• avVel (cVector3f) —

Returns:

• void

CreateWorldEntities

void CreateWorldEntities(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

DestroyWorldEntities

void DestroyWorldEntities(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

DrawDebugOutput

float DrawDebugOutput(cGuiSet@ apSet,
                      iFontData@ apFont,
                      float afStartY)

Parameters

• apSet (cGuiSet@) —
• apFont (iFontData@) —
• afStartY (float) —

Returns:

• float—

GetBase

cLuxPlayerState@ GetBase()

Returns:

• cLuxPlayerState@—

LoadUserConfig

void LoadUserConfig()

Returns:

• void

OnAction

bool OnAction(int alAction,
              bool abPressed)

Parameters

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

Returns:

• bool—

OnAnalogInput

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

Parameters

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

Returns:

• bool—

OnEnterState

void OnEnterState(int alPrevStateId)

Parameters

• alPrevStateId (int) —

Returns:

• void

OnExitPressed

bool OnExitPressed()

Returns:

• bool—

OnLeaveState

void OnLeaveState(int alNextStateId)

Parameters

• alNextStateId (int) —

Returns:

• void

OnMapEnter

void OnMapEnter(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

OnMapLeave

void OnMapLeave(cLuxMap@ apMap)

Parameters

• apMap (cLuxMap@) —

Returns:

• void

PostUpdate

void PostUpdate(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

Reset

void Reset()

Returns:

• void

SaveUserConfig

void SaveUserConfig()

Returns:

• void

Update

void Update(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

References

See all references...