HPL3/Amnesia: Rebirth/Scripting/cLuxPlayer

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

Fields

cLuxPlayer has no public fields.

Functions

Return Type	Function And Description
void	AddCollideCallback(iLuxEntity@ apEntity, const tString &in asCallbackFunc, bool abAddedFromScript = true)
void	AddHealth(float afX, float afMinHealth)
void	AddMoveState(const tString &in asName, int alId, const tString &in asScriptFile, const tString &in asScriptClass)
void	AddState(const tString &in asName, int alId, const tString &in asScriptFile, const tString &in asScriptClass)
void	AddUsedLiquidArea(cLuxLiquidArea@ apArea)
void	AutomoveCharBodyTo(float afAcc, float afSpeedMul, float afMaxSpeed, const cVector3f &in avPosition)
void	ChangeMoveState(int alId)
void	ChangeState(int alId)
bool	CheckBodyCollision(iPhysicsBody@ apBody, cLuxMap@ apMap)
bool	CheckCharacterCollision(iCharacterBody@ apBody, cLuxMap@ apMap)
bool	CheckEntityCollision(iLuxEntity@ apEntity)
void	DisableCameraLock()
void	EnableCameraLock(float afLocalYawMin, float afLocalYawMax, float afLocalPitchMin, float afLocalPitchMax)
void	FadeCameraAspectMulTo(float afX, float afSpeed)
void	FadeCameraFOVMulTo(int alId, float afX, float afSpeed)
void	FadeCameraFOVTo(float afTargetFOV, float afSpeed)
void	FadeCameraRollTo(int alId, float afX, float afSpeedMul, float afMaxSpeed)
float	GetAutoMoveTargetDistance()
cVector3f	GetAverageMoveDirection()
float	GetAverageMoveSpeed()
cVector3f	GetBaseCameraPosAdd()
cCamera	GetCamera()
iCollideShape	GetCameraCollideShape()
float	GetCameraFOVMul(int alId)
float	GetCameraFOVMul()
cVector3f	GetCameraPosAdd(int alType)
cVector3f	GetCameraPosAddGoal(int alType)
cVector3f	GetCameraPosAddSum()
float	GetCameraRoll(int alId)
cVector2f	GetCameraTrackingAvgMovement()
bool	GetCanDie()
iCharacterBody	GetCharacterBody()
cLuxMoveState	GetCurrentMoveState()
int	GetCurrentMoveStateId()
tString	GetCurrentMoveStateName()
int	GetCurrentStateId()
tString	GetCurrentStateName()
tID	GetDamageSourceID()
float	GetDefaultFOV()
float	GetHealth()
bool	GetIsLiquidAreaUsed(cLuxLiquidArea@ apArea)
float	GetLiquidHeight()
float	GetMaxHealth()
float	GetRotateCameraTargetDistance()
float	GetSmoothingPosAmount()
float	GetSmoothingRotAmount()
float	GetTimeSincePhysicsObjectInteraction()
tID	GetUsedLiquidAreaID(int alId)
int	GetUsedLiquidAreaNum()
float	GetVisibilityMaxRange()
float	GetVisibilityRangeMul()
bool	GiveDamage(float afAmount, int alStrength, int aType, float afMinHealth, tID a_idSource, int alDamageID)
bool	HasCollideCallbacks()
bool	IsActive()
bool	IsAutomoveCharBodyActive()
bool	IsCameraRotateActive()
bool	IsDamaged()
bool	IsDead()
bool	IsInLiquid()
void	MoveCameraPosAdd(int alType, const cVector3f &in avGoal, float afAcc, float afSpeed, float afSlowdownDist)
void	RemoveCollideCallback(const tString &in asEntityName)
void	RemoveUsedLiquidArea(cLuxLiquidArea@ apArea)
void	ResetBasicProperties()
void	ResetTimeSincePhysicsObjectInteraction()
void	RotateCameraTowards(float afAcc, float afSpeedMul, float afMaxSpeed, const cVector3f &in avLookAtPos, bool abLocalCoord)
void	RotateCameraTowards(float afAcc, float afSpeedMul, float afMaxSpeed, tID a_idTarget, bool abLocalCoord)
void	SetActive(bool abX)
void	SetAutomoveCharBodyTarget(const cVector3f &in avPosition)
void	SetBaseCameraPosAdd(const cVector3f &in avVec)
void	SetCameraFOVMul(int alId, float afFOVMul)
void	SetCameraPosAdd(int alType, const cVector3f &in avVector)
void	SetCameraRoll(int alId, float afX)
bool	SetCanDie(bool abX)
void	SetCharacterBody(iCharacterBody@ apBody)
void	SetCollideCallbacksActive(bool abX)
void	SetHealth(float afX)
void	SetMaxCameraTrackingAmount(int alSize)
void	SetMaxHealth(float afX)
void	SetRotateCameraTarget(const cVector3f &in avLookAtPos, bool abLocalCoord)
void	SetRotateCameraTarget(tID a_idTarget, bool abLocalCoord)
void	SetSmoothingPosAmount(float afX)
void	SetSmoothingRotAmount(float afX)
void	SetVisibilityMaxRange(int alId, float afX)
void	SetVisibilityRangeMul(int alId, float afX)
void	StopAutomoveCharBody()
void	StopCameraRotate(float afDeacc)

