HPL3/Amnesia: Rebirth/Scripting/cLuxCharMover

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

Fields

cLuxCharMover has no public fields.

Functions

Return Type	Function And Description
void	AddSpeedState(int alId)
float	CalculateSpeedMul(float afTimeStep)
iCharacterBody	GetCharBody()
iLuxEntity	GetEntity()
bool	GetIdleExtraAnimActive()
float	GetMaxStuckCounter()
float	GetMoveSpeed()
float	GetSpeedMul()
int	GetSpeedState()
float	GetStuckCounter()
int	GetType()
bool	GetUseMoveStateAnimations()
float	GetWantedSpeedAmount()
void	LoadFromVariables(cResourceVarsObject@ apVars)
void	MoveToPos(const cVector3f &in avFeetPos, bool abSlowDownAndStopAtGoal = false)
int	PlayAnimation(const tString &in asName, float afFadeTime = 0.3f, bool abLoop = false, bool abPlayTransition = true, const tString &in asCallback = "")
int	PlayTrackAnimation(cLuxTrackNode@ apNode)
void	ResetStuckCounter()
void	SetBackwardAnimName(const tString &in asName)
void	SetBankingActive(bool abX)
void	SetBankingAngleMul(float afX)
void	SetBankingMaxAngle(float afX)
void	SetBankingMaxSpeed(float afX)
void	SetBankingSpeedMul(float afX)
void	SetDirection(eLuxCharMoveDirection aDir)
void	SetDynamicObjectAvoidanceActive(bool abX)
void	SetDynamicObjectPlayerAvoidanceActive(bool abX)
void	SetIdleAnimName(const tString &in asName)
void	SetIdleExtraAnimActive(bool abX)
void	SetIdleExtraAnimName(const tString &in asName)
void	SetMaxBackwardSpeed(float afX)
void	SetMaxForwardSpeed(float afX)
void	SetMoveSpeedAnimMul(float afX)
void	SetRunAnimName(const tString &in asName)
void	SetRunToWalkSpeed(float afX)
void	SetSpeedMul(float afX)
void	SetSpeedState(int alId)
void	SetSpeedState_Backward(float afX)
void	SetSpeedState_Forward(float afX)
void	SetSpeedState_ForwardAcc(float afX)
void	SetSpeedState_ForwardDeacc(float afX)
void	SetSpeedState_SidewayAcc(float afX)
void	SetSpeedState_SidewayDeacc(float afX)
void	SetSpeedState_Sideways(float afX)
void	SetSpeedState_TurnBreakMul(float afX)
void	SetSpeedState_TurnMaxSpeed(float afX)
void	SetSpeedState_TurnSpeedMul(float afX)
void	SetStoppedToWalkSpeed(float afX)
void	SetTurnBreakMul(float afX)
void	SetTurnedToGoalCallbackFunc(const tString &in asFunc)
void	SetTurnMaxSpeed(float afX)
void	SetTurnMinBreakAngle(float afX)
void	SetTurnSpeedMul(float afX)
void	SetTurnStoppedToWalkSpeed(float afX)
void	SetTurnWalkToStoppedSpeed(float afX)
void	SetupDynamicObjectAvoidance(float afMaxDistance, float afMinMass, float afSteerAmount)
void	SetupDynamicObjectPlayerAvoidance(float afMaxDistance, float afSteerAmount)
void	SetupIdleExtra(const tString &in asAnimName, float afMinWait, float afMaxWait, bool abPauseProceduralAnims)
void	SetupWallAvoidance(float afRadius, float afSteerAmount, int alSamples)
void	SetUse3DMovement(bool abX)
void	SetUseMoveStateAnimations(bool abX)
void	SetVerticalMoveSpeedExtraAnimMul(float afX)
void	SetWalkAnimName(const tString &in asName)
void	SetWalkToRunSpeed(float afX)
void	SetWalkToStoppedSpeed(float afX)
void	SetWallAvoidanceActive(bool abX)
void	StopTurning()
void	TurnInstantlyToAngle(float afAngle)
void	TurnInstantlyToAngle(float afYaw, float afPitch)
void	TurnInstantlyToPos(const cVector3f &in avGoalPos)
void	TurnToAngle(float afAngle)
void	TurnToAngles(float afYaw, float afPitch)
void	TurnToPos(const cVector3f &in avFeetPos)

