HPL3/Amnesia: Rebirth/Scripting/cLuxProp
![]() |
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!
Contents
- 1 Fields
- 2 Functions
- 3 Details
- 3.1 AddAndAttachProp
- 3.2 AddCollideCallback
- 3.3 AddConnection
- 3.4 AddInteractConnection
- 3.5 AppendAnimation
- 3.6 AttachToEntity
- 3.7 AttachToSocket
- 3.8 Break
- 3.9 BroadcastMessage
- 3.10 CalculateRootMotion
- 3.11 CanInteract
- 3.12 ChangeConnectionState
- 3.13 ChangeInteractConnectionState
- 3.14 CheckBodyCollision
- 3.15 CheckCharacterCollision
- 3.16 CheckEntityCollision
- 3.17 CheckIsOnScreen
- 3.18 CheckShapeCollision
- 3.19 CollidesWithPlayer
- 3.20 CreateAndSetupGui
- 3.21 CreateParticleSystem
- 3.22 CreateParticleSystemOnBone
- 3.23 DestroyAttachedProp
- 3.24 DisableSubMeshMerge
- 3.25 DrawProjDebugText
- 3.26 EnableBodyCollisionCallback
- 3.27 EnableCharCollisionUntilStopped
- 3.28 FadeEffectBaseColor
- 3.29 FadeInMeshEntity
- 3.30 FadeLiquidAmountTo
- 3.31 FadeMeshScaleMul
- 3.32 Fader_ClearAll
- 3.33 Fader_FadeTo
- 3.34 Fader_FadeTo
- 3.35 Fader_GetValue
- 3.36 Fader_GetValue
- 3.37 Fader_Set
- 3.38 Fader_Set
- 3.39 Fader_SetPaused
- 3.40 Fader_SetPaused
- 3.41 ForceGuiCacheUpdate
- 3.42 GetAllowMapTransfer
- 3.43 GetAnimationIsPlaying
- 3.44 GetAttachEntity
- 3.45 GetAttachmentParent
- 3.46 GetAutoSleep
- 3.47 GetBaseMaterial
- 3.48 GetBaseMatrix
- 3.49 GetBasePosition
- 3.50 GetBillboard
- 3.51 GetBillboardFromName
- 3.52 GetBillboardNum
- 3.53 GetBody
- 3.54 GetBodyExtraData
- 3.55 GetBodyFromID
- 3.56 GetBodyFromName
- 3.57 GetBodyIndexFromName
- 3.58 GetBodyNum
- 3.59 GetBreakActive
- 3.60 GetClassName
- 3.61 GetClosestBody
- 3.62 GetClosestCharCollideBody
- 3.63 GetClosestCharCollider
- 3.64 GetClosestEntity
- 3.65 GetComponentByType
- 3.66 GetCurrentAnimationIndex
- 3.67 GetCurrentAnimationState
- 3.68 GetEffectBaseColor
- 3.69 GetEffectsActive
- 3.70 GetEffectsAlpha
- 3.71 GetEffectsOffSound
- 3.72 GetEffectsOffTime
- 3.73 GetEffectsOnSound
- 3.74 GetEffectsOnTime
- 3.75 GetEntityType
- 3.76 GetEventInstanceTag
- 3.77 GetEventTag
- 3.78 GetFileName
- 3.79 GetForceLookAtCheck
- 3.80 GetGuiMaxUpdateDistance
- 3.81 GetGuiSet
- 3.82 GetGuiSetUseInput
- 3.83 GetGuiVariableFPS
- 3.84 GetHealth
- 3.85 GetID
- 3.86 GetIgnoreDynamicAvoidance
- 3.87 GetInteractConnectionNum
- 3.88 GetInteractIconId
- 3.89 GetInteractionDisabled
- 3.90 GetIsBreakable
- 3.91 GetIsClosedDoor
- 3.92 GetIsDoor
- 3.93 GetJoint
- 3.94 GetJointNum
- 3.95 GetLastCreatedSoundIsPlaying
- 3.96 GetLastInteractConnectionState
- 3.97 GetLensFlareFromName
- 3.98 GetLight
- 3.99 GetLightFromName
- 3.100 GetLightLevelAtPos
- 3.101 GetLightNum
- 3.102 GetMainBody
- 3.103 GetMap
- 3.104 GetMatrix
- 3.105 GetMaxInteractDistance
- 3.106 GetMeshEntity
- 3.107 GetMeshScaleMul
- 3.108 GetName
- 3.109 GetOnLoadOffsetTransform
- 3.110 GetOnLoadScale
- 3.111 GetOnLoadTransform
- 3.112 GetParentId
- 3.113 GetParentName
- 3.114 GetParentType
- 3.115 GetParicleSystemNum
- 3.116 GetParticleSystem
- 3.117 GetParticleSystemFromName
- 3.118 GetPosition
- 3.119 GetRenderLayer
- 3.120 GetReturnBool
- 3.121 GetReturnFloat
- 3.122 GetReturnInt
- 3.123 GetReturnString
- 3.124 GetSaveDataIsUpdated
- 3.125 GetScriptableIsSaved
- 3.126 GetScriptCollisionCallbackActive
- 3.127 GetSoundEntity
- 3.128 GetSoundEntityFromName
- 3.129 GetSoundEntityNum
- 3.130 GetStaticPhysics
- 3.131 GetVarBool
- 3.132 GetVarColor
- 3.133 GetVarFloat
- 3.134 GetVariableUpdateRate
- 3.135 GetVarInt
- 3.136 GetVarString
- 3.137 GetVarVector2f
- 3.138 GetVarVector3f
- 3.139 GetVoiceAttachNode
- 3.140 GiveDamage
- 3.141 HasActiveGui
- 3.142 HasAttachedProp
- 3.143 HasCollideCallbacks
- 3.144 HasPlayerInteractCallback
- 3.145 HasPlayerInteractLeaveCallback
- 3.146 HasPlayerLookAtCallback
- 3.147 IncVarFloat
- 3.148 IncVarInt
- 3.149 IncVarVector2f
- 3.150 IncVarVector3f
- 3.151 IsActive
- 3.152 IsEffectsFading
- 3.153 IsGuiActive
- 3.154 IsGuiFocused
- 3.155 IsInteractedWith
- 3.156 IsLookedAtByPlayer
- 3.157 IsMoving
- 3.158 IsOccluder
- 3.159 IsSleeping
- 3.160 MoveAngularTo
- 3.161 MoveLinearTo
- 3.162 OnInteract
- 3.163 PlayAnimation
- 3.164 PlaySound
- 3.165 PostUpdate
- 3.166 PreloadEntityModel
- 3.167 RemoveAllConnections
- 3.168 RemoveAllInteractConnections
- 3.169 RemoveAttachedProp
- 3.170 RemoveCollideCallback
- 3.171 RemoveConnection
- 3.172 RemoveEntityAttachment
- 3.173 RemoveInteractConnection
- 3.174 RotateAtSpeed
- 3.175 RunPlayerInteractLeaveCallback
- 3.176 ScriptExecute
- 3.177 ScriptMethodExists
- 3.178 ScriptMethodExistsFast
- 3.179 ScriptPrepare
- 3.180 ScriptPrepareFast
- 3.181 SetActive
- 3.182 SetAllowMapTransfer
- 3.183 SetAnimationCallbackActive
- 3.184 SetAnimationMessageEventCallback
- 3.185 SetArgBool
- 3.186 SetArgFloat
- 3.187 SetArgInt
- 3.188 SetArgString
- 3.189 SetAttachmentParent
- 3.190 SetAutoSleep
- 3.191 SetConnectionStateChangeCallback
- 3.192 SetCurrentAnimationPaused
- 3.193 SetCustomEffectsOffAlpha
- 3.194 SetCustomMaterial
- 3.195 SetCustomMesh
- 3.196 SetDisableCollisionUntilOutSidePlayer
- 3.197 SetEffectBaseColor
- 3.198 SetEffectsActive
- 3.199 SetEffectsOffTime
- 3.200 SetEffectsOnTime
- 3.201 SetEventInstanceTag
- 3.202 SetForceLookAtCheck
- 3.203 SetFullGameSave
- 3.204 SetGuiActive
- 3.205 SetGuiCacheAtScreenSize
- 3.206 SetGuiIsFocused
- 3.207 SetGuiMaxUpdateDistance
- 3.208 SetGuiSetUseInput
- 3.209 SetGuiSetUseSetGuiUnlockFPSInput
- 3.210 SetGuiUpdateWhenOutOfView
- 3.211 SetGuiVariableFPS
- 3.212 SetHealth
- 3.213 SetIgnoreDynamicAvoidance
- 3.214 SetIlluminationBaseColor
- 3.215 SetInteractionDisabled
- 3.216 SetIsBreakable
- 3.217 SetIsClosedDoor
- 3.218 SetIsDoor
- 3.219 SetIsInteractedWith
- 3.220 SetIsOccluder
- 3.221 SetLiquidAmount
- 3.222 SetLookAtCheckCenterOfScreen
- 3.223 SetLookAtCheckRayIntersection
- 3.224 SetLookAtMaxDistance
- 3.225 SetMatrix
- 3.226 SetMaxInteractDistance
- 3.227 SetMeshScaleMul
- 3.228 SetNormalizeAnimationWeights
- 3.229 SetOnGuiFunction
- 3.230 SetPlayerInteractCallback
- 3.231 SetPlayerInteractLeaveCallback
- 3.232 SetPlayerLookAtCallback
- 3.233 SetPosition
- 3.234 SetRecieveMessageCallback
- 3.235 SetRenderLayer
- 3.236 SetSaveDataIsUpdated
- 3.237 SetScriptableIsSaved
- 3.238 SetScriptCollisionCallbackActive
- 3.239 SetStaticPhysics
- 3.240 SetupParent
- 3.241 SetupRootBoneMotion
- 3.242 SetVarBool
- 3.243 SetVarColor
- 3.244 SetVarFloat
- 3.245 SetVariableUpdateRate
- 3.246 SetVarInt
- 3.247 SetVarString
- 3.248 SetVarVector2f
- 3.249 SetVarVector3f
- 3.250 Sleep
- 3.251 StopAllAnimations
- 3.252 StopAnimation
- 3.253 StopAnimation
- 3.254 StopEffectBaseColorFade
- 3.255 StopMove
- 3.256 Timer_Add
- 3.257 Timer_Add
- 3.258 Timer_ClearAll
- 3.259 Timer_Exists
- 3.260 Timer_Exists
- 3.261 Timer_GetTimeLeft
- 3.262 Timer_GetTimeLeft
- 3.263 Timer_GetValue
- 3.264 Timer_GetValue
- 3.265 Timer_Remove
- 3.266 Timer_Remove
- 3.267 Timer_SetPaused
- 3.268 Timer_SetPaused
- 3.269 Timer_TimeHasPassed
- 3.270 Timer_TimeHasPassed
- 3.271 Update
- 3.272 UpdateEntityAttachment
- 3.273 UpdateInteractConnectionLeader
- 3.274 VariableUpdate
- 3.275 WakeUp
- 4 References
Fields
cLuxProp has no public fields.
Functions
Return Type | Function And Description |
---|---|
void | AddAndAttachProp(const tString &in asName, const tString &in asFileName, const cMatrixf &in a_mtxOffset) |
void | AddCollideCallback(iLuxEntity@ apEntity, const tString &in asCallbackFunc, bool abAddedFromScript = true) |
void | AddConnection(const tString &in asName, iLuxEntity@ apEntity, bool abInvertStateSent, int alStatesUsed) |
void | AddInteractConnection(const tString &in asName, cLuxProp@ apProp, bool abInvert, eEasing aEasing = eEasing_Linear) |
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 | Break() |
void | BroadcastMessage(int alMessageId, iLuxEntityComponent@ apSource, const cVector3f &in avData, int alData) |
cVector3f | CalculateRootMotion() |
bool | CanInteract(int alType, iPhysicsBody@ apBody) |
void | ChangeConnectionState(int alState) |
void | ChangeInteractConnectionState(float afT) |
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() |
void | CreateAndSetupGui(tString asSubmesh, const cColor &in aColorMul, const cColor &in aClearColor, const cColor &in aOfflineClearColor, const cVector2f &in avScreenSize) |
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) |
bool | DestroyAttachedProp(const tString &in asName) |
void | DisableSubMeshMerge(tString asSubmesh) |
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 | EnableBodyCollisionCallback() |
void | EnableCharCollisionUntilStopped() |
void | FadeEffectBaseColor(const cColor &in aDestColor, float afTime) |
void | FadeInMeshEntity(float afTime) |
void | FadeLiquidAmountTo(float afTargetAmount, 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) |
void | ForceGuiCacheUpdate() |
bool | GetAllowMapTransfer() |
bool | GetAnimationIsPlaying() |
iEntity3D | GetAttachEntity() |
cLuxProp | GetAttachmentParent() |
bool | GetAutoSleep() |
cMaterial | GetBaseMaterial() |
cMatrixf | GetBaseMatrix() |
cVector3f | GetBasePosition() |
cBillboard | GetBillboard(int alIdx) |
cBillboard | GetBillboardFromName(const tString &in asName) |
int | GetBillboardNum() |
iPhysicsBody | GetBody(int alIdx) |
cEntityBodyExtraData | GetBodyExtraData(int alIdx) |
iPhysicsBody | GetBodyFromID(int alID) |
iPhysicsBody | GetBodyFromName(const tString &in asName) |
int | GetBodyIndexFromName(const tString &in asName) |
int | GetBodyNum() |
bool | GetBreakActive() |
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() |
float | GetGuiMaxUpdateDistance() |
cLuxGuiSet | GetGuiSet() |
bool | GetGuiSetUseInput() |
float | GetGuiVariableFPS() |
float | GetHealth() |
tID | GetID() |
bool | GetIgnoreDynamicAvoidance() |
int | GetInteractConnectionNum() |
int | GetInteractIconId(int alType, iPhysicsBody@ apBody) |
bool | GetInteractionDisabled() |
bool | GetIsBreakable() |
bool | GetIsClosedDoor() |
bool | GetIsDoor() |
iPhysicsJoint | GetJoint(int alIdx) |
int | GetJointNum() |
bool | GetLastCreatedSoundIsPlaying() |
float | GetLastInteractConnectionState() |
cLensFlare | GetLensFlareFromName(const tString &in asName) |
iLight | GetLight(int alIdx) |
iLight | GetLightFromName(const tString &in asName) |
void | GetLightLevelAtPos(const tString &in asCallbackFunc, const cVector3f &in avPos, iLight@ apSkipLight, float afRadiusAdd) |
int | GetLightNum() |
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() |
int | GetParicleSystemNum() |
cParticleSystem | GetParticleSystem(int alIdx) |
cParticleSystem | GetParticleSystemFromName(const tString &in asName) |
cVector3f | GetPosition() |
int | GetRenderLayer() |
bool | GetReturnBool() |
float | GetReturnFloat() |
int | GetReturnInt() |
tString | GetReturnString() |
bool | GetSaveDataIsUpdated() |
bool | GetScriptableIsSaved() |
bool | GetScriptCollisionCallbackActive() |
cSoundEntity | GetSoundEntity(int alIdx) |
cSoundEntity | GetSoundEntityFromName(const tString &in asName) |
int | GetSoundEntityNum() |
bool | GetStaticPhysics() |
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 | HasActiveGui() |
bool | HasAttachedProp() |
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 | IsGuiActive() |
bool | IsGuiFocused() |
bool | IsInteractedWith() |
bool | IsLookedAtByPlayer() |
bool | IsMoving() |
bool | IsOccluder() |
bool | IsSleeping() |
void | MoveAngularTo(const cMatrixf &in a_mtxGoal, float afAcc, float afMaxSpeed, float afSlowdownDist, bool abResetSpeed, bool abUseOffset, const cVector3f &in avWorldOffset, const cVector3f &in avLocalOffset, const tString &in asCallback = "") |
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 | RemoveAllInteractConnections() |
bool | RemoveAttachedProp(cLuxProp@ apProp) |
void | RemoveCollideCallback(const tString &in asEntityName) |
void | RemoveConnection(const tString &in asName) |
void | RemoveEntityAttachment() |
void | RemoveInteractConnection(const tString &in asName) |
void | RotateAtSpeed(float afAcc, float afGoalSpeed, const cVector3f &in avAxis, bool abResetSpeed, bool abUseOffset, const cVector3f &in avWorldOffset, const cVector3f &in avLocalOffset) |
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 | SetAllowMapTransfer(bool ) |
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 | SetAttachmentParent(cLuxProp@ apProp) |
void | SetAutoSleep(bool abX) |
void | SetConnectionStateChangeCallback(const tString &in asCallbackFunc) |
void | SetCurrentAnimationPaused(bool abX) |
void | SetCustomEffectsOffAlpha(float afAlpha) |
void | SetCustomMaterial(const tString &in asMaterial, const tString &in asSubmesh, bool abPreload = true) |
void | SetCustomMesh(const tString &in asMesh, const tString &in asSubmesh, const tString &in asDstSubmesh) |
void | SetDisableCollisionUntilOutSidePlayer(bool abX) |
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 | SetGuiActive(bool abX, float afFadeTime = 0.0f) |
void | SetGuiCacheAtScreenSize(float afX) |
bool | SetGuiIsFocused(bool abX, bool abShowMouse = true) |
void | SetGuiMaxUpdateDistance(float afX) |
void | SetGuiSetUseInput(bool ) |
void | SetGuiSetUseSetGuiUnlockFPSInput(bool ) |
void | SetGuiUpdateWhenOutOfView(bool abX) |
void | SetGuiVariableFPS(float afX) |
void | SetHealth(float afX) |
void | SetIgnoreDynamicAvoidance(bool abX) |
void | SetIlluminationBaseColor(const cColor &in aColor) |
void | SetInteractionDisabled(bool abX) |
void | SetIsBreakable(bool abX) |
void | SetIsClosedDoor(bool abX) |
void | SetIsDoor(bool abX) |
void | SetIsInteractedWith(bool abX) |
void | SetIsOccluder(bool abX) |
void | SetLiquidAmount(float afAmount) |
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 | SetOnGuiFunction(const tString &in asFunction) |
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 | SetRenderLayer(int alX) |
void | SetSaveDataIsUpdated(bool abX) |
void | SetScriptableIsSaved(bool abX) |
void | SetScriptCollisionCallbackActive(bool abX) |
void | SetStaticPhysics(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 | UpdateInteractConnectionLeader() |
void | VariableUpdate(float afDeltaTime) |
void | WakeUp() |
Details
AddAndAttachProp
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
AddInteractConnection
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
Break
void Break()
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
ChangeInteractConnectionState
void ChangeInteractConnectionState(float afT)
Parameters
- afT (float) —
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
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—
CreateAndSetupGui
void CreateAndSetupGui(tString asSubmesh,
const cColor &in aColorMul,
const cColor &in aClearColor,
const cColor &in aOfflineClearColor,
const cVector2f &in avScreenSize)
Parameters
- asSubmesh (tString) —
- aColorMul (cColor) —
- aClearColor (cColor) —
- aOfflineClearColor (cColor) —
- avScreenSize (cVector2f) —
Returns:
- void
CreateParticleSystem
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@—
DestroyAttachedProp
DisableSubMeshMerge
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
EnableBodyCollisionCallback
void EnableBodyCollisionCallback()
Returns:
- void
EnableCharCollisionUntilStopped
void EnableCharCollisionUntilStopped()
Returns:
- void
FadeEffectBaseColor
void FadeEffectBaseColor(const cColor &in aDestColor,
float afTime)
Parameters
- aDestColor (cColor) —
- afTime (float) —
Returns:
- void
FadeInMeshEntity
void FadeInMeshEntity(float afTime)
Parameters
- afTime (float) —
Returns:
- void
FadeLiquidAmountTo
void FadeLiquidAmountTo(float afTargetAmount,
float afTime)
Parameters
- afTargetAmount (float) —
- afTime (float) —
Returns:
- void
FadeMeshScaleMul
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
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
ForceGuiCacheUpdate
void ForceGuiCacheUpdate()
Returns:
- void
GetAllowMapTransfer
bool GetAllowMapTransfer()
Returns:
- bool—
GetAnimationIsPlaying
bool GetAnimationIsPlaying()
Returns:
- bool—
GetAttachEntity
iEntity3D@ GetAttachEntity()
Returns:
- iEntity3D@—
GetAttachmentParent
cLuxProp@ GetAttachmentParent()
Returns:
- cLuxProp@—
GetAutoSleep
bool GetAutoSleep()
Returns:
- bool—
GetBaseMaterial
cMaterial@ GetBaseMaterial()
Returns:
- cMaterial@—
GetBaseMatrix
cMatrixf GetBaseMatrix()
Returns:
- cMatrixf—
GetBasePosition
cVector3f GetBasePosition()
Returns:
- cVector3f—
GetBillboard
cBillboard@ GetBillboard(int alIdx)
Parameters
- alIdx (int) —
Returns:
- cBillboard@—
GetBillboardFromName
cBillboard@ GetBillboardFromName(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cBillboard@—
GetBillboardNum
int GetBillboardNum()
Returns:
- int—
GetBody
iPhysicsBody@ GetBody(int alIdx)
Parameters
- alIdx (int) —
Returns:
- iPhysicsBody@—
GetBodyExtraData
cEntityBodyExtraData@ GetBodyExtraData(int alIdx)
Parameters
- alIdx (int) —
Returns:
- cEntityBodyExtraData@—
GetBodyFromID
iPhysicsBody@ GetBodyFromID(int alID)
Parameters
- alID (int) —
Returns:
- iPhysicsBody@—
GetBodyFromName
iPhysicsBody@ GetBodyFromName(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- iPhysicsBody@—
GetBodyIndexFromName
GetBodyNum
int GetBodyNum()
Returns:
- int—
GetBreakActive
bool GetBreakActive()
Returns:
- bool—
GetClassName
const tString& GetClassName()
Returns:
- const tString&—
GetClosestBody
GetClosestCharCollideBody
GetClosestCharCollider
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—
GetGuiMaxUpdateDistance
float GetGuiMaxUpdateDistance()
Returns:
- float—
GetGuiSet
cLuxGuiSet@ GetGuiSet()
Returns:
- cLuxGuiSet@—
GetGuiSetUseInput
bool GetGuiSetUseInput()
Returns:
- bool—
GetGuiVariableFPS
float GetGuiVariableFPS()
Returns:
- float—
GetHealth
float GetHealth()
Returns:
- float—
GetID
const tID& GetID()
Returns:
- const tID&—
GetIgnoreDynamicAvoidance
bool GetIgnoreDynamicAvoidance()
Returns:
- bool—
GetInteractConnectionNum
int GetInteractConnectionNum()
Returns:
- int—
GetInteractIconId
int GetInteractIconId(int alType,
iPhysicsBody@ apBody)
Parameters
- alType (int) —
- apBody (iPhysicsBody@) —
Returns:
- int—
GetInteractionDisabled
bool GetInteractionDisabled()
Returns:
- bool—
GetIsBreakable
bool GetIsBreakable()
Returns:
- bool—
GetIsClosedDoor
bool GetIsClosedDoor()
Returns:
- bool—
GetIsDoor
bool GetIsDoor()
Returns:
- bool—
GetJoint
iPhysicsJoint@ GetJoint(int alIdx)
Parameters
- alIdx (int) —
Returns:
- iPhysicsJoint@—
GetJointNum
int GetJointNum()
Returns:
- int—
GetLastCreatedSoundIsPlaying
bool GetLastCreatedSoundIsPlaying()
Returns:
- bool—
GetLastInteractConnectionState
float GetLastInteractConnectionState()
Returns:
- float—
GetLensFlareFromName
cLensFlare@ GetLensFlareFromName(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cLensFlare@—
GetLight
iLight@ GetLight(int alIdx)
Parameters
- alIdx (int) —
Returns:
- iLight@—
GetLightFromName
GetLightLevelAtPos
GetLightNum
int GetLightNum()
Returns:
- int—
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—
GetParicleSystemNum
int GetParicleSystemNum()
Returns:
- int—
GetParticleSystem
cParticleSystem@ GetParticleSystem(int alIdx)
Parameters
- alIdx (int) —
Returns:
- cParticleSystem@—
GetParticleSystemFromName
cParticleSystem@ GetParticleSystemFromName(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cParticleSystem@—
GetPosition
cVector3f GetPosition()
Returns:
- cVector3f—
GetRenderLayer
int GetRenderLayer()
Returns:
- int—
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—
GetScriptCollisionCallbackActive
bool GetScriptCollisionCallbackActive()
Returns:
- bool—
GetSoundEntity
cSoundEntity@ GetSoundEntity(int alIdx)
Parameters
- alIdx (int) —
Returns:
- cSoundEntity@—
GetSoundEntityFromName
cSoundEntity@ GetSoundEntityFromName(const tString &in asName)
Parameters
- asName (tString) —
Returns:
- cSoundEntity@—
GetSoundEntityNum
int GetSoundEntityNum()
Returns:
- int—
GetStaticPhysics
bool GetStaticPhysics()
Returns:
- bool—
GetVarBool
GetVarColor
GetVarFloat
GetVariableUpdateRate
float GetVariableUpdateRate()
Returns:
- float—
GetVarInt
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—
HasActiveGui
bool HasActiveGui()
Returns:
- bool—
HasAttachedProp
bool HasAttachedProp()
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
IncVarVector3f
IsActive
bool IsActive()
Returns:
- bool—
IsEffectsFading
bool IsEffectsFading()
Returns:
- bool—
IsGuiActive
bool IsGuiActive()
Returns:
- bool—
IsGuiFocused
bool IsGuiFocused()
Returns:
- bool—
IsInteractedWith
bool IsInteractedWith()
Returns:
- bool—
IsLookedAtByPlayer
bool IsLookedAtByPlayer()
Returns:
- bool—
IsMoving
bool IsMoving()
Returns:
- bool—
IsOccluder
bool IsOccluder()
Returns:
- bool—
IsSleeping
bool IsSleeping()
Returns:
- bool—
MoveAngularTo
void MoveAngularTo(const cMatrixf &in a_mtxGoal,
float afAcc,
float afMaxSpeed,
float afSlowdownDist,
bool abResetSpeed,
bool abUseOffset,
const cVector3f &in avWorldOffset,
const cVector3f &in avLocalOffset,
const tString &in asCallback = "")
Parameters
- a_mtxGoal (cMatrixf) —
- afAcc (float) —
- afMaxSpeed (float) —
- afSlowdownDist (float) —
- abResetSpeed (bool) —
- abUseOffset (bool) —
- avWorldOffset (cVector3f) —
- avLocalOffset (cVector3f) —
- asCallback (tString) —
Returns:
- void
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
RemoveAllConnections
void RemoveAllConnections()
Returns:
- void
RemoveAllInteractConnections
void RemoveAllInteractConnections()
Returns:
- void
RemoveAttachedProp
RemoveCollideCallback
void RemoveCollideCallback(const tString &in asEntityName)
Parameters
- asEntityName (tString) —
Returns:
- void
RemoveConnection
RemoveEntityAttachment
void RemoveEntityAttachment()
Returns:
- void
RemoveInteractConnection
RotateAtSpeed
void RotateAtSpeed(float afAcc,
float afGoalSpeed,
const cVector3f &in avAxis,
bool abResetSpeed,
bool abUseOffset,
const cVector3f &in avWorldOffset,
const cVector3f &in avLocalOffset)
Parameters
- afAcc (float) —
- afGoalSpeed (float) —
- avAxis (cVector3f) —
- abResetSpeed (bool) —
- abUseOffset (bool) —
- avWorldOffset (cVector3f) —
- avLocalOffset (cVector3f) —
Returns:
- void
RunPlayerInteractLeaveCallback
void RunPlayerInteractLeaveCallback()
Returns:
- void
ScriptExecute
bool ScriptExecute()
Returns:
- bool—
ScriptMethodExists
ScriptMethodExistsFast
bool ScriptMethodExistsFast(const tString &in asMethod,
int alId)
Parameters
- asMethod (tString) —
- alId (int) —
Returns:
- bool—
ScriptPrepare
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
SetAllowMapTransfer
void SetAllowMapTransfer(bool )
Parameters
- ' (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
SetAttachmentParent
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
SetCustomMaterial
SetCustomMesh
SetDisableCollisionUntilOutSidePlayer
void SetDisableCollisionUntilOutSidePlayer(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetEffectBaseColor
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
SetForceLookAtCheck
void SetForceLookAtCheck(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetFullGameSave
void SetFullGameSave(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetGuiActive
void SetGuiActive(bool abX,
float afFadeTime = 0.0f)
Parameters
- abX (bool) —
- afFadeTime (float) —
Returns:
- void
SetGuiCacheAtScreenSize
void SetGuiCacheAtScreenSize(float afX)
Parameters
- afX (float) —
Returns:
- void
SetGuiIsFocused
bool SetGuiIsFocused(bool abX,
bool abShowMouse = true)
Parameters
- abX (bool) —
- abShowMouse (bool) —
Returns:
- bool—
SetGuiMaxUpdateDistance
void SetGuiMaxUpdateDistance(float afX)
Parameters
- afX (float) —
Returns:
- void
SetGuiSetUseInput
void SetGuiSetUseInput(bool )
Parameters
- ' (bool) —
Returns:
- void
SetGuiSetUseSetGuiUnlockFPSInput
void SetGuiSetUseSetGuiUnlockFPSInput(bool )
Parameters
- ' (bool) —
Returns:
- void
SetGuiUpdateWhenOutOfView
void SetGuiUpdateWhenOutOfView(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetGuiVariableFPS
void SetGuiVariableFPS(float afX)
Parameters
- afX (float) —
Returns:
- void
SetHealth
void SetHealth(float afX)
Parameters
- afX (float) —
Returns:
- void
SetIgnoreDynamicAvoidance
void SetIgnoreDynamicAvoidance(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetIlluminationBaseColor
SetInteractionDisabled
void SetInteractionDisabled(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetIsBreakable
void SetIsBreakable(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
SetLiquidAmount
void SetLiquidAmount(float afAmount)
Parameters
- afAmount (float) —
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
SetNormalizeAnimationWeights
void SetNormalizeAnimationWeights(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetOnGuiFunction
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
SetRecieveMessageCallback
void SetRecieveMessageCallback(const tString &in asCallbackFunc)
Parameters
- asCallbackFunc (tString) —
Returns:
- void
SetRenderLayer
void SetRenderLayer(int alX)
Parameters
- alX (int) —
Returns:
- void
SetSaveDataIsUpdated
void SetSaveDataIsUpdated(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetScriptableIsSaved
void SetScriptableIsSaved(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetScriptCollisionCallbackActive
void SetScriptCollisionCallbackActive(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetStaticPhysics
void SetStaticPhysics(bool abX)
Parameters
- abX (bool) —
Returns:
- void
SetupParent
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
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
SetVarVector2f
SetVarVector3f
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
Timer_ClearAll
void Timer_ClearAll()
Returns:
- void
Timer_Exists
bool Timer_Exists(uint64 alID)
Parameters
- alID (uint64) —
Returns:
- bool—
Timer_Exists
Timer_GetTimeLeft
float Timer_GetTimeLeft(uint64 alID)
Parameters
- alID (uint64) —
Returns:
- float—
Timer_GetTimeLeft
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
Timer_Remove
void Timer_Remove(uint64 alID)
Parameters
- alID (uint64) —
Returns:
- void
Timer_Remove
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
UpdateInteractConnectionLeader
void UpdateInteractConnectionLeader()
Returns:
- void
VariableUpdate
void VariableUpdate(float afDeltaTime)
Parameters
- afDeltaTime (float) —
Returns:
- void
WakeUp
void WakeUp()
Returns:
- void