User Tools

Site Tools


hpl3:community:scripting:classes:cluxarea

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

hpl3:community:scripting:classes:cluxarea [2015/11/05 11:58] (current)
abion47 created
Line 1: Line 1:
 +=====cLuxArea=====
 +
 +====Fields====
 +
 +cLuxArea has no public fields.
 +
 +====Functions====
 +
 +^ 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// |   |
 +| void | MoveLinearTo | const [[cVector3f]] &in avGoal, \\ float afAcc, \\ float afMaxSpeed, \\ float afSlowdownDist,​ \\ bool abResetSpeed,​ \\ //const [[tString]] &in asCallback = ""//​ |   |
 +| void | StopMove |     ​| ​  |
 +| [[iPhysicsBody]]@ | GetAreaBody |     ​| ​  |
 +| void | SetCheckCollision | bool abX |   |
 +| bool | GetCheckCollision |     ​| ​  |
 +| void | SetupCheckCollision | bool abCheckIfCenterInSide,​ \\ bool abCheckDynamic,​ \\ bool abCheckStatic,​ \\ bool abCheckCharacters |   |
 +| const [[cVector3f]]&​ | GetSize |     ​| ​  |
 +
 +====Remarks====
 +
 +Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
  
hpl3/community/scripting/classes/cluxarea.txt ยท Last modified: 2015/11/05 11:58 by abion47