Details

AddSpeedState

void AddSpeedState(int alId)

Parameters

• alId (int) —

Returns:

• void

CalculateSpeedMul

float CalculateSpeedMul(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• float—

GetCharBody

iCharacterBody@ GetCharBody()

Returns:

• iCharacterBody@—

GetEntity

iLuxEntity@ GetEntity()

Returns:

• iLuxEntity@—

GetIdleExtraAnimActive

bool GetIdleExtraAnimActive()

Returns:

• bool—

GetMaxStuckCounter

float GetMaxStuckCounter()

Returns:

• float—

GetMoveSpeed

float GetMoveSpeed()

Returns:

• float—

GetSpeedMul

float GetSpeedMul()

Returns:

• float—

GetSpeedState

int GetSpeedState()

Returns:

• int—

GetStuckCounter

float GetStuckCounter()

Returns:

• float—

GetType

int GetType()

Returns:

• int—

GetUseMoveStateAnimations

bool GetUseMoveStateAnimations()

Returns:

• bool—

GetWantedSpeedAmount

float GetWantedSpeedAmount()

Returns:

• float—

LoadFromVariables

void LoadFromVariables(cResourceVarsObject@ apVars)

Parameters

• apVars (cResourceVarsObject@) —

Returns:

• void

MoveToPos

void MoveToPos(const cVector3f &in avFeetPos,
               bool abSlowDownAndStopAtGoal = false)

Parameters

• avFeetPos (cVector3f) —
• abSlowDownAndStopAtGoal (bool) —

Returns:

• void

PlayAnimation

int PlayAnimation(const tString &in asName,
                  float afFadeTime = 0.3f,
                  bool abLoop = false,
                  bool abPlayTransition = true,
                  const tString &in asCallback = "")

Parameters

• asName (tString) —
• afFadeTime (float) —
• abLoop (bool) —
• abPlayTransition (bool) —
• asCallback (tString) —

Returns:

• int—

PlayTrackAnimation

int PlayTrackAnimation(cLuxTrackNode@ apNode)

Parameters

• apNode (cLuxTrackNode@) —

Returns:

• int—

ResetStuckCounter

void ResetStuckCounter()

Returns:

• void

SetBackwardAnimName

void SetBackwardAnimName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetBankingActive

void SetBankingActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetBankingAngleMul

void SetBankingAngleMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBankingMaxAngle

void SetBankingMaxAngle(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBankingMaxSpeed

void SetBankingMaxSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetBankingSpeedMul

void SetBankingSpeedMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetDirection

void SetDirection(eLuxCharMoveDirection aDir)

Parameters

• aDir (eLuxCharMoveDirection) —

Returns:

• void

SetDynamicObjectAvoidanceActive

void SetDynamicObjectAvoidanceActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetDynamicObjectPlayerAvoidanceActive

void SetDynamicObjectPlayerAvoidanceActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetIdleAnimName

void SetIdleAnimName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetIdleExtraAnimActive

void SetIdleExtraAnimActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetIdleExtraAnimName

void SetIdleExtraAnimName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetMaxBackwardSpeed

void SetMaxBackwardSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMaxForwardSpeed

void SetMaxForwardSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMoveSpeedAnimMul

void SetMoveSpeedAnimMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetRunAnimName

void SetRunAnimName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetRunToWalkSpeed

void SetRunToWalkSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedMul

void SetSpeedMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState

void SetSpeedState(int alId)

Parameters

• alId (int) —

Returns:

• void

SetSpeedState_Backward

void SetSpeedState_Backward(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_Forward

void SetSpeedState_Forward(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_ForwardAcc

void SetSpeedState_ForwardAcc(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_ForwardDeacc

void SetSpeedState_ForwardDeacc(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_SidewayAcc

void SetSpeedState_SidewayAcc(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_SidewayDeacc

void SetSpeedState_SidewayDeacc(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_Sideways

void SetSpeedState_Sideways(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_TurnBreakMul

void SetSpeedState_TurnBreakMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_TurnMaxSpeed

void SetSpeedState_TurnMaxSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSpeedState_TurnSpeedMul

void SetSpeedState_TurnSpeedMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetStoppedToWalkSpeed

void SetStoppedToWalkSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetTurnBreakMul

void SetTurnBreakMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetTurnedToGoalCallbackFunc

void SetTurnedToGoalCallbackFunc(const tString &in asFunc)

Parameters

• asFunc (tString) —

Returns:

• void

SetTurnMaxSpeed

void SetTurnMaxSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetTurnMinBreakAngle

void SetTurnMinBreakAngle(float afX)

Parameters

• afX (float) —

Returns:

• void

SetTurnSpeedMul

void SetTurnSpeedMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetTurnStoppedToWalkSpeed

void SetTurnStoppedToWalkSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetTurnWalkToStoppedSpeed

void SetTurnWalkToStoppedSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetupDynamicObjectAvoidance

void SetupDynamicObjectAvoidance(float afMaxDistance,
                                 float afMinMass,
                                 float afSteerAmount)

Parameters

• afMaxDistance (float) —
• afMinMass (float) —
• afSteerAmount (float) —

Returns:

• void

SetupDynamicObjectPlayerAvoidance

void SetupDynamicObjectPlayerAvoidance(float afMaxDistance,
                                       float afSteerAmount)

Parameters

• afMaxDistance (float) —
• afSteerAmount (float) —

Returns:

• void

SetupIdleExtra

void SetupIdleExtra(const tString &in asAnimName,
                    float afMinWait,
                    float afMaxWait,
                    bool abPauseProceduralAnims)

Parameters

• asAnimName (tString) —
• afMinWait (float) —
• afMaxWait (float) —
• abPauseProceduralAnims (bool) —

Returns:

• void

SetupWallAvoidance

void SetupWallAvoidance(float afRadius,
                        float afSteerAmount,
                        int alSamples)

Parameters

• afRadius (float) —
• afSteerAmount (float) —
• alSamples (int) —

Returns:

• void

SetUse3DMovement

void SetUse3DMovement(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetUseMoveStateAnimations

void SetUseMoveStateAnimations(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetVerticalMoveSpeedExtraAnimMul

void SetVerticalMoveSpeedExtraAnimMul(float afX)

Parameters

• afX (float) —

Returns:

• void

SetWalkAnimName

void SetWalkAnimName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetWalkToRunSpeed

void SetWalkToRunSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetWalkToStoppedSpeed

void SetWalkToStoppedSpeed(float afX)

Parameters

• afX (float) —

Returns:

• void

SetWallAvoidanceActive

void SetWallAvoidanceActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

StopTurning

void StopTurning()

Returns:

• void

TurnInstantlyToAngle

void TurnInstantlyToAngle(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

TurnInstantlyToAngle

void TurnInstantlyToAngle(float afYaw,
                          float afPitch)

Parameters

• afYaw (float) —
• afPitch (float) —

Returns:

• void

TurnInstantlyToPos

void TurnInstantlyToPos(const cVector3f &in avGoalPos)

Parameters

• avGoalPos (cVector3f) —

Returns:

• void

TurnToAngle

void TurnToAngle(float afAngle)

Parameters

• afAngle (float) —

Returns:

• void

TurnToAngles

void TurnToAngles(float afYaw,
                  float afPitch)

Parameters

• afYaw (float) —
• afPitch (float) —

Returns:

• void

TurnToPos

void TurnToPos(const cVector3f &in avFeetPos)

Parameters

• avFeetPos (cVector3f) —

Returns:

• void

References

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

See all references...