Details

AddCollideCallback

void AddCollideCallback(iLuxEntity@ apEntity,
                        const tString &in asCallbackFunc,
                        bool abAddedFromScript = true)

Parameters

• apEntity (iLuxEntity@) —
• asCallbackFunc (tString) —
• abAddedFromScript (bool) —

Returns:

• void

AddHealth

void AddHealth(float afX,
               float afMinHealth)

Parameters

• afX (float) —
• afMinHealth (float) —

Returns:

• void

AddMoveState

void AddMoveState(const tString &in asName,
                  int alId,
                  const tString &in asScriptFile,
                  const tString &in asScriptClass)

Parameters

• asName (tString) —
• alId (int) —
• asScriptFile (tString) —
• asScriptClass (tString) —

Returns:

• void

AddState

void AddState(const tString &in asName,
              int alId,
              const tString &in asScriptFile,
              const tString &in asScriptClass)

Parameters

• asName (tString) —
• alId (int) —
• asScriptFile (tString) —
• asScriptClass (tString) —

Returns:

• void

AddUsedLiquidArea

void AddUsedLiquidArea(cLuxLiquidArea@ apArea)

Parameters

• apArea (cLuxLiquidArea@) —

Returns:

• void

AutomoveCharBodyTo

void AutomoveCharBodyTo(float afAcc,
                        float afSpeedMul,
                        float afMaxSpeed,
                        const cVector3f &in avPosition)

Parameters

• afAcc (float) —
• afSpeedMul (float) —
• afMaxSpeed (float) —
• avPosition (cVector3f) —

Returns:

• void

ChangeMoveState

void ChangeMoveState(int alId)

Parameters

• alId (int) —

Returns:

• void

ChangeState

void ChangeState(int alId)

Parameters

• alId (int) —

Returns:

• void

CheckBodyCollision

bool CheckBodyCollision(iPhysicsBody@ apBody,
                        cLuxMap@ apMap)

Parameters

• apBody (iPhysicsBody@) —
• apMap (cLuxMap@) —

Returns:

• bool—

CheckCharacterCollision

bool CheckCharacterCollision(iCharacterBody@ apBody,
                             cLuxMap@ apMap)

Parameters

• apBody (iCharacterBody@) —
• apMap (cLuxMap@) —

Returns:

• bool—

CheckEntityCollision

bool CheckEntityCollision(iLuxEntity@ apEntity)

Parameters

• apEntity (iLuxEntity@) —

Returns:

• bool—

DisableCameraLock

void DisableCameraLock()

Returns:

• void

EnableCameraLock

void EnableCameraLock(float afLocalYawMin,
                      float afLocalYawMax,
                      float afLocalPitchMin,
                      float afLocalPitchMax)

Parameters

• afLocalYawMin (float) —
• afLocalYawMax (float) —
• afLocalPitchMin (float) —
• afLocalPitchMax (float) —

Returns:

• void

FadeCameraAspectMulTo

void FadeCameraAspectMulTo(float afX,
                           float afSpeed)

Parameters

• afX (float) —
• afSpeed (float) —

Returns:

• void

FadeCameraFOVMulTo

void FadeCameraFOVMulTo(int alId,
                        float afX,
                        float afSpeed)

Parameters

• alId (int) —
• afX (float) —
• afSpeed (float) —

Returns:

• void

FadeCameraFOVTo

void FadeCameraFOVTo(float afTargetFOV,
                     float afSpeed)

Parameters

• afTargetFOV (float) —
• afSpeed (float) —

Returns:

• void

FadeCameraRollTo

void FadeCameraRollTo(int alId,
                      float afX,
                      float afSpeedMul,
                      float afMaxSpeed)

Parameters

• alId (int) —
• afX (float) —
• afSpeedMul (float) —
• afMaxSpeed (float) —

