HPL3/Amnesia: Rebirth/Scripting/cLuxVisibilityPortal

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Fields

cLuxVisibilityPortal has no public fields.

Functions

Return Type	Function And Description
void	AddCollideCallback(iLuxEntity@ apEntity, const tString &in asCallbackFunc, bool abAddedFromScript = true)
void	AddConnection(const tString &in asName, iLuxEntity@ apEntity, bool abInvertStateSent, int alStatesUsed)
void	AppendAnimation(const tString &in asName, bool abLoop)
void	AttachToEntity(iLuxEntity@ apEntity, iPhysicsBody@ apTargetBody, bool abUseRotation, bool abSnapToParent, bool abLocked = false)
void	AttachToSocket(iLuxEntity@ apEntity, const tString &in asSocket, bool abUseRotation, bool abSnapToParent, bool abLocked = false)
void	BroadcastMessage(int alMessageId, iLuxEntityComponent@ apSource, const cVector3f &in avData, int alData)
cVector3f	CalculateRootMotion()
bool	CanInteract(int alType, iPhysicsBody@ apBody)
void	ChangeConnectionState(int alState)
bool	CheckBodyCollision(iPhysicsBody@ apBody, cLuxMap@ apMap)
bool	CheckCharacterCollision(iCharacterBody@ apBody, cLuxMap@ apMap)
bool	CheckEntityCollision(iLuxEntity@ apEntity)
bool	CheckIsOnScreen(bool abUseRayCast)
bool	CheckShapeCollision(iCollideShape@ apShape, const cMatrixf &in a_mtxTransform, cLuxMap@ apMap)
bool	CollidesWithPlayer()
cParticleSystem	CreateParticleSystem(const tString &in asName, const tString &in asFile, bool abRemoveWhenDone, bool abAttach)
cParticleSystem	CreateParticleSystemOnBone(const tString &in asName, const tString &in asFile, const tString &in asBoneName, bool abRemoveWhenDone, bool abAttach)
void	DrawProjDebugText(const tString &in asText, float afFontSize = 16.0f, bool abProjectSize = false, eFontAlign aAlignment = eFontAlign_Left, const cColor &in aColor = cColor, ../ 1, ../ 1, const cVector3f &in avOffset = cVector3f, ../ 0, float afMaxDistance = 20)
void	FadeEffectBaseColor(const cColor &in aDestColor, float afTime)
void	FadeMeshScaleMul(const cVector3f &in avDestScale, float afTime, eEasing aEasing = eEasing_Linear)
void	Fader_ClearAll()
void	Fader_FadeTo(uint alID, float afGoal, float afTime, bool abReverseAtEnd = false, bool abSkipIfExists = false)
void	Fader_FadeTo(const tString &in asName, float afGoal, float afTime, bool abReverseAtEnd = false, bool abSkipIfExists = false)
float	Fader_GetValue(uint alID, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
float	Fader_GetValue(const tString &in asName, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
void	Fader_Set(uint alID, float afX, bool abSkipIfExists = false)
void	Fader_Set(const tString &in asName, float afX, bool abSkipIfExists = false)
void	Fader_SetPaused(uint alID, bool abPaused)
void	Fader_SetPaused(const tString &in asName, bool abPaused)
bool	GetAnimationIsPlaying()
iPhysicsBody	GetAreaBody()
iEntity3D	GetAttachEntity()
bool	GetAutoSleep()
cMaterial	GetBaseMaterial()
cMatrixf	GetBaseMatrix()
cVector3f	GetBasePosition()
cBillboard	GetBillboardFromName(const tString &in asName)
iPhysicsBody	GetBody(int alIdx)
iPhysicsBody	GetBodyFromID(int alID)
iPhysicsBody	GetBodyFromName(const tString &in asName)
int	GetBodyIndexFromName(const tString &in asName)
int	GetBodyNum()
tString	GetClassName()
void	GetClosestBody(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, int alUserValue = 0)
void	GetClosestCharCollideBody(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, int alUserValue = 0)
void	GetClosestCharCollider(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, bool abCheckDynamic)
void	GetClosestEntity(const tString &in asCallbackFunc, const cVector3f &in avStart, const cVector3f &in avDir, float afRayLength, int alInteractType, bool abCheckLineOfSight)
iLuxEntityComponent	GetComponentByType(eLuxEntityComponentType aType)
int	GetCurrentAnimationIndex()
cAnimationState	GetCurrentAnimationState()
cColor	GetEffectBaseColor()
bool	GetEffectsActive()
float	GetEffectsAlpha()
tString	GetEffectsOffSound()
float	GetEffectsOffTime()
tString	GetEffectsOnSound()
float	GetEffectsOnTime()
eLuxEntityType	GetEntityType()
tString	GetEventInstanceTag()
tString	GetEventTag()
tString	GetFileName()
bool	GetForceLookAtCheck()
tID	GetID()
bool	GetIgnoreDynamicAvoidance()
int	GetInteractIconId(int alType, iPhysicsBody@ apBody)
bool	GetInteractionDisabled()
bool	GetIsClosedDoor()
bool	GetIsDoor()
bool	GetLastCreatedSoundIsPlaying()
cLensFlare	GetLensFlareFromName(const tString &in asName)
iLight	GetLightFromName(const tString &in asName)
void	GetLightLevelAtPos(const tString &in asCallbackFunc, const cVector3f &in avPos, iLight@ apSkipLight, float afRadiusAdd)
iPhysicsBody	GetMainBody()
cLuxMap	GetMap()
cMatrixf	GetMatrix()
float	GetMaxInteractDistance()
cMeshEntity	GetMeshEntity()
cVector3f	GetMeshScaleMul()
tString	GetName()
cMatrixf	GetOnLoadOffsetTransform()
cVector3f	GetOnLoadScale()
cMatrixf	GetOnLoadTransform()
tID	GetParentId()
tString	GetParentName()
int	GetParentType()
cParticleSystem	GetParticleSystemFromName(const tString &in asName)
cVector3f	GetPosition()
bool	GetReturnBool()
float	GetReturnFloat()
int	GetReturnInt()
tString	GetReturnString()
bool	GetSaveDataIsUpdated()
bool	GetScriptableIsSaved()
cSoundEntity	GetSoundEntityFromName(const tString &in asName)
bool	GetVarBool(const tString &in asName)
cColor	GetVarColor(const tString &in asName)
float	GetVarFloat(const tString &in asName)
float	GetVariableUpdateRate()
int	GetVarInt(const tString &in asName)
tString	GetVarString(const tString &in asName)
cVector2f	GetVarVector2f(const tString &in asName)
cVector3f	GetVarVector3f(const tString &in asName)
cNode3D	GetVoiceAttachNode()
bool	GiveDamage(iPhysicsBody@ apBody, const cVector3f &in avOrigin, const cVector3f &in avHitPos, cLuxDamageProperties@ apDamageProps)
bool	HasCollideCallbacks()
bool	HasPlayerInteractCallback()
bool	HasPlayerInteractLeaveCallback()
bool	HasPlayerLookAtCallback()
void	IncVarFloat(const tString &in asName, float afX)
void	IncVarInt(const tString &in asName, int alX)
void	IncVarVector2f(const tString &in asName, const cVector2f &in avX)
void	IncVarVector3f(const tString &in asName, const cVector3f &in avX)
bool	IsActive()
bool	IsEffectsFading()
bool	IsInteractedWith()
bool	IsLookedAtByPlayer()
bool	IsOccluder()
bool	IsSleeping()
void	MoveLinearTo(const cVector3f &in avGoal, float afAcc, float afMaxSpeed, float afSlowdownDist, bool abResetSpeed, const tString &in asCallback = "")
bool	OnInteract(int alType, iPhysicsBody@ apBody, const cVector3f &in avFocusPos, const tString &in asData)
int	PlayAnimation(const tString &in asName, float afFadeTime = 0.3f, bool abLoop = false, bool abPlayTransition = true, const tString &in asCallback = "", bool abGlobalSpace = false, bool abApplyBoneRootMotion = false)
cSoundEntity	PlaySound(const tString &in asName, const tString &in asFile, bool abRemoveWhenDone, bool abAttach, float afCustomMinDist = -1, float afCustomMaxDist = -1)
void	PostUpdate(float afTimeStep)
void	PreloadEntityModel(const tString &in asFile)
void	RemoveAllConnections()
void	RemoveCollideCallback(const tString &in asEntityName)
void	RemoveConnection(const tString &in asName)
void	RemoveEntityAttachment()
void	RunPlayerInteractLeaveCallback()
bool	ScriptExecute()
bool	ScriptMethodExists(const tString &in asMethod)
bool	ScriptMethodExistsFast(const tString &in asMethod, int alId)
bool	ScriptPrepare(const tString &in asMethod)
bool	ScriptPrepareFast(const tString &in asMethod, int alId)
void	SetActive(bool abX)
void	SetAnimationCallbackActive(bool abX)
void	SetAnimationMessageEventCallback(const tString &in asFunc, bool abAutoRemove)
void	SetArgBool(int alArgNum, bool abVal)
void	SetArgFloat(int alArg, float afX)
void	SetArgInt(int alArg, int alX)
void	SetArgString(int alArg, const tString &in asStr)
void	SetAutoSleep(bool abX)
void	SetConnectionStateChangeCallback(const tString &in asCallbackFunc)
void	SetCurrentAnimationPaused(bool abX)
void	SetCustomEffectsOffAlpha(float afAlpha)
void	SetEffectBaseColor(const cColor &in aColor)
void	SetEffectsActive(bool abActive, bool abFadeAndPlaySounds)
void	SetEffectsOffTime(float afTime)
void	SetEffectsOnTime(float afTime)
void	SetEventInstanceTag(const tString &in asTag)
void	SetForceLookAtCheck(bool abX)
void	SetFullGameSave(bool abX)
void	SetIgnoreDynamicAvoidance(bool abX)
void	SetIlluminationBaseColor(const cColor &in aColor)
void	SetInteractionDisabled(bool abX)
void	SetIsClosedDoor(bool abX)
void	SetIsDoor(bool abX)
void	SetIsInteractedWith(bool abX)
void	SetIsOccluder(bool abX)
void	SetLookAtCheckCenterOfScreen(bool abX)
void	SetLookAtCheckRayIntersection(bool abX)
void	SetLookAtMaxDistance(float afX)
void	SetMatrix(const cMatrixf &in a_mtxTransform)
void	SetMaxInteractDistance(float afX)
void	SetMeshScaleMul(const cVector3f &in avScale)
void	SetNormalizeAnimationWeights(bool abX)
void	SetPlayerInteractCallback(const tString &in asCallbackFunc, bool abRemoveWhenInteracted)
void	SetPlayerInteractLeaveCallback(const tString &in asCallbackFunc, bool abRemoveWhenInteracted)
void	SetPlayerLookAtCallback(const tString &in asCallbackFunc, bool abRemoveWhenLookedAt, bool abCheckCenterOfScreen, bool abCheckRayIntersection, float afMaxDistance, float afCallbackDelay)
void	SetPosition(const cVector3f &in avPos)
void	SetRecieveMessageCallback(const tString &in asCallbackFunc)
void	SetSaveDataIsUpdated(bool abX)
void	SetScriptableIsSaved(bool abX)
void	SetupParent(int alTypeId, tID alId, const tString &in asName)
void	SetupRootBoneMotion(const tString &in asAnimName, bool abApplyMotionToEntity, bool abApplyMotionToBone)
void	SetVarBool(const tString &in asName, bool abX)
void	SetVarColor(const tString &in asName, const cColor &in aX)
void	SetVarFloat(const tString &in asName, float afX)
void	SetVariableUpdateRate(float afX)
void	SetVarInt(const tString &in asName, int alX)
void	SetVarString(const tString &in asName, const tString &in asX)
void	SetVarVector2f(const tString &in asName, const cVector2f &in avX)
void	SetVarVector3f(const tString &in asName, const cVector3f &in avX)
void	Sleep()
void	StopAllAnimations(float afFadeTime)
void	StopAnimation(const tString &in asName, float afFadeTime)
void	StopAnimation(int alIdx, float afFadeTime)
void	StopEffectBaseColorFade()
void	StopMove()
void	Timer_Add(uint64 alID, float afTime, const tString &in asFunc = "", bool abCreateIfExist = true, bool abRepeat = false)
void	Timer_Add(const tString &in asID, float afTime, const tString &in asFunc = "", bool abCreateIfExist = true, bool abRepeat = false)
void	Timer_ClearAll()
bool	Timer_Exists(uint64 alID)
bool	Timer_Exists(const tString &in asID)
float	Timer_GetTimeLeft(uint64 alID)
float	Timer_GetTimeLeft(const tString &in asID)
float	Timer_GetValue(uint64 alID, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
float	Timer_GetValue(const tString &in asID, float afMin = 0, float afMax = 1, eEasing aEasing = eEasing_Linear, bool abAbsValue = false)
void	Timer_Remove(uint64 alID)
void	Timer_Remove(const tString &in asID)
void	Timer_SetPaused(uint64 alID, bool abX)
void	Timer_SetPaused(const tString &in asID, bool abX)
bool	Timer_TimeHasPassed(uint64 alID, float afLength)
bool	Timer_TimeHasPassed(const tString &in asID, float afLength)
void	Update(float afTimeStep)
void	UpdateEntityAttachment()
void	VariableUpdate(float afDeltaTime)
void	WakeUp()

Details

AddCollideCallback

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

Parameters

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

Returns:

void

AddConnection

void AddConnection(const tString &in asName,
                   iLuxEntity@ apEntity,
                   bool abInvertStateSent,
                   int alStatesUsed)

Parameters

asName (tString) —
apEntity (iLuxEntity@) —
abInvertStateSent (bool) —
alStatesUsed (int) —

Returns:

void

AppendAnimation

void AppendAnimation(const tString &in asName,
                     bool abLoop)

Parameters

asName (tString) —
abLoop (bool) —

Returns:

void

AttachToEntity

void AttachToEntity(iLuxEntity@ apEntity,
                    iPhysicsBody@ apTargetBody,
                    bool abUseRotation,
                    bool abSnapToParent,
                    bool abLocked = false)

Parameters

apEntity (iLuxEntity@) —
apTargetBody (iPhysicsBody@) —
abUseRotation (bool) —
abSnapToParent (bool) —
abLocked (bool) —

Returns:

void

AttachToSocket

void AttachToSocket(iLuxEntity@ apEntity,
                    const tString &in asSocket,
                    bool abUseRotation,
                    bool abSnapToParent,
                    bool abLocked = false)

Parameters

apEntity (iLuxEntity@) —
asSocket (tString) —
abUseRotation (bool) —
abSnapToParent (bool) —
abLocked (bool) —

Returns:

void

BroadcastMessage

void BroadcastMessage(int alMessageId,
                      iLuxEntityComponent@ apSource,
                      const cVector3f &in avData,
                      int alData)

Parameters

alMessageId (int) —
apSource (iLuxEntityComponent@) —
avData (cVector3f) —
alData (int) —

Returns:

void

CalculateRootMotion

cVector3f CalculateRootMotion()

Returns:

cVector3f—

CanInteract

bool CanInteract(int alType,
                 iPhysicsBody@ apBody)

Parameters

alType (int) —
apBody (iPhysicsBody@) —

Returns:

bool—

ChangeConnectionState

void ChangeConnectionState(int alState)

Parameters

alState (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—

CheckIsOnScreen

bool CheckIsOnScreen(bool abUseRayCast)

Parameters

abUseRayCast (bool) —

Returns:

bool—

CheckShapeCollision

bool CheckShapeCollision(iCollideShape@ apShape,
                         const cMatrixf &in a_mtxTransform,
                         cLuxMap@ apMap)

Parameters

apShape (iCollideShape@) —
a_mtxTransform (cMatrixf) —
apMap (cLuxMap@) —

Returns:

bool—

CollidesWithPlayer

bool CollidesWithPlayer()

Returns:

bool—

CreateParticleSystem

cParticleSystem@ CreateParticleSystem(const tString &in asName,
                                      const tString &in asFile,
                                      bool abRemoveWhenDone,
                                      bool abAttach)

Parameters

asName (tString) —
asFile (tString) —
abRemoveWhenDone (bool) —
abAttach (bool) —

Returns:

cParticleSystem@—

CreateParticleSystemOnBone

cParticleSystem@ CreateParticleSystemOnBone(const tString &in asName,
                                            const tString &in asFile,
                                            const tString &in asBoneName,
                                            bool abRemoveWhenDone,
                                            bool abAttach)

Parameters

asName (tString) —
asFile (tString) —
asBoneName (tString) —
abRemoveWhenDone (bool) —
abAttach (bool) —

Returns:

cParticleSystem@—

DrawProjDebugText

void DrawProjDebugText(const tString &in asText,
                       float afFontSize = 16.0f,
                       bool abProjectSize = false,
                       eFontAlign aAlignment = eFontAlign_Left,
                       const cColor &in aColor = cColor,
                        1,
                        1,
                       const cVector3f &in avOffset = cVector3f,
                        0,
                       float afMaxDistance = 20)

Parameters

asText (tString) —
afFontSize (float) —
abProjectSize (bool) —
aAlignment (eFontAlign) —
aColor (cColor) —
1 (../) —
1 (../) —
avOffset (cVector3f) —
0 (../) —
afMaxDistance (float) —

Returns:

void

FadeEffectBaseColor

void FadeEffectBaseColor(const cColor &in aDestColor,
                         float afTime)

Parameters

aDestColor (cColor) —
afTime (float) —

Returns:

void

FadeMeshScaleMul

void FadeMeshScaleMul(const cVector3f &in avDestScale,
                      float afTime,
                      eEasing aEasing = eEasing_Linear)

Parameters

avDestScale (cVector3f) —
afTime (float) —
aEasing (eEasing) —

Returns:

void

Fader_ClearAll

void Fader_ClearAll()

Returns:

void

Fader_FadeTo

void Fader_FadeTo(uint alID,
                  float afGoal,
                  float afTime,
                  bool abReverseAtEnd = false,
                  bool abSkipIfExists = false)

Parameters

alID (uint) —
afGoal (float) —
afTime (float) —
abReverseAtEnd (bool) —
abSkipIfExists (bool) —

Returns:

void

Fader_FadeTo

void Fader_FadeTo(const tString &in asName,
                  float afGoal,
                  float afTime,
                  bool abReverseAtEnd = false,
                  bool abSkipIfExists = false)

Parameters

asName (tString) —
afGoal (float) —
afTime (float) —
abReverseAtEnd (bool) —
abSkipIfExists (bool) —

Returns:

void

Fader_GetValue

float Fader_GetValue(uint alID,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)

Parameters

alID (uint) —
afMin (float) —
afMax (float) —
aEasing (eEasing) —
abAbsValue (bool) —

Returns:

float—

Fader_GetValue

float Fader_GetValue(const tString &in asName,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)

Parameters

asName (tString) —
afMin (float) —
afMax (float) —
aEasing (eEasing) —
abAbsValue (bool) —

Returns:

float—

Fader_Set

void Fader_Set(uint alID,
               float afX,
               bool abSkipIfExists = false)

Parameters

alID (uint) —
afX (float) —
abSkipIfExists (bool) —

Returns:

void

Fader_Set

void Fader_Set(const tString &in asName,
               float afX,
               bool abSkipIfExists = false)

Parameters

asName (tString) —
afX (float) —
abSkipIfExists (bool) —

Returns:

void

Fader_SetPaused

void Fader_SetPaused(uint alID,
                     bool abPaused)

Parameters

alID (uint) —
abPaused (bool) —

Returns:

void

Fader_SetPaused

void Fader_SetPaused(const tString &in asName,
                     bool abPaused)

Parameters

asName (tString) —
abPaused (bool) —

Returns:

void

GetAnimationIsPlaying

bool GetAnimationIsPlaying()

Returns:

bool—

GetAreaBody

iPhysicsBody@ GetAreaBody()

Returns:

iPhysicsBody@—

GetAttachEntity

iEntity3D@ GetAttachEntity()

Returns:

iEntity3D@—

GetAutoSleep

bool GetAutoSleep()

Returns:

bool—

GetBaseMaterial

cMaterial@ GetBaseMaterial()

Returns:

cMaterial@—

GetBaseMatrix

cMatrixf GetBaseMatrix()

Returns:

cMatrixf—

GetBasePosition

cVector3f GetBasePosition()

Returns:

cVector3f—

GetBillboardFromName

cBillboard@ GetBillboardFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

cBillboard@—

GetBody

iPhysicsBody@ GetBody(int alIdx)

Parameters

alIdx (int) —

Returns:

iPhysicsBody@—

GetBodyFromID

iPhysicsBody@ GetBodyFromID(int alID)

Parameters

alID (int) —

Returns:

iPhysicsBody@—

GetBodyFromName

iPhysicsBody@ GetBodyFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

iPhysicsBody@—

GetBodyIndexFromName

int GetBodyIndexFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

int—

GetBodyNum

int GetBodyNum()

Returns:

int—

GetClassName

const tString& GetClassName()

Returns:

const tString&—

GetClosestBody

void GetClosestBody(const tString &in asCallbackFunc,
                    const cVector3f &in avStart,
                    const cVector3f &in avDir,
                    float afRayLength,
                    int alUserValue = 0)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
alUserValue (int) —

Returns:

void

GetClosestCharCollideBody

void GetClosestCharCollideBody(const tString &in asCallbackFunc,
                               const cVector3f &in avStart,
                               const cVector3f &in avDir,
                               float afRayLength,
                               int alUserValue = 0)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
alUserValue (int) —

Returns:

void

GetClosestCharCollider

void GetClosestCharCollider(const tString &in asCallbackFunc,
                            const cVector3f &in avStart,
                            const cVector3f &in avDir,
                            float afRayLength,
                            bool abCheckDynamic)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
abCheckDynamic (bool) —

Returns:

void

GetClosestEntity

void GetClosestEntity(const tString &in asCallbackFunc,
                      const cVector3f &in avStart,
                      const cVector3f &in avDir,
                      float afRayLength,
                      int alInteractType,
                      bool abCheckLineOfSight)

Parameters

asCallbackFunc (tString) —
avStart (cVector3f) —
avDir (cVector3f) —
afRayLength (float) —
alInteractType (int) —
abCheckLineOfSight (bool) —

Returns:

void

GetComponentByType

iLuxEntityComponent@ GetComponentByType(eLuxEntityComponentType aType)

Parameters

aType (eLuxEntityComponentType) —

Returns:

iLuxEntityComponent@—

GetCurrentAnimationIndex

int GetCurrentAnimationIndex()

Returns:

int—

GetCurrentAnimationState

cAnimationState@ GetCurrentAnimationState()

Returns:

cAnimationState@—

GetEffectBaseColor

const cColor& GetEffectBaseColor()

Returns:

const cColor&—

GetEffectsActive

bool GetEffectsActive()

Returns:

bool—

GetEffectsAlpha

float GetEffectsAlpha()

Returns:

float—

GetEffectsOffSound

const tString& GetEffectsOffSound()

Returns:

const tString&—

GetEffectsOffTime

float GetEffectsOffTime()

Returns:

float—

GetEffectsOnSound

const tString& GetEffectsOnSound()

Returns:

const tString&—

GetEffectsOnTime

float GetEffectsOnTime()

Returns:

float—

GetEntityType

eLuxEntityType GetEntityType()

Returns:

eLuxEntityType—

GetEventInstanceTag

const tString& GetEventInstanceTag()

Returns:

const tString&—

GetEventTag

const tString& GetEventTag()

Returns:

const tString&—

GetFileName

const tString& GetFileName()

Returns:

const tString&—

GetForceLookAtCheck

bool GetForceLookAtCheck()

Returns:

bool—

GetID

const tID& GetID()

Returns:

const tID&—

GetIgnoreDynamicAvoidance

bool GetIgnoreDynamicAvoidance()

Returns:

bool—

GetInteractIconId

int GetInteractIconId(int alType,
                      iPhysicsBody@ apBody)

Parameters

alType (int) —
apBody (iPhysicsBody@) —

Returns:

int—

GetInteractionDisabled

bool GetInteractionDisabled()

Returns:

bool—

GetIsClosedDoor

bool GetIsClosedDoor()

Returns:

bool—

GetIsDoor

bool GetIsDoor()

Returns:

bool—

GetLastCreatedSoundIsPlaying

bool GetLastCreatedSoundIsPlaying()

Returns:

bool—

GetLensFlareFromName

cLensFlare@ GetLensFlareFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

cLensFlare@—

GetLightFromName

iLight@ GetLightFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

iLight@—

GetLightLevelAtPos

void GetLightLevelAtPos(const tString &in asCallbackFunc,
                        const cVector3f &in avPos,
                        iLight@ apSkipLight,
                        float afRadiusAdd)

Parameters

asCallbackFunc (tString) —
avPos (cVector3f) —
apSkipLight (iLight@) —
afRadiusAdd (float) —

Returns:

void

GetMainBody

iPhysicsBody@ GetMainBody()

Returns:

iPhysicsBody@—

GetMap

cLuxMap@ GetMap()

Returns:

cLuxMap@—

GetMatrix

cMatrixf GetMatrix()

Returns:

cMatrixf—

GetMaxInteractDistance

float GetMaxInteractDistance()

Returns:

float—

GetMeshEntity

cMeshEntity@ GetMeshEntity()

Returns:

cMeshEntity@—

GetMeshScaleMul

cVector3f GetMeshScaleMul()

Returns:

cVector3f—

GetName

const tString& GetName()

Returns:

const tString&—

GetOnLoadOffsetTransform

const cMatrixf& GetOnLoadOffsetTransform()

Returns:

const cMatrixf&—

GetOnLoadScale

const cVector3f& GetOnLoadScale()

Returns:

const cVector3f&—

GetOnLoadTransform

const cMatrixf& GetOnLoadTransform()

Returns:

const cMatrixf&—

GetParentId

tID GetParentId()

Returns:

tID—

GetParentName

const tString& GetParentName()

Returns:

const tString&—

GetParentType

int GetParentType()

Returns:

int—

GetParticleSystemFromName

cParticleSystem@ GetParticleSystemFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

cParticleSystem@—

GetPosition

cVector3f GetPosition()

Returns:

cVector3f—

GetReturnBool

bool GetReturnBool()

Returns:

bool—

GetReturnFloat

float GetReturnFloat()

Returns:

float—

GetReturnInt

int GetReturnInt()

Returns:

int—

GetReturnString

tString GetReturnString()

Returns:

tString—

GetSaveDataIsUpdated

bool GetSaveDataIsUpdated()

Returns:

bool—

GetScriptableIsSaved

bool GetScriptableIsSaved()

Returns:

bool—

GetSoundEntityFromName

cSoundEntity@ GetSoundEntityFromName(const tString &in asName)

Parameters

asName (tString) —

Returns:

cSoundEntity@—

GetVarBool

bool GetVarBool(const tString &in asName)

Parameters

asName (tString) —

Returns:

bool—

GetVarColor

cColor GetVarColor(const tString &in asName)

Parameters

asName (tString) —

Returns:

cColor—

GetVarFloat

float GetVarFloat(const tString &in asName)

Parameters

asName (tString) —

Returns:

float—

GetVariableUpdateRate

float GetVariableUpdateRate()

Returns:

float—

GetVarInt

int GetVarInt(const tString &in asName)

Parameters

asName (tString) —

Returns:

int—

GetVarString

const tString& GetVarString(const tString &in asName)

Parameters

asName (tString) —

Returns:

const tString&—

GetVarVector2f

cVector2f GetVarVector2f(const tString &in asName)

Parameters

asName (tString) —

Returns:

cVector2f—

GetVarVector3f

cVector3f GetVarVector3f(const tString &in asName)

Parameters

asName (tString) —

Returns:

cVector3f—

GetVoiceAttachNode

cNode3D@ GetVoiceAttachNode()

Returns:

cNode3D@—

GiveDamage

bool GiveDamage(iPhysicsBody@ apBody,
                const cVector3f &in avOrigin,
                const cVector3f &in avHitPos,
                cLuxDamageProperties@ apDamageProps)

Parameters

apBody (iPhysicsBody@) —
avOrigin (cVector3f) —
avHitPos (cVector3f) —
apDamageProps (cLuxDamageProperties@) —

Returns:

bool—

HasCollideCallbacks

bool HasCollideCallbacks()

Returns:

bool—

HasPlayerInteractCallback

bool HasPlayerInteractCallback()

Returns:

bool—

HasPlayerInteractLeaveCallback

bool HasPlayerInteractLeaveCallback()

Returns:

bool—

HasPlayerLookAtCallback

bool HasPlayerLookAtCallback()

Returns:

bool—

IncVarFloat

void IncVarFloat(const tString &in asName,
                 float afX)

Parameters

asName (tString) —
afX (float) —

Returns:

void

IncVarInt

void IncVarInt(const tString &in asName,
               int alX)

Parameters

asName (tString) —
alX (int) —

Returns:

void

IncVarVector2f

void IncVarVector2f(const tString &in asName,
                    const cVector2f &in avX)

Parameters

asName (tString) —
avX (cVector2f) —

Returns:

void

IncVarVector3f

void IncVarVector3f(const tString &in asName,
                    const cVector3f &in avX)

Parameters

asName (tString) —
avX (cVector3f) —

Returns:

void

IsActive

bool IsActive()

Returns:

bool—

IsEffectsFading

bool IsEffectsFading()

Returns:

bool—

IsInteractedWith

bool IsInteractedWith()

Returns:

bool—

IsLookedAtByPlayer

bool IsLookedAtByPlayer()

Returns:

bool—

IsOccluder

bool IsOccluder()

Returns:

bool—

IsSleeping

bool IsSleeping()

Returns:

bool—

MoveLinearTo

void MoveLinearTo(const cVector3f &in avGoal,
                  float afAcc,
                  float afMaxSpeed,
                  float afSlowdownDist,
                  bool abResetSpeed,
                  const tString &in asCallback = "")

Parameters

avGoal (cVector3f) —
afAcc (float) —
afMaxSpeed (float) —
afSlowdownDist (float) —
abResetSpeed (bool) —
asCallback (tString) —

Returns:

void

OnInteract

bool OnInteract(int alType,
                iPhysicsBody@ apBody,
                const cVector3f &in avFocusPos,
                const tString &in asData)

Parameters

alType (int) —
apBody (iPhysicsBody@) —
avFocusPos (cVector3f) —
asData (tString) —

Returns:

bool—

PlayAnimation

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

Parameters

asName (tString) —
afFadeTime (float) —
abLoop (bool) —
abPlayTransition (bool) —
asCallback (tString) —
abGlobalSpace (bool) —
abApplyBoneRootMotion (bool) —

Returns:

int—

PlaySound

cSoundEntity@ PlaySound(const tString &in asName,
                        const tString &in asFile,
                        bool abRemoveWhenDone,
                        bool abAttach,
                        float afCustomMinDist = -1,
                        float afCustomMaxDist = -1)

Parameters

asName (tString) —
asFile (tString) —
abRemoveWhenDone (bool) —
abAttach (bool) —
afCustomMinDist (float) —
afCustomMaxDist (float) —

Returns:

cSoundEntity@—

PostUpdate

void PostUpdate(float afTimeStep)

Parameters

afTimeStep (float) —

Returns:

void

PreloadEntityModel

void PreloadEntityModel(const tString &in asFile)

Parameters

asFile (tString) —

Returns:

void

RemoveAllConnections

void RemoveAllConnections()

Returns:

void

RemoveCollideCallback

void RemoveCollideCallback(const tString &in asEntityName)

Parameters

asEntityName (tString) —

Returns:

void

RemoveConnection

void RemoveConnection(const tString &in asName)

Parameters

asName (tString) —

Returns:

void

RemoveEntityAttachment

void RemoveEntityAttachment()

Returns:

void

RunPlayerInteractLeaveCallback

void RunPlayerInteractLeaveCallback()

Returns:

void

ScriptExecute

bool ScriptExecute()

Returns:

bool—

ScriptMethodExists

bool ScriptMethodExists(const tString &in asMethod)

Parameters

asMethod (tString) —

Returns:

bool—

ScriptMethodExistsFast

bool ScriptMethodExistsFast(const tString &in asMethod,
                            int alId)

Parameters

asMethod (tString) —
alId (int) —

Returns:

bool—

ScriptPrepare

bool ScriptPrepare(const tString &in asMethod)

Parameters

asMethod (tString) —

Returns:

bool—

ScriptPrepareFast

bool ScriptPrepareFast(const tString &in asMethod,
                       int alId)

Parameters

asMethod (tString) —
alId (int) —

Returns:

bool—

SetActive

void SetActive(bool abX)

Parameters

abX (bool) —

Returns:

void

SetAnimationCallbackActive

void SetAnimationCallbackActive(bool abX)

Parameters

abX (bool) —

Returns:

void

SetAnimationMessageEventCallback

void SetAnimationMessageEventCallback(const tString &in asFunc,
                                      bool abAutoRemove)

Parameters

asFunc (tString) —
abAutoRemove (bool) —

Returns:

void

SetArgBool

void SetArgBool(int alArgNum,
                bool abVal)

Parameters

alArgNum (int) —
abVal (bool) —

Returns:

void

SetArgFloat

void SetArgFloat(int alArg,
                 float afX)

Parameters

alArg (int) —
afX (float) —

Returns:

void

SetArgInt

void SetArgInt(int alArg,
               int alX)

Parameters

alArg (int) —
alX (int) —

Returns:

void

SetArgString

void SetArgString(int alArg,
                  const tString &in asStr)

Parameters

alArg (int) —
asStr (tString) —

Returns:

void

SetAutoSleep

void SetAutoSleep(bool abX)

Parameters

abX (bool) —

Returns:

void

SetConnectionStateChangeCallback

void SetConnectionStateChangeCallback(const tString &in asCallbackFunc)

Parameters

asCallbackFunc (tString) —

Returns:

void

SetCurrentAnimationPaused

void SetCurrentAnimationPaused(bool abX)

Parameters

abX (bool) —

Returns:

void

SetCustomEffectsOffAlpha

void SetCustomEffectsOffAlpha(float afAlpha)

Parameters

afAlpha (float) —

Returns:

void

SetEffectBaseColor

void SetEffectBaseColor(const cColor &in aColor)

Parameters

aColor (cColor) —

Returns:

void

SetEffectsActive

void SetEffectsActive(bool abActive,
                      bool abFadeAndPlaySounds)

Parameters

abActive (bool) —
abFadeAndPlaySounds (bool) —

Returns:

void

SetEffectsOffTime

void SetEffectsOffTime(float afTime)

Parameters

afTime (float) —

Returns:

void

SetEffectsOnTime

void SetEffectsOnTime(float afTime)

Parameters

afTime (float) —

Returns:

void

SetEventInstanceTag

void SetEventInstanceTag(const tString &in asTag)

Parameters

asTag (tString) —

Returns:

void

SetForceLookAtCheck

void SetForceLookAtCheck(bool abX)

Parameters

abX (bool) —

Returns:

void

SetFullGameSave

void SetFullGameSave(bool abX)

Parameters

abX (bool) —

Returns:

void

SetIgnoreDynamicAvoidance

void SetIgnoreDynamicAvoidance(bool abX)

Parameters

abX (bool) —

Returns:

void

SetIlluminationBaseColor

void SetIlluminationBaseColor(const cColor &in aColor)

Parameters

aColor (cColor) —

Returns:

void

SetInteractionDisabled

void SetInteractionDisabled(bool abX)

Parameters

abX (bool) —

Returns:

void

SetIsClosedDoor

void SetIsClosedDoor(bool abX)

Parameters

abX (bool) —

Returns:

void

SetIsDoor

void SetIsDoor(bool abX)

Parameters

abX (bool) —

Returns:

void

SetIsInteractedWith

void SetIsInteractedWith(bool abX)

Parameters

abX (bool) —

Returns:

void

SetIsOccluder

void SetIsOccluder(bool abX)

Parameters

abX (bool) —

Returns:

void

SetLookAtCheckCenterOfScreen

void SetLookAtCheckCenterOfScreen(bool abX)

Parameters

abX (bool) —

Returns:

void

SetLookAtCheckRayIntersection

void SetLookAtCheckRayIntersection(bool abX)

Parameters

abX (bool) —

Returns:

void

SetLookAtMaxDistance

void SetLookAtMaxDistance(float afX)

Parameters

afX (float) —

Returns:

void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)

Parameters

a_mtxTransform (cMatrixf) —

Returns:

void

SetMaxInteractDistance

void SetMaxInteractDistance(float afX)

Parameters

afX (float) —

Returns:

void

SetMeshScaleMul

void SetMeshScaleMul(const cVector3f &in avScale)

Parameters

avScale (cVector3f) —

Returns:

void

SetNormalizeAnimationWeights

void SetNormalizeAnimationWeights(bool abX)

Parameters

abX (bool) —

Returns:

void

SetPlayerInteractCallback

void SetPlayerInteractCallback(const tString &in asCallbackFunc,
                               bool abRemoveWhenInteracted)

Parameters

asCallbackFunc (tString) —
abRemoveWhenInteracted (bool) —

Returns:

void

SetPlayerInteractLeaveCallback

void SetPlayerInteractLeaveCallback(const tString &in asCallbackFunc,
                                    bool abRemoveWhenInteracted)

Parameters

asCallbackFunc (tString) —
abRemoveWhenInteracted (bool) —

Returns:

void

SetPlayerLookAtCallback

void SetPlayerLookAtCallback(const tString &in asCallbackFunc,
                             bool abRemoveWhenLookedAt,
                             bool abCheckCenterOfScreen,
                             bool abCheckRayIntersection,
                             float afMaxDistance,
                             float afCallbackDelay)

Parameters

asCallbackFunc (tString) —
abRemoveWhenLookedAt (bool) —
abCheckCenterOfScreen (bool) —
abCheckRayIntersection (bool) —
afMaxDistance (float) —
afCallbackDelay (float) —

Returns:

void

SetPosition

void SetPosition(const cVector3f &in avPos)

Parameters

avPos (cVector3f) —

Returns:

void

SetRecieveMessageCallback

void SetRecieveMessageCallback(const tString &in asCallbackFunc)

Parameters

asCallbackFunc (tString) —

Returns:

void

SetSaveDataIsUpdated

void SetSaveDataIsUpdated(bool abX)

Parameters

abX (bool) —

Returns:

void

SetScriptableIsSaved

void SetScriptableIsSaved(bool abX)

Parameters

abX (bool) —

Returns:

void

SetupParent

void SetupParent(int alTypeId,
                 tID alId,
                 const tString &in asName)

Parameters

alTypeId (int) —
alId (tID) —
asName (tString) —

Returns:

void

SetupRootBoneMotion

void SetupRootBoneMotion(const tString &in asAnimName,
                         bool abApplyMotionToEntity,
                         bool abApplyMotionToBone)

Parameters

asAnimName (tString) —
abApplyMotionToEntity (bool) —
abApplyMotionToBone (bool) —

Returns:

void

SetVarBool

void SetVarBool(const tString &in asName,
                bool abX)

Parameters

asName (tString) —
abX (bool) —

Returns:

void

SetVarColor

void SetVarColor(const tString &in asName,
                 const cColor &in aX)

Parameters

asName (tString) —
aX (cColor) —

Returns:

void

SetVarFloat

void SetVarFloat(const tString &in asName,
                 float afX)

Parameters

asName (tString) —
afX (float) —

Returns:

void

SetVariableUpdateRate

void SetVariableUpdateRate(float afX)

Parameters

afX (float) —

Returns:

void

SetVarInt

void SetVarInt(const tString &in asName,
               int alX)

Parameters

asName (tString) —
alX (int) —

Returns:

void

SetVarString

void SetVarString(const tString &in asName,
                  const tString &in asX)

Parameters

asName (tString) —
asX (tString) —

Returns:

void

SetVarVector2f

void SetVarVector2f(const tString &in asName,
                    const cVector2f &in avX)

Parameters

asName (tString) —
avX (cVector2f) —

Returns:

void

SetVarVector3f

void SetVarVector3f(const tString &in asName,
                    const cVector3f &in avX)

Parameters

asName (tString) —
avX (cVector3f) —

Returns:

void

Sleep

void Sleep()

Returns:

void

StopAllAnimations

void StopAllAnimations(float afFadeTime)

Parameters

afFadeTime (float) —

Returns:

void

StopAnimation

void StopAnimation(const tString &in asName,
                   float afFadeTime)

Parameters

asName (tString) —
afFadeTime (float) —

Returns:

void

StopAnimation

void StopAnimation(int alIdx,
                   float afFadeTime)

Parameters

alIdx (int) —
afFadeTime (float) —

Returns:

void

StopEffectBaseColorFade

void StopEffectBaseColorFade()

Returns:

void

StopMove

void StopMove()

Returns:

void

Timer_Add

void Timer_Add(uint64 alID,
               float afTime,
               const tString &in asFunc = "",
               bool abCreateIfExist = true,
               bool abRepeat = false)

Parameters

alID (uint64) —
afTime (float) —
asFunc (tString) —
abCreateIfExist (bool) —
abRepeat (bool) —

Returns:

void

Timer_Add

void Timer_Add(const tString &in asID,
               float afTime,
               const tString &in asFunc = "",
               bool abCreateIfExist = true,
               bool abRepeat = false)

Parameters

asID (tString) —
afTime (float) —
asFunc (tString) —
abCreateIfExist (bool) —
abRepeat (bool) —

Returns:

void

Timer_ClearAll

void Timer_ClearAll()

Returns:

void

Timer_Exists

bool Timer_Exists(uint64 alID)

Parameters

alID (uint64) —

Returns:

bool—

Timer_Exists

bool Timer_Exists(const tString &in asID)

Parameters

asID (tString) —

Returns:

bool—

Timer_GetTimeLeft

float Timer_GetTimeLeft(uint64 alID)

Parameters

alID (uint64) —

Returns:

float—

Timer_GetTimeLeft

float Timer_GetTimeLeft(const tString &in asID)

Parameters

asID (tString) —

Returns:

float—

Timer_GetValue

float Timer_GetValue(uint64 alID,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)

Parameters

alID (uint64) —
afMin (float) —
afMax (float) —
aEasing (eEasing) —
abAbsValue (bool) —

Returns:

float—

Timer_GetValue

float Timer_GetValue(const tString &in asID,
                     float afMin = 0,
                     float afMax = 1,
                     eEasing aEasing = eEasing_Linear,
                     bool abAbsValue = false)

Parameters

asID (tString) —
afMin (float) —
afMax (float) —
aEasing (eEasing) —
abAbsValue (bool) —

Returns:

float—

Timer_Remove

void Timer_Remove(uint64 alID)

Parameters

alID (uint64) —

Returns:

void

Timer_Remove

void Timer_Remove(const tString &in asID)

Parameters

asID (tString) —

Returns:

void

Timer_SetPaused

void Timer_SetPaused(uint64 alID,
                     bool abX)

Parameters

alID (uint64) —
abX (bool) —

Returns:

void

Timer_SetPaused

void Timer_SetPaused(const tString &in asID,
                     bool abX)

Parameters

asID (tString) —
abX (bool) —

Returns:

void

Timer_TimeHasPassed

bool Timer_TimeHasPassed(uint64 alID,
                         float afLength)

Parameters

alID (uint64) —
afLength (float) —

Returns:

bool—

Timer_TimeHasPassed

bool Timer_TimeHasPassed(const tString &in asID,
                         float afLength)

Parameters

asID (tString) —
afLength (float) —

Returns:

bool—

Update

void Update(float afTimeStep)

Parameters

afTimeStep (float) —

Returns:

void

UpdateEntityAttachment

void UpdateEntityAttachment()

Returns:

void

VariableUpdate

void VariableUpdate(float afDeltaTime)

Parameters

afDeltaTime (float) —

Returns:

void

WakeUp

void WakeUp()

Returns:

void

References

See all references...

HPL3/Amnesia: Rebirth/Scripting/cLuxVisibilityPortal

Contents

Fields

Functions

Details

AddCollideCallback

AddConnection

AppendAnimation

AttachToEntity

AttachToSocket

BroadcastMessage

CalculateRootMotion

CanInteract

ChangeConnectionState

CheckBodyCollision

CheckCharacterCollision

CheckEntityCollision

CheckIsOnScreen

CheckShapeCollision

CollidesWithPlayer

CreateParticleSystem

CreateParticleSystemOnBone

DrawProjDebugText

FadeEffectBaseColor

FadeMeshScaleMul

Fader_ClearAll

Fader_FadeTo

Fader_FadeTo

Fader_GetValue

Fader_GetValue

Fader_Set

Fader_Set

Fader_SetPaused

Fader_SetPaused

GetAnimationIsPlaying

GetAreaBody

GetAttachEntity

GetAutoSleep

GetBaseMaterial

GetBaseMatrix

GetBasePosition

GetBillboardFromName

GetBody

GetBodyFromID

GetBodyFromName

GetBodyIndexFromName

GetBodyNum

GetClassName

GetClosestBody

GetClosestCharCollideBody

GetClosestCharCollider

GetClosestEntity

GetComponentByType

GetCurrentAnimationIndex

GetCurrentAnimationState

GetEffectBaseColor

GetEffectsActive

GetEffectsAlpha

GetEffectsOffSound

GetEffectsOffTime

GetEffectsOnSound

GetEffectsOnTime

GetEntityType

GetEventInstanceTag

GetEventTag

GetFileName

GetForceLookAtCheck

GetID

GetIgnoreDynamicAvoidance

GetInteractIconId

GetInteractionDisabled

GetIsClosedDoor

GetIsDoor

GetLastCreatedSoundIsPlaying

GetLensFlareFromName

GetLightFromName

GetLightLevelAtPos

GetMainBody

GetMap

GetMatrix