Maintenance script: Upload classes to sub

2020-07-30T09:12:10Z

Upload classes to sub

New page

==cLuxCritter==

===Fields===

{| class="wikitable sortable" border=1
! Field Name !! Type !! Description
|-
| mvWantedVel || [[cVector3f]] ||
|-
| mvGravityVel || [[cVector3f]] ||
|-
| mvGroundNormal || [[cVector3f]] ||
|-
| mvWallAvoidNormal || [[cVector3f]] ||
|-
| mvWallAvoidPosition || [[cVector3f]] ||
|-
| mbWallAvoidDetected || bool ||
|-
| mlAnimState || int ||
|-
| msMoveAnim || [[tString]] ||
|-
| msIdleAnim || [[tString]] ||
|-
| mfMaxVelocity || float ||
|-
| mfMaxGravityVelocity || float ||
|-
| mfTurnSpeedMul || float ||
|-
| mfMaxTurnSpeed || float ||
|-
| mfForwardRotationYOffset || float ||
|-
|}

===Functions===

{| class="wikitable sortable" border=1
! Return Type !! Function Name !! Parameters !! Description
|-
| const [[tString]]& || GetName || ||
|-
| const [[tID]]& || GetID || ||
|-
| [[eLuxEntityType]] || GetEntityType || ||
|-
| const [[tString]]& || GetClassName || ||
|-
| void || SetActive || bool abX ||
|-
| bool || IsActive || ||
|-
| const [[tString]]& || GetEventTag || ||
|-
| const [[tString]]& || GetEventInstanceTag || ||
|-
| void || SetEventInstanceTag || const [[tString]] &in asTag ||
|-
| [[cSoundEntity]]@ || PlaySound || const [[tString]] &in asName, const [[tString]] &in asFile, bool abRemoveWhenDone, bool abAttach ||
|-
| bool || GetLastCreatedSoundIsPlaying || ||
|-
| [[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 ||
|-
| int || PlayAnimation || const [[tString]] &in asName, ''float afFadeTime = 0.3f'', ''bool abLoop = false'', ''bool abPlayTransition = true'', ''const [[tString]] &in asCallback = ""'', ''bool abGlobalSpace = false'' ||
|-
| void || AppendAnimation || const [[tString]] &in asName, bool abLoop ||
|-
| bool || GetAnimationIsPlaying || ||
|-
| void || SetNormalizeAnimationWeights || bool abX ||
|-
| void || StopAllAnimations || float afFadeTime ||
|-
| void || StopAnimation || const [[tString]] &in asName, float afFadeTime ||
|-
| void || StopAnimation || int alIdx, float afFadeTime ||
|-
| void || SetCurrentAnimationPaused || bool abX ||
|-
| void || SetAnimationMessageEventCallback || const [[tString]] &in asFunc, bool abAutoRemove ||
|-
| int || GetCurrentAnimationIndex || ||
|-
| [[cAnimationState]]@ || GetCurrentAnimationState || ||
|-
| void || GiveDamage || float afAmount, int alStrength, const [[tString]] &in asType, const [[tString]] &in asSource ||
|-
| 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 || RemoveEntityAttachment || ||
|-
| void || SetFullGameSave || bool abX ||
|-
| bool || IsLookedAtByPlayer || ||
|-
| void || SetForceLookAtCheck || bool abX ||
|-
| bool || GetForceLookAtCheck || ||
|-
| void || PreloadEntityModel || const [[tString]]& asFile ||
|-
| bool || CollidesWithPlayer || ||
|-
| [[cLuxMap]]@ || GetMap || ||
|-
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform ||
|-
| void || SetPosition || const [[cVector3f]] &in avPos ||
|-
| [[cMatrixf]] || GetMatrix || ||
|-
| [[cVector3f]] || GetPosition || ||
|-
| int || GetBodyNum || ||
|-
| [[iPhysicsBody]]@ || GetBody || int alIdx ||
|-
| [[iPhysicsBody]]@ || GetBodyFromID || int alID ||
|-
| int || GetBodyIndexFromName || const [[tString]] &in asName ||
|-
| [[iPhysicsBody]]@ || GetBodyFromName || const [[tString]] &in asName ||
|-
| [[iPhysicsBody]]@ || GetMainBody || ||
|-
| void || SetMeshScaleMul || const [[cVector3f]] &in avScale ||
|-
| [[cVector3f]] || GetMeshScaleMul || ||
|-
| void || FadeMeshScaleMul || const [[cVector3f]] &in avDestScale, float afTime ||
|-
| [[cMeshEntity]]@ || GetMeshEntity || ||
|-
| [[cMaterial]]@ || GetBaseMaterial || ||
|-
| [[iEntity3D]]@ || GetAttachEntity || ||
|-
| [[cNode3D]]@ || GetVoiceAttachNode || ||
|-
| bool || CanInteract || int alType, [[iPhysicsBody]]@ apBody ||
|-
| bool || OnInteract || int alType, [[iPhysicsBody]]@ apBody, const [[cVector3f]]& avFocusPos, const [[tString]] &in asData ||
|-
| int || GetInteractIconId || int alType, [[iPhysicsBody]]@ apBody ||
|-
| void || SetIsInteractedWith || bool abX ||
|-
| bool || IsInteractedWith || ||
|-
| float || GetMaxInteractDistance || ||
|-
| void || SetMaxInteractDistance || float afX ||
|-
| void || SetInteractionDisabled || bool abX ||
|-
| bool || GetInteractionDisabled || ||
|-
| void || SetPlayerInteractCallback || const [[tString]]& asCallbackFunc, bool abRemoveWhenInteracted ||
|-
| void || SetPlayerLookAtCallback || const [[tString]]& asCallbackFunc, bool abRemoveWhenLookedAt, bool abCheckCenterOfScreen, bool abCheckRayIntersection, float afMaxDistance, float afCallbackDelay ||
|-
| void || SetRecieveMessageCallback || const [[tString]] &in asCallbackFunc ||
|-
| void || SetConnectionStateChangeCallback || const [[tString]]& asCallbackFunc ||
|-
| bool || HasPlayerInteractCallback || ||
|-
| bool || HasPlayerLookAtCallback || ||
|-
| void || SetupParent || int alTypeId, [[tID]] alId, const [[tString]]& asName ||
|-
| int || GetParentType || ||
|-
| [[tID]] || GetParentId || ||
|-
| const [[tString]]& || GetParentName || ||
|-
| void || ChangeConnectionState || int alState ||
|-
| void || AddConnection || const [[tString]] &in asName, [[iLuxEntity]]@ apEntity, bool abInvertStateSent, int alStatesUsed ||
|-
| void || RemoveConnection || const [[tString]] &in asName ||
|-
| void || RemoveAllConnections || ||
|-
| bool || CheckEntityCollision || [[iLuxEntity]]@ apEntity ||
|-
| bool || CheckBodyCollision || [[iPhysicsBody]]@ apBody, [[cLuxMap]]@ apMap ||
|-
| bool || CheckShapeCollision || [[iCollideShape]]@ apShape, const [[cMatrixf]]& a_mtxTransform, [[cLuxMap]]@ apMap ||
|-
| bool || CheckCharacterCollision || [[iCharacterBody]]@ apBody, [[cLuxMap]]@ apMap ||
|-
| bool || HasCollideCallbacks || ||
|-
| void || AddCollideCallback || [[iLuxEntity]]@ apEntity, const [[tString]] &in asCallbackFunc ||
|-
| void || RemoveCollideCallback || const [[tString]] &in asEntityName ||
|-
| bool || ScriptPrepare || const [[tString]] &in asMethod ||
|-
| bool || ScriptPrepareFast || const [[tString]] &in asMethod, int alId ||
|-
| bool || ScriptExecute || ||
|-
| bool || ScriptMethodExists || const [[tString]] &in asMethod ||
|-
| bool || ScriptMethodExistsFast || const [[tString]] &in asMethod, int alId ||
|-
| void || SetArgBool || int alArgNum, bool abVal ||
|-
| void || SetArgInt || int alArg, int alX ||
|-
| void || SetArgFloat || int alArg, float afX ||
|-
| void || SetArgString || int alArg, const [[tString]]& asStr ||
|-
| bool || GetReturnBool || ||
|-
| int || GetReturnInt || ||
|-
| float || GetReturnFloat || ||
|-
| [[tString]] || GetReturnString || ||
|-
| void || BroadcastMessage || int alMessageId, [[iLuxEntityComponent]]@ apSource, const [[cVector3f]]& avData, int alData ||
|-
| void || SetEffectBaseColor || const [[cColor]] &in aColor ||
|-
| const [[cColor]]& || GetEffectBaseColor || ||
|-
| void || FadeEffectBaseColor || const [[cColor]]& aDestColor, float afTime ||
|-
| void || SetEffectsActive || bool abActive, bool abFadeAndPlaySounds ||
|-
| bool || GetEffectsActive || ||
|-
| float || GetEffectsAlpha || ||
|-
| const [[tString]]& || GetEffectsOnSound || ||
|-
| const [[tString]]& || GetEffectsOffSound || ||
|-
| float || GetEffectsOnTime || ||
|-
| float || GetEffectsOffTime || ||
|-
| void || SetVarString || const [[tString]] &in asName, const [[tString]] &in asX ||
|-
| void || SetVarBool || const [[tString]] &in asName, bool abX ||
|-
| void || SetVarInt || const [[tString]] &in asName, int alX ||
|-
| void || SetVarFloat || const [[tString]] &in asName, float afX ||
|-
| void || SetVarVector2f || const [[tString]] &in asName, const [[cVector2f]] &in avX ||
|-
| void || SetVarVector3f || const [[tString]] &in asName, const [[cVector3f]] &in avX ||
|-
| void || SetVarColor || const [[tString]] &in asName, const [[cColor]] &in aX ||
|-
| void || IncVarInt || const [[tString]] &in asName, int alX ||
|-
| void || IncVarFloat || const [[tString]] &in asName, float afX ||
|-
| void || IncVarVector2f || const [[tString]] &in asName, const [[cVector2f]] &in avX ||
|-
| void || IncVarVector3f || const [[tString]] &in asName, const [[cVector3f]] &in avX ||
|-
| const [[tString]]& || GetVarString || const [[tString]] &in asName ||
|-
| bool || GetVarBool || const [[tString]] &in asName ||
|-
| int || GetVarInt || const [[tString]] &in asName ||
|-
| float || GetVarFloat || const [[tString]] &in asName ||
|-
| [[cVector2f]] || GetVarVector2f || const [[tString]] &in asName ||
|-
| [[cVector3f]] || GetVarVector3f || const [[tString]] &in asName ||
|-
| [[cColor]] || GetVarColor || const [[tString]] &in asName ||
|-
| bool || CheckIsOnScreen || bool abUseRayCast ||
|-
| const [[tString]]& || GetFileName || ||
|-
| const [[cVector3f]]& || GetOnLoadScale || ||
|-
| const [[cMatrixf]]& || GetOnLoadTransform || ||
|-
| [[iLight]]@ || GetLightFromName || const [[tString]] &in asName ||
|-
| [[cParticleSystem]]@ || GetParticleSystemFromName || const [[tString]] &in asName ||
|-
| [[cBillboard]]@ || GetBillboardFromName || const [[tString]] &in asName ||
|-
| [[cSoundEntity]]@ || GetSoundEntityFromName || const [[tString]] &in asName ||
|-
| [[cLensFlare]]@ || GetLensFlareFromName || const [[tString]] &in asName ||
|-
| bool || IsOccluder || ||
|-
| void || SetIsOccluder || bool abX ||
|-
| void || Sleep || ||
|-
| void || WakeUp || ||
|-
| void || SetAutoSleep || bool abX ||
|-
| bool || GetAutoSleep || ||
|-
| bool || IsSleeping || ||
|-
| float || GetVariableUpdateRate || ||
|-
| void || SetVariableUpdateRate || float afX ||
|-
| void || GetClosestEntity || const [[tString]] &in asCallbackFunc, const [[cVector3f]] &in avStart, const [[cVector3f]] &in avDir, float afRayLength, int alInteractType, bool abCheckLineOfSight ||
|-
| void || GetClosestBody || const [[tString]] &in asCallbackFunc, const [[cVector3f]] &in avStart, const [[cVector3f]] &in avDir, float afRayLength ||
|-
| void || GetClosestCharCollider || const [[tString]] &in asCallbackFunc, const [[cVector3f]] &in avStart, const [[cVector3f]] &in avDir, float afRayLength, bool abCheckDynamic ||
|-
| void || GetLightLevelAtPos || const [[tString]] &in asCallbackFunc, const [[cVector3f]] &in avPos, [[iLight]]@ apSkipLight, float afRadiusAdd ||
|-
| 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 || SetScriptableIsSaved || bool abX ||
|-
| bool || GetScriptableIsSaved || ||
|-
| void || SetIsDoor || bool abX ||
|-
| bool || GetIsDoor || ||
|-
| void || SetIsClosedDoor || bool abX ||
|-
| bool || GetIsClosedDoor || ||
|-
| void || UpdateEntityAttachment || ||
|-
| void || Update || float afTimeStep ||
|-
| void || PostUpdate || float afTimeStep ||
|-
| void || VariableUpdate || float afDeltaTime ||
|-
| bool || GetSaveDataIsUpdated || ||
|-
| void || SetSaveDataIsUpdated || bool abX ||
|-
| void || Timer_ClearAll || ||
|-
| void || Timer_Add || uint64 alID, float afTime, ''const [[tString]] &in asFunc = ""'', ''bool abCreateIfExist = true'', ''bool abRepeat = false'' ||
|-
| void || Timer_Remove || uint64 alID ||
|-
| bool || Timer_Exists || uint64 alID ||
|-
| float || Timer_GetTimeLeft || uint64 alID ||
|-
| void || Timer_SetPaused || uint64 alID, bool abX ||
|-
| bool || Timer_TimeHasPassed || uint64 alID, float afLength ||
|-
| float || Timer_GetValue || uint64 alID, ''float afMin = 0'', ''float afMax = 1'', ''[[eEasing]] aEasing = eEasing_Linear'', ''bool abAbsValue = false'' ||
|-
| void || Timer_Add || const [[tString]] &in asID, float afTime, ''const [[tString]] &in asFunc = ""'', ''bool abCreateIfExist = true'', ''bool abRepeat = false'' ||
|-
| void || Timer_Remove || const [[tString]] &in asID ||
|-
| bool || Timer_Exists || const [[tString]] &in asID ||
|-
| float || Timer_GetTimeLeft || const [[tString]] &in asID ||
|-
| void || Timer_SetPaused || const [[tString]] &in asID, bool abX ||
|-
| bool || Timer_TimeHasPassed || const [[tString]] &in asID, float afLength ||
|-
| float || Timer_GetValue || const [[tString]] &in asID, ''float afMin = 0'', ''float afMax = 1'', ''[[eEasing]] aEasing = eEasing_Linear'', ''bool abAbsValue = false'' ||
|-
| void || Fader_ClearAll || ||
|-
| void || Fader_FadeTo || uint alID, float afGoal, float afTime, ''bool abReverseAtEnd = false'', ''bool abSkipIfExists = false'' ||
|-
| void || Fader_Set || uint alID, float afX, ''bool abSkipIfExists = false'' ||
|-
| void || Fader_SetPaused || uint alID, bool abPaused ||
|-
| float || Fader_GetValue || uint alID, ''float afMin = 0'', ''float afMax = 1'', ''[[eEasing]] aEasing = eEasing_Linear'', ''bool abAbsValue = false'' ||
|-
| void || Fader_FadeTo || const [[tString]] &in asName, float afGoal, float afTime, ''bool abReverseAtEnd = false'', ''bool abSkipIfExists = false'' ||
|-
| void || Fader_Set || const [[tString]] &in asName, float afX, ''bool abSkipIfExists = false'' ||
|-
| void || Fader_SetPaused || const [[tString]] &in asName, bool abPaused ||
|-
| float || Fader_GetValue || const [[tString]] &in asName, ''float afMin = 0'', ''float afMax = 1'', ''[[eEasing]] aEasing = eEasing_Linear'', ''bool abAbsValue = false'' ||
|-
| float || GetDistanceToPlayer || ||
|-
| float || GetDistanceToPlayer2D || ||
|-
| float || GetDistanceToPos || const [[cVector3f]] &in avPos ||
|-
| float || GetDistanceToPos2D || const [[cVector3f]] &in avPos ||
|-
| const [[cVector3f]]& || GetPlayerPos || ||
|-
| [[cVector3f]] || GetPlayerFeetPos || ||
|-
| [[cVector3f]] || GetPlayerHeadPos || ||
|-
| bool || GetPointIsInFOV || const [[cVector3f]] &in avPoint, float afFOV, const [[cVector3f]]& avForward ||
|-
| bool || GetPlayerIsInFOV || float afFOV, const [[cVector3f]]& avForward ||
|-
| bool || GetEntityIsInPlayerFOV || ||
|-
| bool || GetPlayerIsInLineOfSight || float afFOV, const [[cVector3f]]& avForward, bool abCheckFOV ||
|-
| bool || GetPlayerIsInLineOfSight || ||
|-
| float || GetPlayerMovementTowardEntity || ||
|-
| float || GetAngleToPos2D || const [[cVector3f]] &in avPos ||
|-
| float || GetAngleToPos3D || const [[cVector3f]] &in avPos ||
|-
| float || GetAngleToPlayer2D || ||
|-
| float || GetAngleToPlayer3D || ||
|-
| bool || GetEntityIsInPlayerLineOfSight || bool abCheckFOV ||
|-
| float || GetDistanceToGround || float afMaxTestDistance, bool abCheckDynamic, ''int alNumOfRays = 1'', ''float afRadius = 0.25'', ''bool abGetShortest = true'' ||
|-
| void || GetPlayerIsInLineOfSight || const [[tString]] &in asCallbackFunc, float afFOV, const [[cVector3f]]& avForward, bool abCheckFOV ||
|-
| void || GetPlayerIsInLineOfSight || const [[tString]] &in asCallbackFunc ||
|-
| void || GetEntityIsInPlayerLineOfSight || const [[tString]] &in asCallbackFunc, bool abCheckFOV ||
|-
| void || GetDistanceToGround || const [[tString]] &in asCallbackFunc, float afMaxTestDistance, bool abCheckDynamic, ''int alNumOfRays = 1'', ''float afRadius = 0.25'', ''bool abGetClosest = true'' ||
|-
| void || DoDamageBox || const [[cVector3f]] &in avSize, const [[cVector3f]] &in avLocalOffset, const [[cVector2f]] &in avMinMaxDamage, float afForce, float afMaxImpulse, int aDamageType, ''float afHitSpeed = 2'', ''int alStrength = 0'', ''bool abCheckAgents = false'', ''bool abCheckPlayer = true'', ''bool abCheckProps = true'', ''bool abLethalForPlayer = true'' ||
|-
| void || SetRelativeEyeHeight || float afX ||
|-
| float || GetRelativeEyeHeight || ||
|-
| [[cVector3f]] || GetEyePostion || ||
|-
| int || GetDebugEyeRaysNum || ||
|-
| const [[cVector3f]]& || GetDebugEyeRay || int alIdx ||
|-
| void || SetHealth || float afX ||
|-
| float || GetHealth || ||
|-
| void || SetTestCollision || bool abX ||
|-
| bool || GetTestCollision || ||
|-
| void || SetUseRayCollision || bool abX ||
|-
| bool || GetUseRayCollision || ||
|-
| void || SetIsFlying || bool abX ||
|-
| bool || IsFlying || ||
|-
| void || SetCanRunOnWalls || bool abX ||
|-
| bool || GetCanRunOnWalls || ||
|-
| void || SetAlignToGround || bool abX ||
|-
| bool || GetAlignToGround || ||
|-
| void || SetGroup || const [[tString]] &in asEntityName ||
|-
| void || SetGroup || [[iLuxEntity]]@ apEntity ||
|-
| float || GetNotRenderedCount || ||
|-
| [[cVector3f]] || Move_GetWanderAdd2D || float afLength, float afRadius, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetWanderAdd3D || float afLength, float afRadius, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetTowardPlayerAdd || bool abNormalize, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetTowardPosAdd || const [[cVector3f]] &in avPos, bool abNormalize, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetTowardCenterAdd || float afTimeStep ||
|-
| [[cVector3f]] || Move_GetFlockingAdd || float afCenterMul, float afCenterYMul, float afSeparationMul, float afAlignmentMul, float afCohesionMul, int alMaxMemberChecks, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetTowardsGroundAdd || float afMaxHeight, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetWallAvoidAdd || float afDistanceForward, float afTimeStep ||
|-
| [[cVector3f]] || Move_GetStopAdd || float afAmount, float afTimeStep ||
|-
| void || Move_ChangeMaxSpeed || float afGoal, float afAcc, float afTimeStep ||
|-
| [[cVector3f]] || Move_Normalize || const [[cVector3f]]& avVec ||
|-
|}

===Remarks===

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

HPL3/Community/Scripting/Classes/cluxcritter - Revision history

Maintenance script: Upload classes to sub