Returns:

• void

GetAutoMoveTargetDistance

float GetAutoMoveTargetDistance()

Returns:

• float—

GetAverageMoveDirection

const cVector3f& GetAverageMoveDirection()

Returns:

• const cVector3f&—

GetAverageMoveSpeed

float GetAverageMoveSpeed()

Returns:

• float—

GetBaseCameraPosAdd

const cVector3f& GetBaseCameraPosAdd()

Returns:

• const cVector3f&—

GetCamera

cCamera@ GetCamera()

Returns:

• cCamera@—

GetCameraCollideShape

iCollideShape@ GetCameraCollideShape()

Returns:

• iCollideShape@—

GetCameraFOVMul

float GetCameraFOVMul(int alId)

Parameters

• alId (int) —

Returns:

• float—

GetCameraFOVMul

float GetCameraFOVMul()

Returns:

• float—

GetCameraPosAdd

const cVector3f& GetCameraPosAdd(int alType)

Parameters

• alType (int) —

Returns:

• const cVector3f&—

GetCameraPosAddGoal

const cVector3f& GetCameraPosAddGoal(int alType)

Parameters

• alType (int) —

Returns:

• const cVector3f&—

GetCameraPosAddSum

const cVector3f& GetCameraPosAddSum()

Returns:

• const cVector3f&—

GetCameraRoll

float GetCameraRoll(int alId)

Parameters

• alId (int) —

Returns:

• float—

GetCameraTrackingAvgMovement

const cVector2f& GetCameraTrackingAvgMovement()

Returns:

• const cVector2f&—

GetCanDie

bool GetCanDie()

Returns:

• bool—

GetCharacterBody

iCharacterBody@ GetCharacterBody()

Returns:

• iCharacterBody@—

GetCurrentMoveState

cLuxMoveState@ GetCurrentMoveState()

Returns:

• cLuxMoveState@—

GetCurrentMoveStateId

int GetCurrentMoveStateId()

Returns:

• int—

GetCurrentMoveStateName

const tString& GetCurrentMoveStateName()

Returns:

• const tString&—

GetCurrentStateId

int GetCurrentStateId()

Returns:

• int—

GetCurrentStateName

const tString& GetCurrentStateName()

Returns:

• const tString&—

GetDamageSourceID

tID GetDamageSourceID()

Returns:

• tID—

GetDefaultFOV

float GetDefaultFOV()

Returns:

• float—

GetHealth

float GetHealth()

Returns:

• float—

GetIsLiquidAreaUsed

bool GetIsLiquidAreaUsed(cLuxLiquidArea@ apArea)

Parameters

• apArea (cLuxLiquidArea@) —

Returns:

• bool—

GetLiquidHeight

float GetLiquidHeight()

Returns:

• float—

GetMaxHealth

float GetMaxHealth()

Returns:

• float—

GetRotateCameraTargetDistance

float GetRotateCameraTargetDistance()

Returns:

• float—

GetSmoothingPosAmount

float GetSmoothingPosAmount()

Returns:

• float—

GetSmoothingRotAmount

float GetSmoothingRotAmount()

Returns:

• float—

GetTimeSincePhysicsObjectInteraction

float GetTimeSincePhysicsObjectInteraction()

Returns:

• float—

GetUsedLiquidAreaID

tID GetUsedLiquidAreaID(int alId)

Parameters

• alId (int) —

Returns:

• tID—

GetUsedLiquidAreaNum

int GetUsedLiquidAreaNum()

Returns:

• int—

GetVisibilityMaxRange

float GetVisibilityMaxRange()

Returns:

• float—

GetVisibilityRangeMul

float GetVisibilityRangeMul()

Returns:

• float—

GiveDamage

bool GiveDamage(float afAmount,
                int alStrength,
                int aType,
                float afMinHealth,
                tID a_idSource,
                int alDamageID)

Parameters

• afAmount (float) —
• alStrength (int) —
• aType (int) —
• afMinHealth (float) —
• a_idSource (tID) —
• alDamageID (int) —

Returns:

• bool—

HasCollideCallbacks

bool HasCollideCallbacks()

Returns:

• bool—

IsActive

bool IsActive()

Returns:

• bool—

IsAutomoveCharBodyActive

bool IsAutomoveCharBodyActive()

Returns:

• bool—

IsCameraRotateActive

bool IsCameraRotateActive()

Returns:

• bool—

IsDamaged

bool IsDamaged()

Returns:

• bool—

IsDead

bool IsDead()

Returns:

• bool—

