HPL3/Amnesia: Rebirth/Scripting/iScrPlayer Interface

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

Fields

iScrPlayer_Interface has no public fields.

Functions

Return Type	Function And Description
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)
cLuxPlayer	GetBase()
int	GetCharacterState()
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	OnUnderwaterEffectActive(bool abX, bool abUseStartAndEndEffects)
void	PostUpdate(float afTimeStep)
void	PreloadData(cLuxMap@ apMap)
void	Reset()
void	SaveUserConfig()
void	SetCharacterState(int alState)
void	SetupStartPos(const cVector3f &in avPos, float afAngle, bool abCrouching)
void	Update(float afTimeStep)

Details

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

cLuxPlayer@ GetBase()

Returns:

• cLuxPlayer@—

GetCharacterState

int GetCharacterState()

Returns:

• int—

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

OnUnderwaterEffectActive

void OnUnderwaterEffectActive(bool abX,
                              bool abUseStartAndEndEffects)

Parameters

• abX (bool) —
• abUseStartAndEndEffects (bool) —

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

SetCharacterState

void SetCharacterState(int alState)

Parameters

• alState (int) —

Returns:

• void

SetupStartPos

void SetupStartPos(const cVector3f &in avPos,
                   float afAngle,
                   bool abCrouching)

Parameters

• avPos (cVector3f) —
• afAngle (float) —
• abCrouching (bool) —

Returns:

• void

Update

void Update(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

References

See all references...