IsInLiquid

bool IsInLiquid()

Returns:

• bool—

MoveCameraPosAdd

void MoveCameraPosAdd(int alType,
                      const cVector3f &in avGoal,
                      float afAcc,
                      float afSpeed,
                      float afSlowdownDist)

Parameters

• alType (int) —
• avGoal (cVector3f) —
• afAcc (float) —
• afSpeed (float) —
• afSlowdownDist (float) —

Returns:

• void

RemoveCollideCallback

void RemoveCollideCallback(const tString &in asEntityName)

Parameters

• asEntityName (tString) —

Returns:

• void

RemoveUsedLiquidArea

void RemoveUsedLiquidArea(cLuxLiquidArea@ apArea)

Parameters

• apArea (cLuxLiquidArea@) —

Returns:

• void

ResetBasicProperties

void ResetBasicProperties()

Returns:

• void

ResetTimeSincePhysicsObjectInteraction

void ResetTimeSincePhysicsObjectInteraction()

Returns:

• void

RotateCameraTowards

void RotateCameraTowards(float afAcc,
                         float afSpeedMul,
                         float afMaxSpeed,
                         const cVector3f &in avLookAtPos,
                         bool abLocalCoord)

Parameters

• afAcc (float) —
• afSpeedMul (float) —
• afMaxSpeed (float) —
• avLookAtPos (cVector3f) —
• abLocalCoord (bool) —

Returns:

• void

RotateCameraTowards

void RotateCameraTowards(float afAcc,
                         float afSpeedMul,
                         float afMaxSpeed,
                         tID a_idTarget,
                         bool abLocalCoord)

Parameters

• afAcc (float) —
• afSpeedMul (float) —
• afMaxSpeed (float) —
• a_idTarget (tID) —
• abLocalCoord (bool) —

Returns:

• void

SetActive

void SetActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetAutomoveCharBodyTarget

void SetAutomoveCharBodyTarget(const cVector3f &in avPosition)

Parameters

• avPosition (cVector3f) —

Returns:

• void

SetBaseCameraPosAdd

void SetBaseCameraPosAdd(const cVector3f &in avVec)

Parameters

• avVec (cVector3f) —

Returns:

• void

SetCameraFOVMul

void SetCameraFOVMul(int alId,
                     float afFOVMul)

Parameters

• alId (int) —
• afFOVMul (float) —

Returns:

• void

SetCameraPosAdd

void SetCameraPosAdd(int alType,
                     const cVector3f &in avVector)

Parameters

• alType (int) —
• avVector (cVector3f) —

Returns:

• void

SetCameraRoll

void SetCameraRoll(int alId,
                   float afX)

Parameters

• alId (int) —
• afX (float) —

Returns:

• void

SetCanDie

bool SetCanDie(bool abX)

Parameters

• abX (bool) —

Returns:

• bool—

SetCharacterBody

void SetCharacterBody(iCharacterBody@ apBody)

Parameters

• apBody (iCharacterBody@) —

Returns:

• void

SetCollideCallbacksActive

void SetCollideCallbacksActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetHealth

void SetHealth(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMaxCameraTrackingAmount

void SetMaxCameraTrackingAmount(int alSize)

Parameters

• alSize (int) —

Returns:

• void

SetMaxHealth

void SetMaxHealth(float afX)

Parameters

• afX (float) —

Returns:

• void

SetRotateCameraTarget

void SetRotateCameraTarget(const cVector3f &in avLookAtPos,
                           bool abLocalCoord)

Parameters

• avLookAtPos (cVector3f) —
• abLocalCoord (bool) —

Returns:

• void

SetRotateCameraTarget

void SetRotateCameraTarget(tID a_idTarget,
                           bool abLocalCoord)

Parameters

• a_idTarget (tID) —
• abLocalCoord (bool) —

Returns:

• void

SetSmoothingPosAmount

void SetSmoothingPosAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetSmoothingRotAmount

void SetSmoothingRotAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetVisibilityMaxRange

void SetVisibilityMaxRange(int alId,
                           float afX)

Parameters

• alId (int) —
• afX (float) —

Returns:

• void

SetVisibilityRangeMul

void SetVisibilityRangeMul(int alId,
                           float afX)

Parameters

• alId (int) —
• afX (float) —

Returns:

• void

StopAutomoveCharBody

void StopAutomoveCharBody()

Returns:

• void

StopCameraRotate

void StopCameraRotate(float afDeacc)

Parameters

• afDeacc (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxMoveState ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxPlayerState ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iScrPlayer Interface ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)

See all references...