https://wiki.frictionalgames.com/api.php?action=feedcontributions&user=Maintenance+script&feedformat=atom
Frictional Wiki - User contributions [en]
2024-03-28T16:45:05Z
User contributions
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cmeshentity&diff=2536
HPL3/Community/Scripting/Classes/cmeshentity
2020-07-30T09:12:35Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cMeshEntity==<br />
<br />
===Fields===<br />
<br />
cMeshEntity has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| [[eEntityType]] || GetEntityType || || <br />
|-<br />
| [[tID]] || GetID || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| void || UpdateLogic || float afTimeStep || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| bool || HasParent || || <br />
|-<br />
| bool || IsActive || const || <br />
|-<br />
| void || SetActive || bool abActive || <br />
|-<br />
| [[cVector3f]] || GetLocalPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetLocalMatrix || || <br />
|-<br />
| [[cVector3f]] || GetWorldPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetWorldMatrix || || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetWorldPosition || const [[cVector3f]] &in avWorldPos || <br />
|-<br />
| void || SetWorldMatrix || const [[cMatrixf]] &in a_mtxWorldTransform || <br />
|-<br />
| int || GetTransformUpdateCount || || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetBoundingVolume || || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| void || AddChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| void || RemoveChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| bool || IsChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| [[iEntity3D]]@ || GetEntityParent || || <br />
|-<br />
| [[cEntity3DIterator]]@ || GetChildIterator || || <br />
|-<br />
| [[cMesh]]@ || GetMesh || || <br />
|-<br />
| void || UpdateAnimation || float afTimeStep || <br />
|-<br />
| void || PostUpdateLogic || float afTimeStep || <br />
|-<br />
| [[cSubMeshEntity]]@ || GetSubMeshEntity || uint alIdx || <br />
|-<br />
| [[cSubMeshEntity]]@ || GetSubMeshEntityName || const [[tString]]& asName || <br />
|-<br />
| int || GetSubMeshEntityIndex || const [[tString]]& asName || <br />
|-<br />
| int || GetSubMeshEntityNum || || <br />
|-<br />
| [[cAnimationState]]@ || GetAnimationState || int alIndex || <br />
|-<br />
| int || GetAnimationStateIndex || const [[tString]]& asName || <br />
|-<br />
| [[cAnimationState]]@ || GetAnimationStateFromName || const [[tString]]& asName || <br />
|-<br />
| int || GetAnimationStateNum || || <br />
|-<br />
| void || Play || int alIndex, <br />bool abLoop, <br />bool bStopPrev || <br />
|-<br />
| void || PlayName || const [[tString]]& asName, <br />bool abLoop, <br />bool bStopPrev || <br />
|-<br />
| void || Stop || || <br />
|-<br />
| void || PlayFadeTo || int alIndex, <br />bool abLoop, <br />float afTime || <br />
|-<br />
| void || PlayFadeToName || const [[tString]]& asName, <br />bool abLoop, <br />float afTime || <br />
|-<br />
| bool || AnimationIsOver || const [[tString]]& asName || <br />
|-<br />
| void || SetNormalizeAnimationWeights || bool abX || <br />
|-<br />
| bool || GetNormalizeAnimationWeights || || <br />
|-<br />
| [[cProcAnimation]]@ || CreateProcAnimation || const [[tString]] &in asName || <br />
|-<br />
| [[cProcAnimation]]@ || GetProcAnimationFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cProcAnimation]]@ || GetProcAnimation || int alIdx || <br />
|-<br />
| int || GetProcAnimationNum || || <br />
|-<br />
| void || ProcPlayName || const [[tString]] &in asName, <br />float afAnimTime, <br />bool abLoop, <br />bool abStopPrev || <br />
|-<br />
| void || ProcPlay || int alIdx, <br />float afAnimTime, <br />bool abLoop, <br />bool abStopPrev || <br />
|-<br />
| void || ProcStop || || <br />
|-<br />
| void || ProcPlayFadeTo || int alIndex, <br />float afAnimTime, <br />bool abLoop, <br />float afFadeTime || <br />
|-<br />
| void || ProcPlayFadeToName || const [[tString]]& asName, <br />float afAnimTime, <br />bool abLoop, <br />float afFadeTime || <br />
|-<br />
| [[cNode3D]]@ || GetBoneStateRoot || || <br />
|-<br />
| [[cBoneState]]@ || GetBoneState || int alIndex || <br />
|-<br />
| int || GetBoneStateIndex || const [[tString]]& asName || <br />
|-<br />
| int || GetBoneStateIndexFromPtr || [[cBoneState]]@ apBoneState || <br />
|-<br />
| [[cBoneState]]@ || GetBoneStateFromName || const [[tString]]& asName || <br />
|-<br />
| int || GetBoneStateNum || || <br />
|-<br />
| [[cNode3D]]@ || AddSocket || const [[tString]] &in asName, <br />const [[tString]] &in asAttachedBoneName, <br />const [[cMatrixf]] &in a_mtxLocalTransform, <br />''bool abRescale = true'' || <br />
|-<br />
| [[cNode3D]]@ || GetSocket || const [[tString]] &in asName || <br />
|-<br />
| void || ClearSockets || || <br />
|-<br />
| int || GetSocketNum || || <br />
|-<br />
| [[cNode3D]]@ || GetSocketFromIndex || int alIdx || <br />
|-<br />
| void || SetSkeletonPhysicsActive || bool abX || <br />
|-<br />
| bool || GetSkeletonPhysicsActive || || <br />
|-<br />
| void || SetSkeletonPhysicsCanSleep || bool abX || <br />
|-<br />
| bool || GetSkeletonPhysicsCanSleep || || <br />
|-<br />
| float || GetSkeletonPhysicsWeight || || <br />
|-<br />
| void || SetSkeletonPhysicsWeight || float afX || <br />
|-<br />
| void || FadeSkeletonPhysicsWeight || float afTime || <br />
|-<br />
| void || SetSkeletonCollidersActive || bool abX || <br />
|-<br />
| bool || GetSkeletonCollidersActive || || <br />
|-<br />
| void || AlignBodiesToSkeleton || bool abCalculateSpeed || <br />
|-<br />
| [[cActorAnimController]]@ || GetActorAnimController || || <br />
|-<br />
| [[cMatrixf]] || CalculateTransformFromSkeleton || || <br />
|-<br />
| [[cMatrixf]] || CalculateTransformFromSkeleton || [[cVector3f]] &out apPostion, <br />[[cVector3f]] &out apAngles || <br />
|-<br />
| bool || CheckColliderShapeCollision || [[iPhysicsWorld]]@ apWorld, <br />[[iCollideShape]]@ apShape, <br />const [[cMatrixf]]& a_mtxShape, <br /> avPosList, <br /> avBoneIndexList || <br />
|-<br />
| void || ResetGraphicsUpdated || || <br />
|-<br />
| void || SetDisableSleep || bool abX || <br />
|-<br />
| [[cNode3D]]@ || GetNodeState || int alIndex || <br />
|-<br />
| int || GetNodeStateIndex || const [[tString]]& asName || <br />
|-<br />
| [[cNode3D]]@ || GetNodeStateFromName || const [[tString]]& asName || <br />
|-<br />
| int || GetNodeStateNum || || <br />
|-<br />
| bool || IsVisible || || <br />
|-<br />
| void || SetVisible || bool abVisible || <br />
|-<br />
| void || SetStatic || bool abX || <br />
|-<br />
| bool || IsStatic || || <br />
|-<br />
| void || SetIsOccluder || bool abX || <br />
|-<br />
| void || SetRenderFlagBit || int alFlagBit, <br />bool abSet || <br />
|-<br />
| void || SetDiffuseColorMul || const [[cColor]] &in aColor || <br />
|-<br />
| void || SetIlluminationColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetIlluminationColor || || <br />
|-<br />
| void || SetCoverageAmount || float afX || <br />
|-<br />
| float || GetCoverageAmount || || <br />
|-<br />
| void || SetLiquidAmount || float afX || <br />
|-<br />
| float || GetLiquidAmount || || <br />
|-<br />
| void || UseAutomaticLiquidAmount || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/iphysicsrope&diff=2531
HPL3/Community/Scripting/Classes/iphysicsrope
2020-07-30T09:12:34Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==iPhysicsRope==<br />
<br />
===Fields===<br />
<br />
iPhysicsRope has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || GetActive || || <br />
|-<br />
| void || RemoveAttachedBody || [[iPhysicsBody]]@ apBody, <br />bool abRemoveContainerFromBody || <br />
|-<br />
| void || SetGravityForce || const [[cVector3f]] &in avX || <br />
|-<br />
| const [[cVector3f]]& || GetGravityForce || || <br />
|-<br />
| void || SetDamping || float afX || <br />
|-<br />
| float || GetDamping || || <br />
|-<br />
| void || SetParticleRadius || float afX || <br />
|-<br />
| float || GetParticleRadius || || <br />
|-<br />
| void || SetSlideAmount || float afX || <br />
|-<br />
| float || GetSlideAmount || || <br />
|-<br />
| void || SetCollide || bool abX || <br />
|-<br />
| bool || GetCollide || || <br />
|-<br />
| void || SetSleeping || bool abX || <br />
|-<br />
| int || GetParticleNum || || <br />
|-<br />
| [[cVerletParticle]]@ || GetParticle || int alIdx || <br />
|-<br />
| int || GetUpdateCount || const || <br />
|-<br />
| void || IncUpdateCount || || <br />
|-<br />
| void || UpdateLengthConstraint || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afLength || <br />
|-<br />
| void || UpdateLengthConstraint || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afLength, <br />float afStiffness || <br />
|-<br />
| void || UpdateLengthConstraint || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afMinLength, <br />float afMaxLength, <br />float afStiffness || <br />
|-<br />
| void || UpdateLengthConstraintStretch || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afLength, <br />float afStiffness || <br />
|-<br />
| void || UpdateParticleCollisionConstraint || [[cVerletParticle]]@ apPart, <br />const [[cVector3f]]& avPrevPos, <br />float afRadius || <br />
|-<br />
| void || SetPhysicsActive || bool abX || <br />
|-<br />
| bool || GetPhysicsActive || || <br />
|-<br />
| void || SetMotorActive || bool abX || <br />
|-<br />
| bool || GetMotorActive || || <br />
|-<br />
| void || SetMotorWantedLength || float afX || <br />
|-<br />
| void || SetMotorSpeedMul || float afX || <br />
|-<br />
| void || SetMotorMaxSpeed || float afX || <br />
|-<br />
| void || SetMotorMinSpeed || float afX || <br />
|-<br />
| float || GetMotorWantedLength || || <br />
|-<br />
| float || GetMotorSpeedMul || || <br />
|-<br />
| float || GetMotorMaxSpeed || || <br />
|-<br />
| float || GetMotorMinSpeed || || <br />
|-<br />
| void || SetMotorSound || const [[tString]] &in asSound || <br />
|-<br />
| void || SetMotorSoundStartSpeed || float afX || <br />
|-<br />
| void || SetMotorSoundStopSpeed || float afX || <br />
|-<br />
| const [[tString]]& || GetMotorSound || || <br />
|-<br />
| float || GetMotorSoundStartSpeed || || <br />
|-<br />
| float || GetMotorSoundStopSpeed || || <br />
|-<br />
| void || SetAutoMoveActive || bool abX || <br />
|-<br />
| void || SetAutoMoveAcc || float afX || <br />
|-<br />
| void || SetAutoMoveMaxSpeed || float afX || <br />
|-<br />
| void || SetAutoMoveSpeed || float afX || <br />
|-<br />
| bool || GetAutoMoveActive || || <br />
|-<br />
| float || GetAutoMoveAcc || || <br />
|-<br />
| float || GetAutoMoveMaxSpeed || || <br />
|-<br />
| float || GetAutoMoveSpeed || || <br />
|-<br />
| [[cVerletParticle]]@ || GetStartParticle || || <br />
|-<br />
| [[cVerletParticle]]@ || GetEndParticle || || <br />
|-<br />
| void || SetAttachedStartBody || [[iPhysicsBody]]@ apBody || <br />
|-<br />
| void || SetAttachedEndBody || [[iPhysicsBody]]@ apBody || <br />
|-<br />
| [[iPhysicsBody]]@ || GetAttachedStartBody || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetAttachedEndBody || || <br />
|-<br />
| void || SetTotalLength || float afX || <br />
|-<br />
| float || GetTotalLength || || <br />
|-<br />
| void || SetMinTotalLength || float afX || <br />
|-<br />
| void || SetMaxTotalLength || float afX || <br />
|-<br />
| float || GetMinTotalLength || || <br />
|-<br />
| float || GetMaxTotalLength || || <br />
|-<br />
| void || SetSegmentLength || float afX || <br />
|-<br />
| float || GetSegmentLength || || <br />
|-<br />
| float || GetFirstSegmentLength || || <br />
|-<br />
| void || SetMaxIterations || int alX || <br />
|-<br />
| int || GetMaxIterations || || <br />
|-<br />
| void || SetStrength || float afX || <br />
|-<br />
| float || GetStrength || || <br />
|-<br />
| void || SetStiffness || float afX || <br />
|-<br />
| float || GetStiffness || || <br />
|-<br />
| void || SetCollideAttachments || bool abX || <br />
|-<br />
| bool || GetCollideAttachments || || <br />
|-<br />
| void || UpdateConstraints || || <br />
|-<br />
| void || RenderDebug || [[iLowLevelGraphics]]@ apLowLevel || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/eaxis3d&diff=2532
HPL3/Community/Scripting/Classes/eaxis3d
2020-07-30T09:12:34Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eAxis3D==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eAxis3D_X || 0 || <br />
|-<br />
| eAxis3D_Y || 1 || <br />
|-<br />
| eAxis3D_Z || 2 || <br />
|-<br />
| eAxis3D_LastEnum || 3 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/edepthtestfunc&diff=2533
HPL3/Community/Scripting/Classes/edepthtestfunc
2020-07-30T09:12:34Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eDepthTestFunc==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eDepthTestFunc_Never || 0 || <br />
|-<br />
| eDepthTestFunc_Less || 1 || <br />
|-<br />
| eDepthTestFunc_LessOrEqual || 2 || <br />
|-<br />
| eDepthTestFunc_Greater || 3 || <br />
|-<br />
| eDepthTestFunc_GreaterOrEqual || 4 || <br />
|-<br />
| eDepthTestFunc_Equal || 5 || <br />
|-<br />
| eDepthTestFunc_NotEqual || 6 || <br />
|-<br />
| eDepthTestFunc_Always || 7 || <br />
|-<br />
| eDepthTestFunc_LastEnum || 8 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cimguitextframedata&diff=2534
HPL3/Community/Scripting/Classes/cimguitextframedata
2020-07-30T09:12:34Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cImGuiTextFrameData==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| mColorBase || [[cColor]] || <br />
|-<br />
| mColorText || [[cColor]] || <br />
|-<br />
| mColorDisabled || [[cColor]] || <br />
|-<br />
| mvDefaultSize || [[cVector2f]] || <br />
|-<br />
| mbUseBackgroundGfx || bool || <br />
|-<br />
| mGfxBackground || [[cImGuiGfx]] || <br />
|-<br />
| mFont || [[cImGuiFont]] || <br />
|-<br />
| mFontAlign || [[eFontAlign]] || <br />
|-<br />
| mbUseDisabledColor || bool || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
cImGuiTextFrameData has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cimguiwidgetstatevar&diff=2535
HPL3/Community/Scripting/Classes/cimguiwidgetstatevar
2020-07-30T09:12:34Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cImGuiWidgetStateVar==<br />
<br />
===Fields===<br />
<br />
cImGuiWidgetStateVar has no public fields.<br />
<br />
===Functions===<br />
<br />
cImGuiWidgetStateVar has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxvoicesceneinstance&diff=2527
HPL3/Community/Scripting/Classes/cluxvoicesceneinstance
2020-07-30T09:12:33Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxVoiceSceneInstance==<br />
<br />
===Fields===<br />
<br />
cLuxVoiceSceneInstance has no public fields.<br />
<br />
===Functions===<br />
<br />
cLuxVoiceSceneInstance has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/isounddata&diff=2528
HPL3/Community/Scripting/Classes/isounddata
2020-07-30T09:12:33Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==iSoundData==<br />
<br />
===Fields===<br />
<br />
iSoundData has no public fields.<br />
<br />
===Functions===<br />
<br />
iSoundData has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cxmltext&diff=2529
HPL3/Community/Scripting/Classes/cxmltext
2020-07-30T09:12:33Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cXmlText==<br />
<br />
===Fields===<br />
<br />
cXmlText has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetValue || || <br />
|-<br />
| void || SetValue || const [[tString]] &in asValue || <br />
|-<br />
| [[eXmlNodeType]] || GetType || || <br />
|-<br />
| [[iXmlNode]]@ || GetParent || || <br />
|-<br />
| [[cXmlElement]]@ || ToElement || || <br />
|-<br />
| [[cXmlElement]]@ || GetFirstElement || || <br />
|-<br />
| [[cXmlElement]]@ || GetFirstElement || const [[tString]] &in asName || <br />
|-<br />
| [[cXmlElement]]@ || CreateChildElement || const [[tString]] &in asName || <br />
|-<br />
| [[cXmlText]]@ || ToText || || <br />
|-<br />
| [[cXmlText]]@ || GetFirstText || || <br />
|-<br />
| [[cXmlText]]@ || GetFirstText || const [[tString]] &in asText || <br />
|-<br />
| [[cXmlText]]@ || CreateChildText || const [[tString]] &in asText || <br />
|-<br />
| [[cXmlNodeListIterator]]@ || GetChildIterator || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/eluxentitymessage&diff=2530
HPL3/Community/Scripting/Classes/eluxentitymessage
2020-07-30T09:12:33Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eLuxEntityMessage==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eLuxEntityMessage_MoveToPos || 0 || <br />
|-<br />
| eLuxEntityMessage_StuckCounterIsAtMax || 1 || <br />
|-<br />
| eLuxEntityMessage_EndOfPath || 2 || <br />
|-<br />
| eLuxEntityMessage_AnimationOver || 3 || <br />
|-<br />
| eLuxEntityMessage_SoundHeard || 4 || <br />
|-<br />
| eLuxEntityMessage_TurningDone || 5 || <br />
|-<br />
| eLuxEntityMessage_StopTurning || 6 || <br />
|-<br />
| eLuxEntityMessage_ProceduralAnimPause || 7 || <br />
|-<br />
| eLuxEntityMessage_PlayerDetected || 8 || <br />
|-<br />
| eLuxEntityMessage_PlayerUndetected || 9 || <br />
|-<br />
| eLuxEntityMessage_PlayerDead || 10 || <br />
|-<br />
| eLuxEntityMessage_AtTrackNode || 11 || <br />
|-<br />
| eLuxEntityMessage_EndOfTrack || 12 || <br />
|-<br />
| eLuxEntityMessage_AnimationMessageEvent || 13 || <br />
|-<br />
| eLuxEntityMessage_TransformUpdated || 14 || <br />
|-<br />
| eLuxEntityMessage_TakeDamage || 15 || <br />
|-<br />
| eLuxEntityMessage_HitByProp || 16 || <br />
|-<br />
| eLuxEntityMessage_SensesDeactivated || 17 || <br />
|-<br />
| eLuxEntityMessage_NearDoor || 18 || <br />
|-<br />
| eLuxEntityMessage_ForceToPosition || 19 || <br />
|-<br />
| eLuxEntityMessage_LastEnum || 20 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxprop&diff=2526
HPL3/Community/Scripting/Classes/cluxprop
2020-07-30T09:12:33Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxProp==<br />
<br />
===Fields===<br />
<br />
cLuxProp has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| const [[tID]]& || GetID || || <br />
|-<br />
| [[eLuxEntityType]] || GetEntityType || || <br />
|-<br />
| const [[tString]]& || GetClassName || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| const [[tString]]& || GetEventTag || || <br />
|-<br />
| const [[tString]]& || GetEventInstanceTag || || <br />
|-<br />
| void || SetEventInstanceTag || const [[tString]] &in asTag || <br />
|-<br />
| [[cSoundEntity]]@ || PlaySound || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| bool || GetLastCreatedSoundIsPlaying || || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystem || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystemOnBone || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />const [[tString]] &in asBoneName, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| int || PlayAnimation || const [[tString]] &in asName, <br />''float afFadeTime = 0.3f'', <br />''bool abLoop = false'', <br />''bool abPlayTransition = true'', <br />''const [[tString]] &in asCallback = ""'', <br />''bool abGlobalSpace = false'' || <br />
|-<br />
| void || AppendAnimation || const [[tString]] &in asName, <br />bool abLoop || <br />
|-<br />
| bool || GetAnimationIsPlaying || || <br />
|-<br />
| void || SetNormalizeAnimationWeights || bool abX || <br />
|-<br />
| void || StopAllAnimations || float afFadeTime || <br />
|-<br />
| void || StopAnimation || const [[tString]] &in asName, <br />float afFadeTime || <br />
|-<br />
| void || StopAnimation || int alIdx, <br />float afFadeTime || <br />
|-<br />
| void || SetCurrentAnimationPaused || bool abX || <br />
|-<br />
| void || SetAnimationMessageEventCallback || const [[tString]] &in asFunc, <br />bool abAutoRemove || <br />
|-<br />
| int || GetCurrentAnimationIndex || || <br />
|-<br />
| [[cAnimationState]]@ || GetCurrentAnimationState || || <br />
|-<br />
| void || GiveDamage || float afAmount, <br />int alStrength, <br />const [[tString]] &in asType, <br />const [[tString]] &in asSource || <br />
|-<br />
| void || AttachToEntity || [[iLuxEntity]]@ apEntity, <br />[[iPhysicsBody]]@ apTargetBody, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || AttachToSocket || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asSocket, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || RemoveEntityAttachment || || <br />
|-<br />
| void || SetFullGameSave || bool abX || <br />
|-<br />
| bool || IsLookedAtByPlayer || || <br />
|-<br />
| void || SetForceLookAtCheck || bool abX || <br />
|-<br />
| bool || GetForceLookAtCheck || || <br />
|-<br />
| void || PreloadEntityModel || const [[tString]]& asFile || <br />
|-<br />
| bool || CollidesWithPlayer || || <br />
|-<br />
| [[cLuxMap]]@ || GetMap || || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| [[cMatrixf]] || GetMatrix || || <br />
|-<br />
| [[cVector3f]] || GetPosition || || <br />
|-<br />
| int || GetBodyNum || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBody || int alIdx || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromID || int alID || <br />
|-<br />
| int || GetBodyIndexFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetMainBody || || <br />
|-<br />
| void || SetMeshScaleMul || const [[cVector3f]] &in avScale || <br />
|-<br />
| [[cVector3f]] || GetMeshScaleMul || || <br />
|-<br />
| void || FadeMeshScaleMul || const [[cVector3f]] &in avDestScale, <br />float afTime || <br />
|-<br />
| [[cMeshEntity]]@ || GetMeshEntity || || <br />
|-<br />
| [[cMaterial]]@ || GetBaseMaterial || || <br />
|-<br />
| [[iEntity3D]]@ || GetAttachEntity || || <br />
|-<br />
| [[cNode3D]]@ || GetVoiceAttachNode || || <br />
|-<br />
| bool || CanInteract || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| bool || OnInteract || int alType, <br />[[iPhysicsBody]]@ apBody, <br />const [[cVector3f]]& avFocusPos, <br />const [[tString]] &in asData || <br />
|-<br />
| int || GetInteractIconId || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| void || SetIsInteractedWith || bool abX || <br />
|-<br />
| bool || IsInteractedWith || || <br />
|-<br />
| float || GetMaxInteractDistance || || <br />
|-<br />
| void || SetMaxInteractDistance || float afX || <br />
|-<br />
| void || SetInteractionDisabled || bool abX || <br />
|-<br />
| bool || GetInteractionDisabled || || <br />
|-<br />
| void || SetPlayerInteractCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenInteracted || <br />
|-<br />
| void || SetPlayerLookAtCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenLookedAt, <br />bool abCheckCenterOfScreen, <br />bool abCheckRayIntersection, <br />float afMaxDistance, <br />float afCallbackDelay || <br />
|-<br />
| void || SetRecieveMessageCallback || const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || SetConnectionStateChangeCallback || const [[tString]]& asCallbackFunc || <br />
|-<br />
| bool || HasPlayerInteractCallback || || <br />
|-<br />
| bool || HasPlayerLookAtCallback || || <br />
|-<br />
| void || SetupParent || int alTypeId, <br />[[tID]] alId, <br />const [[tString]]& asName || <br />
|-<br />
| int || GetParentType || || <br />
|-<br />
| [[tID]] || GetParentId || || <br />
|-<br />
| const [[tString]]& || GetParentName || || <br />
|-<br />
| void || ChangeConnectionState || int alState || <br />
|-<br />
| void || AddConnection || const [[tString]] &in asName, <br />[[iLuxEntity]]@ apEntity, <br />bool abInvertStateSent, <br />int alStatesUsed || <br />
|-<br />
| void || RemoveConnection || const [[tString]] &in asName || <br />
|-<br />
| void || RemoveAllConnections || || <br />
|-<br />
| bool || CheckEntityCollision || [[iLuxEntity]]@ apEntity || <br />
|-<br />
| bool || CheckBodyCollision || [[iPhysicsBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckShapeCollision || [[iCollideShape]]@ apShape, <br />const [[cMatrixf]]& a_mtxTransform, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckCharacterCollision || [[iCharacterBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || HasCollideCallbacks || || <br />
|-<br />
| void || AddCollideCallback || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || RemoveCollideCallback || const [[tString]] &in asEntityName || <br />
|-<br />
| bool || ScriptPrepare || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptPrepareFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| bool || ScriptExecute || || <br />
|-<br />
| bool || ScriptMethodExists || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptMethodExistsFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| void || SetArgBool || int alArgNum, <br />bool abVal || <br />
|-<br />
| void || SetArgInt || int alArg, <br />int alX || <br />
|-<br />
| void || SetArgFloat || int alArg, <br />float afX || <br />
|-<br />
| void || SetArgString || int alArg, <br />const [[tString]]& asStr || <br />
|-<br />
| bool || GetReturnBool || || <br />
|-<br />
| int || GetReturnInt || || <br />
|-<br />
| float || GetReturnFloat || || <br />
|-<br />
| [[tString]] || GetReturnString || || <br />
|-<br />
| void || BroadcastMessage || int alMessageId, <br />[[iLuxEntityComponent]]@ apSource, <br />const [[cVector3f]]& avData, <br />int alData || <br />
|-<br />
| void || SetEffectBaseColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetEffectBaseColor || || <br />
|-<br />
| void || FadeEffectBaseColor || const [[cColor]]& aDestColor, <br />float afTime || <br />
|-<br />
| void || SetEffectsActive || bool abActive, <br />bool abFadeAndPlaySounds || <br />
|-<br />
| bool || GetEffectsActive || || <br />
|-<br />
| float || GetEffectsAlpha || || <br />
|-<br />
| const [[tString]]& || GetEffectsOnSound || || <br />
|-<br />
| const [[tString]]& || GetEffectsOffSound || || <br />
|-<br />
| float || GetEffectsOnTime || || <br />
|-<br />
| float || GetEffectsOffTime || || <br />
|-<br />
| void || SetVarString || const [[tString]] &in asName, <br />const [[tString]] &in asX || <br />
|-<br />
| void || SetVarBool || const [[tString]] &in asName, <br />bool abX || <br />
|-<br />
| void || SetVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || SetVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || SetVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || SetVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| void || SetVarColor || const [[tString]] &in asName, <br />const [[cColor]] &in aX || <br />
|-<br />
| void || IncVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || IncVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || IncVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || IncVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| const [[tString]]& || GetVarString || const [[tString]] &in asName || <br />
|-<br />
| bool || GetVarBool || const [[tString]] &in asName || <br />
|-<br />
| int || GetVarInt || const [[tString]] &in asName || <br />
|-<br />
| float || GetVarFloat || const [[tString]] &in asName || <br />
|-<br />
| [[cVector2f]] || GetVarVector2f || const [[tString]] &in asName || <br />
|-<br />
| [[cVector3f]] || GetVarVector3f || const [[tString]] &in asName || <br />
|-<br />
| [[cColor]] || GetVarColor || const [[tString]] &in asName || <br />
|-<br />
| bool || CheckIsOnScreen || bool abUseRayCast || <br />
|-<br />
| const [[tString]]& || GetFileName || || <br />
|-<br />
| const [[cVector3f]]& || GetOnLoadScale || || <br />
|-<br />
| const [[cMatrixf]]& || GetOnLoadTransform || || <br />
|-<br />
| [[iLight]]@ || GetLightFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cParticleSystem]]@ || GetParticleSystemFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cBillboard]]@ || GetBillboardFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cSoundEntity]]@ || GetSoundEntityFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cLensFlare]]@ || GetLensFlareFromName || const [[tString]] &in asName || <br />
|-<br />
| bool || IsOccluder || || <br />
|-<br />
| void || SetIsOccluder || bool abX || <br />
|-<br />
| void || Sleep || || <br />
|-<br />
| void || WakeUp || || <br />
|-<br />
| void || SetAutoSleep || bool abX || <br />
|-<br />
| bool || GetAutoSleep || || <br />
|-<br />
| bool || IsSleeping || || <br />
|-<br />
| float || GetVariableUpdateRate || || <br />
|-<br />
| void || SetVariableUpdateRate || float afX || <br />
|-<br />
| void || GetClosestEntity || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />int alInteractType, <br />bool abCheckLineOfSight || <br />
|-<br />
| void || GetClosestBody || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength || <br />
|-<br />
| void || GetClosestCharCollider || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />bool abCheckDynamic || <br />
|-<br />
| void || GetLightLevelAtPos || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avPos, <br />[[iLight]]@ apSkipLight, <br />float afRadiusAdd || <br />
|-<br />
| void || DrawProjDebugText || const [[tString]] &in asText, <br />''float afFontSize = 16.0f'', <br />''bool abProjectSize = false'', <br />''[[eFontAlign]] aAlignment = eFontAlign_Left'', <br />''const [[cColor]] &in aColor = cColor'', <br /> 1, <br /> 1, <br />''const [[cVector3f]] &in avOffset = cVector3f'', <br /> 0, <br />''float afMaxDistance = 20'' || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetIsDoor || bool abX || <br />
|-<br />
| bool || GetIsDoor || || <br />
|-<br />
| void || SetIsClosedDoor || bool abX || <br />
|-<br />
| bool || GetIsClosedDoor || || <br />
|-<br />
| void || UpdateEntityAttachment || || <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| void || PostUpdate || float afTimeStep || <br />
|-<br />
| void || VariableUpdate || float afDeltaTime || <br />
|-<br />
| bool || GetSaveDataIsUpdated || || <br />
|-<br />
| void || SetSaveDataIsUpdated || bool abX || <br />
|-<br />
| void || Timer_ClearAll || || <br />
|-<br />
| void || Timer_Add || uint64 alID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || uint64 alID || <br />
|-<br />
| bool || Timer_Exists || uint64 alID || <br />
|-<br />
| float || Timer_GetTimeLeft || uint64 alID || <br />
|-<br />
| void || Timer_SetPaused || uint64 alID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || uint64 alID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || uint64 alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Timer_Add || const [[tString]] &in asID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || const [[tString]] &in asID || <br />
|-<br />
| bool || Timer_Exists || const [[tString]] &in asID || <br />
|-<br />
| float || Timer_GetTimeLeft || const [[tString]] &in asID || <br />
|-<br />
| void || Timer_SetPaused || const [[tString]] &in asID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || const [[tString]] &in asID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || const [[tString]] &in asID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_ClearAll || || <br />
|-<br />
| void || Fader_FadeTo || uint alID, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || uint alID, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || uint alID, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || uint alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_FadeTo || const [[tString]] &in asName, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || const [[tString]] &in asName, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || const [[tString]] &in asName, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || const [[tString]] &in asName, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || SetDisableCollisionUntilOutSidePlayer || bool abX || <br />
|-<br />
| void || EnableCharCollisionUntilStopped || || <br />
|-<br />
| void || MoveLinearTo || const [[cVector3f]] &in avGoal, <br />float afAcc, <br />float afMaxSpeed, <br />float afSlowdownDist, <br />bool abResetSpeed, <br />''const [[tString]] &in asCallback = ""'' || <br />
|-<br />
| void || MoveAngularTo || const [[cMatrixf]] &in a_mtxGoal, <br />float afAcc, <br />float afMaxSpeed, <br />float afSlowdownDist, <br />bool abResetSpeed, <br />bool abUseOffset, <br />const [[cVector3f]]& avWorldOffset, <br />const [[cVector3f]]& avLocalOffset, <br />''const [[tString]] &in asCallback = ""'' || <br />
|-<br />
| void || RotateAtSpeed || float afAcc, <br />float afGoalSpeed, <br />const [[cVector3f]] &in avAxis, <br />bool abResetSpeed, <br />bool abUseOffset, <br />const [[cVector3f]]& avWorldOffset, <br />const [[cVector3f]]& avLocalOffset || <br />
|-<br />
| void || StopMove || || <br />
|-<br />
| void || FadeInMeshEntity || float afTime || <br />
|-<br />
| void || Break || || <br />
|-<br />
| [[cLuxProp]]@ || GetAttachmentParent || || <br />
|-<br />
| void || SetAttachmentParent || [[cLuxProp]]@ apProp || <br />
|-<br />
| void || AddAndAttachProp || const [[tString]] &in asName, <br />const [[tString]] &in asFileName, <br />const [[cMatrixf]] &in a_mtxOffset || <br />
|-<br />
| bool || DestroyAttachedProp || const [[tString]] &in asName || <br />
|-<br />
| bool || RemoveAttachedProp || [[cLuxProp]]@ apProp || <br />
|-<br />
| bool || HasAttachedProp || || <br />
|-<br />
| void || SetLiquidAmount || float afAmount || <br />
|-<br />
| void || FadeLiquidAmountTo || float afTargetAmount, <br />float afTime || <br />
|-<br />
| void || SetScriptCollisionCallbackActive || bool abX || <br />
|-<br />
| bool || GetScriptCollisionCallbackActive || || <br />
|-<br />
| [[iPhysicsJoint]]@ || GetJoint || int alIdx || <br />
|-<br />
| int || GetJointNum || || <br />
|-<br />
| [[iLight]]@ || GetLight || int alIdx || <br />
|-<br />
| int || GetLightNum || || <br />
|-<br />
| [[cParticleSystem]]@ || GetParticleSystem || int alIdx || <br />
|-<br />
| int || GetParicleSystemNum || || <br />
|-<br />
| [[cBillboard]]@ || GetBillboard || int alIdx || <br />
|-<br />
| int || GetBillboardNum || || <br />
|-<br />
| [[cSoundEntity]]@ || GetSoundEntity || int alIdx || <br />
|-<br />
| int || GetSoundEntityNum || || <br />
|-<br />
| [[cEntityBodyExtraData]]@ || GetBodyExtraData || int alIdx || <br />
|-<br />
| void || SetHealth || float afX || <br />
|-<br />
| float || GetHealth || || <br />
|-<br />
| bool || IsMoving || || <br />
|-<br />
| bool || GetStaticPhysics || || <br />
|-<br />
| void || SetStaticPhysics || bool abX || <br />
|-<br />
| void || EnableBodyCollisionCallback || || <br />
|-<br />
| void || CreateAndSetupGui || [[tString]] asSubmesh, <br />const [[cColor]] &in aColorMul, <br />const [[cColor]] &in aClearColor, <br />const [[cColor]] &in aOfflineClearColor, <br />const [[cVector2f]] &in avScreenSize || <br />
|-<br />
| void || DisableSubMeshMerge || [[tString]] asSubmesh || <br />
|-<br />
| bool || SetGuiIsFocused || bool abX, <br />''bool abShowMouse = true'' || <br />
|-<br />
| bool || IsGuiFocused || || <br />
|-<br />
| void || ForceGuiCacheUpdate || || <br />
|-<br />
| void || SetGuiCacheAtScreenSize || float afX || <br />
|-<br />
| void || SetGuiUpdateWhenOutOfView || bool abX || <br />
|-<br />
| bool || HasActiveGui || || <br />
|-<br />
| void || SetOnGuiFunction || const [[tString]] &in asFunction || <br />
|-<br />
| void || SetGuiActive || bool abX, <br />''float afFadeTime = 0.0f'' || <br />
|-<br />
| bool || IsGuiActive || || <br />
|-<br />
| [[cLuxGuiSet]]@ || GetGuiSet || || <br />
|-<br />
| void || SetGuiSetUseInput || bool || <br />
|-<br />
| bool || GetGuiSetUseInput || || <br />
|-<br />
| void || SetGuiVariableFPS || float afX || <br />
|-<br />
| float || GetGuiVariableFPS || || <br />
|-<br />
| void || SetAllowMapTransfer || bool || <br />
|-<br />
| bool || GetAllowMapTransfer || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cbeamend&diff=2521
HPL3/Community/Scripting/Classes/cbeamend
2020-07-30T09:12:32Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cBeamEnd==<br />
<br />
===Fields===<br />
<br />
cBeamEnd has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| [[eEntityType]] || GetEntityType || || <br />
|-<br />
| [[tID]] || GetID || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| void || UpdateLogic || float afTimeStep || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| bool || HasParent || || <br />
|-<br />
| bool || IsActive || const || <br />
|-<br />
| void || SetActive || bool abActive || <br />
|-<br />
| [[cVector3f]] || GetLocalPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetLocalMatrix || || <br />
|-<br />
| [[cVector3f]] || GetWorldPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetWorldMatrix || || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetWorldPosition || const [[cVector3f]] &in avWorldPos || <br />
|-<br />
| void || SetWorldMatrix || const [[cMatrixf]] &in a_mtxWorldTransform || <br />
|-<br />
| int || GetTransformUpdateCount || || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetBoundingVolume || || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| void || AddChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| void || RemoveChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| bool || IsChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| [[iEntity3D]]@ || GetEntityParent || || <br />
|-<br />
| [[cEntity3DIterator]]@ || GetChildIterator || || <br />
|-<br />
| void || SetColor || const [[cColor]]& aColor || <br />
|-<br />
| const [[cColor]]& || GetColor || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/eimguigaugeorientation&diff=2522
HPL3/Community/Scripting/Classes/eimguigaugeorientation
2020-07-30T09:12:32Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eImGuiGaugeOrientation==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eImGuiGaugeOrientation_Hori || 0 || <br />
|-<br />
| eImGuiGaugeOrientation_Vert || 1 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxagent&diff=2523
HPL3/Community/Scripting/Classes/cluxagent
2020-07-30T09:12:32Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxAgent==<br />
<br />
===Fields===<br />
<br />
cLuxAgent has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| const [[tID]]& || GetID || || <br />
|-<br />
| [[eLuxEntityType]] || GetEntityType || || <br />
|-<br />
| const [[tString]]& || GetClassName || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| const [[tString]]& || GetEventTag || || <br />
|-<br />
| const [[tString]]& || GetEventInstanceTag || || <br />
|-<br />
| void || SetEventInstanceTag || const [[tString]] &in asTag || <br />
|-<br />
| [[cSoundEntity]]@ || PlaySound || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| bool || GetLastCreatedSoundIsPlaying || || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystem || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystemOnBone || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />const [[tString]] &in asBoneName, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| int || PlayAnimation || const [[tString]] &in asName, <br />''float afFadeTime = 0.3f'', <br />''bool abLoop = false'', <br />''bool abPlayTransition = true'', <br />''const [[tString]] &in asCallback = ""'', <br />''bool abGlobalSpace = false'' || <br />
|-<br />
| void || AppendAnimation || const [[tString]] &in asName, <br />bool abLoop || <br />
|-<br />
| bool || GetAnimationIsPlaying || || <br />
|-<br />
| void || SetNormalizeAnimationWeights || bool abX || <br />
|-<br />
| void || StopAllAnimations || float afFadeTime || <br />
|-<br />
| void || StopAnimation || const [[tString]] &in asName, <br />float afFadeTime || <br />
|-<br />
| void || StopAnimation || int alIdx, <br />float afFadeTime || <br />
|-<br />
| void || SetCurrentAnimationPaused || bool abX || <br />
|-<br />
| void || SetAnimationMessageEventCallback || const [[tString]] &in asFunc, <br />bool abAutoRemove || <br />
|-<br />
| int || GetCurrentAnimationIndex || || <br />
|-<br />
| [[cAnimationState]]@ || GetCurrentAnimationState || || <br />
|-<br />
| void || GiveDamage || float afAmount, <br />int alStrength, <br />const [[tString]] &in asType, <br />const [[tString]] &in asSource || <br />
|-<br />
| void || AttachToEntity || [[iLuxEntity]]@ apEntity, <br />[[iPhysicsBody]]@ apTargetBody, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || AttachToSocket || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asSocket, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || RemoveEntityAttachment || || <br />
|-<br />
| void || SetFullGameSave || bool abX || <br />
|-<br />
| bool || IsLookedAtByPlayer || || <br />
|-<br />
| void || SetForceLookAtCheck || bool abX || <br />
|-<br />
| bool || GetForceLookAtCheck || || <br />
|-<br />
| void || PreloadEntityModel || const [[tString]]& asFile || <br />
|-<br />
| bool || CollidesWithPlayer || || <br />
|-<br />
| [[cLuxMap]]@ || GetMap || || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| [[cMatrixf]] || GetMatrix || || <br />
|-<br />
| [[cVector3f]] || GetPosition || || <br />
|-<br />
| int || GetBodyNum || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBody || int alIdx || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromID || int alID || <br />
|-<br />
| int || GetBodyIndexFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetMainBody || || <br />
|-<br />
| void || SetMeshScaleMul || const [[cVector3f]] &in avScale || <br />
|-<br />
| [[cVector3f]] || GetMeshScaleMul || || <br />
|-<br />
| void || FadeMeshScaleMul || const [[cVector3f]] &in avDestScale, <br />float afTime || <br />
|-<br />
| [[cMeshEntity]]@ || GetMeshEntity || || <br />
|-<br />
| [[cMaterial]]@ || GetBaseMaterial || || <br />
|-<br />
| [[iEntity3D]]@ || GetAttachEntity || || <br />
|-<br />
| [[cNode3D]]@ || GetVoiceAttachNode || || <br />
|-<br />
| bool || CanInteract || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| bool || OnInteract || int alType, <br />[[iPhysicsBody]]@ apBody, <br />const [[cVector3f]]& avFocusPos, <br />const [[tString]] &in asData || <br />
|-<br />
| int || GetInteractIconId || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| void || SetIsInteractedWith || bool abX || <br />
|-<br />
| bool || IsInteractedWith || || <br />
|-<br />
| float || GetMaxInteractDistance || || <br />
|-<br />
| void || SetMaxInteractDistance || float afX || <br />
|-<br />
| void || SetInteractionDisabled || bool abX || <br />
|-<br />
| bool || GetInteractionDisabled || || <br />
|-<br />
| void || SetPlayerInteractCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenInteracted || <br />
|-<br />
| void || SetPlayerLookAtCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenLookedAt, <br />bool abCheckCenterOfScreen, <br />bool abCheckRayIntersection, <br />float afMaxDistance, <br />float afCallbackDelay || <br />
|-<br />
| void || SetRecieveMessageCallback || const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || SetConnectionStateChangeCallback || const [[tString]]& asCallbackFunc || <br />
|-<br />
| bool || HasPlayerInteractCallback || || <br />
|-<br />
| bool || HasPlayerLookAtCallback || || <br />
|-<br />
| void || SetupParent || int alTypeId, <br />[[tID]] alId, <br />const [[tString]]& asName || <br />
|-<br />
| int || GetParentType || || <br />
|-<br />
| [[tID]] || GetParentId || || <br />
|-<br />
| const [[tString]]& || GetParentName || || <br />
|-<br />
| void || ChangeConnectionState || int alState || <br />
|-<br />
| void || AddConnection || const [[tString]] &in asName, <br />[[iLuxEntity]]@ apEntity, <br />bool abInvertStateSent, <br />int alStatesUsed || <br />
|-<br />
| void || RemoveConnection || const [[tString]] &in asName || <br />
|-<br />
| void || RemoveAllConnections || || <br />
|-<br />
| bool || CheckEntityCollision || [[iLuxEntity]]@ apEntity || <br />
|-<br />
| bool || CheckBodyCollision || [[iPhysicsBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckShapeCollision || [[iCollideShape]]@ apShape, <br />const [[cMatrixf]]& a_mtxTransform, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckCharacterCollision || [[iCharacterBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || HasCollideCallbacks || || <br />
|-<br />
| void || AddCollideCallback || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || RemoveCollideCallback || const [[tString]] &in asEntityName || <br />
|-<br />
| bool || ScriptPrepare || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptPrepareFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| bool || ScriptExecute || || <br />
|-<br />
| bool || ScriptMethodExists || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptMethodExistsFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| void || SetArgBool || int alArgNum, <br />bool abVal || <br />
|-<br />
| void || SetArgInt || int alArg, <br />int alX || <br />
|-<br />
| void || SetArgFloat || int alArg, <br />float afX || <br />
|-<br />
| void || SetArgString || int alArg, <br />const [[tString]]& asStr || <br />
|-<br />
| bool || GetReturnBool || || <br />
|-<br />
| int || GetReturnInt || || <br />
|-<br />
| float || GetReturnFloat || || <br />
|-<br />
| [[tString]] || GetReturnString || || <br />
|-<br />
| void || BroadcastMessage || int alMessageId, <br />[[iLuxEntityComponent]]@ apSource, <br />const [[cVector3f]]& avData, <br />int alData || <br />
|-<br />
| void || SetEffectBaseColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetEffectBaseColor || || <br />
|-<br />
| void || FadeEffectBaseColor || const [[cColor]]& aDestColor, <br />float afTime || <br />
|-<br />
| void || SetEffectsActive || bool abActive, <br />bool abFadeAndPlaySounds || <br />
|-<br />
| bool || GetEffectsActive || || <br />
|-<br />
| float || GetEffectsAlpha || || <br />
|-<br />
| const [[tString]]& || GetEffectsOnSound || || <br />
|-<br />
| const [[tString]]& || GetEffectsOffSound || || <br />
|-<br />
| float || GetEffectsOnTime || || <br />
|-<br />
| float || GetEffectsOffTime || || <br />
|-<br />
| void || SetVarString || const [[tString]] &in asName, <br />const [[tString]] &in asX || <br />
|-<br />
| void || SetVarBool || const [[tString]] &in asName, <br />bool abX || <br />
|-<br />
| void || SetVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || SetVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || SetVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || SetVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| void || SetVarColor || const [[tString]] &in asName, <br />const [[cColor]] &in aX || <br />
|-<br />
| void || IncVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || IncVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || IncVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || IncVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| const [[tString]]& || GetVarString || const [[tString]] &in asName || <br />
|-<br />
| bool || GetVarBool || const [[tString]] &in asName || <br />
|-<br />
| int || GetVarInt || const [[tString]] &in asName || <br />
|-<br />
| float || GetVarFloat || const [[tString]] &in asName || <br />
|-<br />
| [[cVector2f]] || GetVarVector2f || const [[tString]] &in asName || <br />
|-<br />
| [[cVector3f]] || GetVarVector3f || const [[tString]] &in asName || <br />
|-<br />
| [[cColor]] || GetVarColor || const [[tString]] &in asName || <br />
|-<br />
| bool || CheckIsOnScreen || bool abUseRayCast || <br />
|-<br />
| const [[tString]]& || GetFileName || || <br />
|-<br />
| const [[cVector3f]]& || GetOnLoadScale || || <br />
|-<br />
| const [[cMatrixf]]& || GetOnLoadTransform || || <br />
|-<br />
| [[iLight]]@ || GetLightFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cParticleSystem]]@ || GetParticleSystemFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cBillboard]]@ || GetBillboardFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cSoundEntity]]@ || GetSoundEntityFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cLensFlare]]@ || GetLensFlareFromName || const [[tString]] &in asName || <br />
|-<br />
| bool || IsOccluder || || <br />
|-<br />
| void || SetIsOccluder || bool abX || <br />
|-<br />
| void || Sleep || || <br />
|-<br />
| void || WakeUp || || <br />
|-<br />
| void || SetAutoSleep || bool abX || <br />
|-<br />
| bool || GetAutoSleep || || <br />
|-<br />
| bool || IsSleeping || || <br />
|-<br />
| float || GetVariableUpdateRate || || <br />
|-<br />
| void || SetVariableUpdateRate || float afX || <br />
|-<br />
| void || GetClosestEntity || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />int alInteractType, <br />bool abCheckLineOfSight || <br />
|-<br />
| void || GetClosestBody || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength || <br />
|-<br />
| void || GetClosestCharCollider || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />bool abCheckDynamic || <br />
|-<br />
| void || GetLightLevelAtPos || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avPos, <br />[[iLight]]@ apSkipLight, <br />float afRadiusAdd || <br />
|-<br />
| void || DrawProjDebugText || const [[tString]] &in asText, <br />''float afFontSize = 16.0f'', <br />''bool abProjectSize = false'', <br />''[[eFontAlign]] aAlignment = eFontAlign_Left'', <br />''const [[cColor]] &in aColor = cColor'', <br /> 1, <br /> 1, <br />''const [[cVector3f]] &in avOffset = cVector3f'', <br /> 0, <br />''float afMaxDistance = 20'' || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetIsDoor || bool abX || <br />
|-<br />
| bool || GetIsDoor || || <br />
|-<br />
| void || SetIsClosedDoor || bool abX || <br />
|-<br />
| bool || GetIsClosedDoor || || <br />
|-<br />
| void || UpdateEntityAttachment || || <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| void || PostUpdate || float afTimeStep || <br />
|-<br />
| void || VariableUpdate || float afDeltaTime || <br />
|-<br />
| bool || GetSaveDataIsUpdated || || <br />
|-<br />
| void || SetSaveDataIsUpdated || bool abX || <br />
|-<br />
| void || Timer_ClearAll || || <br />
|-<br />
| void || Timer_Add || uint64 alID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || uint64 alID || <br />
|-<br />
| bool || Timer_Exists || uint64 alID || <br />
|-<br />
| float || Timer_GetTimeLeft || uint64 alID || <br />
|-<br />
| void || Timer_SetPaused || uint64 alID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || uint64 alID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || uint64 alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Timer_Add || const [[tString]] &in asID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || const [[tString]] &in asID || <br />
|-<br />
| bool || Timer_Exists || const [[tString]] &in asID || <br />
|-<br />
| float || Timer_GetTimeLeft || const [[tString]] &in asID || <br />
|-<br />
| void || Timer_SetPaused || const [[tString]] &in asID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || const [[tString]] &in asID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || const [[tString]] &in asID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_ClearAll || || <br />
|-<br />
| void || Fader_FadeTo || uint alID, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || uint alID, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || uint alID, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || uint alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_FadeTo || const [[tString]] &in asName, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || const [[tString]] &in asName, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || const [[tString]] &in asName, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || const [[tString]] &in asName, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| float || GetDistanceToPlayer || || <br />
|-<br />
| float || GetDistanceToPlayer2D || || <br />
|-<br />
| float || GetDistanceToPos || const [[cVector3f]] &in avPos || <br />
|-<br />
| float || GetDistanceToPos2D || const [[cVector3f]] &in avPos || <br />
|-<br />
| const [[cVector3f]]& || GetPlayerPos || || <br />
|-<br />
| [[cVector3f]] || GetPlayerFeetPos || || <br />
|-<br />
| [[cVector3f]] || GetPlayerHeadPos || || <br />
|-<br />
| bool || GetPointIsInFOV || const [[cVector3f]] &in avPoint, <br />float afFOV, <br />const [[cVector3f]]& avForward || <br />
|-<br />
| bool || GetPlayerIsInFOV || float afFOV, <br />const [[cVector3f]]& avForward || <br />
|-<br />
| bool || GetEntityIsInPlayerFOV || || <br />
|-<br />
| bool || GetPlayerIsInLineOfSight || float afFOV, <br />const [[cVector3f]]& avForward, <br />bool abCheckFOV || <br />
|-<br />
| bool || GetPlayerIsInLineOfSight || || <br />
|-<br />
| float || GetPlayerMovementTowardEntity || || <br />
|-<br />
| float || GetAngleToPos2D || const [[cVector3f]] &in avPos || <br />
|-<br />
| float || GetAngleToPos3D || const [[cVector3f]] &in avPos || <br />
|-<br />
| float || GetAngleToPlayer2D || || <br />
|-<br />
| float || GetAngleToPlayer3D || || <br />
|-<br />
| bool || GetEntityIsInPlayerLineOfSight || bool abCheckFOV || <br />
|-<br />
| float || GetDistanceToGround || float afMaxTestDistance, <br />bool abCheckDynamic, <br />''int alNumOfRays = 1'', <br />''float afRadius = 0.25'', <br />''bool abGetShortest = true'' || <br />
|-<br />
| void || GetPlayerIsInLineOfSight || const [[tString]] &in asCallbackFunc, <br />float afFOV, <br />const [[cVector3f]]& avForward, <br />bool abCheckFOV || <br />
|-<br />
| void || GetPlayerIsInLineOfSight || const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || GetEntityIsInPlayerLineOfSight || const [[tString]] &in asCallbackFunc, <br />bool abCheckFOV || <br />
|-<br />
| void || GetDistanceToGround || const [[tString]] &in asCallbackFunc, <br />float afMaxTestDistance, <br />bool abCheckDynamic, <br />''int alNumOfRays = 1'', <br />''float afRadius = 0.25'', <br />''bool abGetClosest = true'' || <br />
|-<br />
| void || DoDamageBox || const [[cVector3f]] &in avSize, <br />const [[cVector3f]] &in avLocalOffset, <br />const [[cVector2f]] &in avMinMaxDamage, <br />float afForce, <br />float afMaxImpulse, <br />int aDamageType, <br />''float afHitSpeed = 2'', <br />''int alStrength = 0'', <br />''bool abCheckAgents = false'', <br />''bool abCheckPlayer = true'', <br />''bool abCheckProps = true'', <br />''bool abLethalForPlayer = true'' || <br />
|-<br />
| void || SetRelativeEyeHeight || float afX || <br />
|-<br />
| float || GetRelativeEyeHeight || || <br />
|-<br />
| [[cVector3f]] || GetEyePostion || || <br />
|-<br />
| int || GetDebugEyeRaysNum || || <br />
|-<br />
| const [[cVector3f]]& || GetDebugEyeRay || int alIdx || <br />
|-<br />
| void || SetStaticCollider || bool abX || <br />
|-<br />
| bool || GetStaticCollider || || <br />
|-<br />
| void || SetSensesActive || bool abX || <br />
|-<br />
| bool || GetSensesActive || || <br />
|-<br />
| void || SetPlayerDetectedMinTime || float afX || <br />
|-<br />
| float || GetPlayerDetectedCount || || <br />
|-<br />
| void || SetUpdatePlayerDetection || bool abX || <br />
|-<br />
| bool || SetUpdatePlayerDetection || || <br />
|-<br />
| bool || PlayerIsSeen || || <br />
|-<br />
| bool || PlayerIsDetected || || <br />
|-<br />
| void || ResetPlayerDetectionState || || <br />
|-<br />
| void || SetAutoDisableWhenOutOfSightActive || bool abX, <br />float afMinDistance || <br />
|-<br />
| void || SetAutoDisableCallback || const [[tString]] &in asFunc || <br />
|-<br />
| void || SetFOV || float afX || <br />
|-<br />
| float || GetFOV || || <br />
|-<br />
| void || SetFOVMul || float afX || <br />
|-<br />
| float || GetFOVMul || || <br />
|-<br />
| void || SetSightRange || float afX || <br />
|-<br />
| float || GetSightRange || || <br />
|-<br />
| float || GetSightRangeMul || || <br />
|-<br />
| void || SetSightRangeMul || float afX || <br />
|-<br />
| void || SetSightRangeAffectedByModifiers || bool abX || <br />
|-<br />
| bool || GetSightRangeAffectedByModifiers || || <br />
|-<br />
| const [[cVector3f]]& || GetLastKnownPlayerPos || || <br />
|-<br />
| float || GetDistFromLastKnownToActualPlayerPos || || <br />
|-<br />
| void || RevealPlayerPos || || <br />
|-<br />
| void || SetAlignEntityWithGroundRay || bool abX || <br />
|-<br />
| bool || GetAlignEntityWithGroundRay || || <br />
|-<br />
| const [[cVector3f]]& || GetGroundAlignPosition || || <br />
|-<br />
| void || SetAlignEntityWithGroundRelativeRayStart || float afX || <br />
|-<br />
| float || GetAlignEntityWithGroundRelativeRayStart || || <br />
|-<br />
| void || SetAlignEntityWithGroundMaxRayDistance || float afX || <br />
|-<br />
| float || GetAlignEntityWithGroundMaxRayDistance || || <br />
|-<br />
| float || GetCurrentPlayerSightDistance || || <br />
|-<br />
| void || SetCheckForDoors || bool abX || <br />
|-<br />
| bool || GetCheckForDoors || || <br />
|-<br />
| void || SetMaxCheckDoorDistance || float afX || <br />
|-<br />
| float || GetMaxCheckDoorDistance || || <br />
|-<br />
| void || SetCheckForDoorsCount || float afX || <br />
|-<br />
| [[iCharacterBody]]@ || GetCharBody || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/ephysicsjointspeed&diff=2524
HPL3/Community/Scripting/Classes/ephysicsjointspeed
2020-07-30T09:12:32Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==ePhysicsJointSpeed==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| ePhysicsJointSpeed_Linear || 0 || <br />
|-<br />
| ePhysicsJointSpeed_Angular || 1 || <br />
|-<br />
| ePhysicsJointSpeed_LastEnum || 2 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cpidcontrollerf&diff=2525
HPL3/Community/Scripting/Classes/cpidcontrollerf
2020-07-30T09:12:32Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cPidControllerf==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| p || float || <br />
|-<br />
| i || float || <br />
|-<br />
| d || float || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| float || Output || const float &in afError, <br />float afTimeStep || <br />
|-<br />
| void || SetErrorNum || int alErrorNum || <br />
|-<br />
| void || Reset || || <br />
|-<br />
| float || GetLastError || || <br />
|-<br />
| float || GetLastDerivative || || <br />
|-<br />
| float || GetLastIntegral || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cwidgetlabel&diff=2515
HPL3/Community/Scripting/Classes/cwidgetlabel
2020-07-30T09:12:31Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cWidgetLabel==<br />
<br />
===Fields===<br />
<br />
cWidgetLabel has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| bool || ProcessMessage || [[eGuiMessage]] aMessage, <br />const [[cGuiMessageData]] &in aData, <br />''bool abSkipVisCheck = false'', <br />''bool abSkipEnabledCheck = false'' || <br />
|-<br />
| [[eWidgetType]] || GetType || || <br />
|-<br />
| void || Init || || <br />
|-<br />
| [[cGuiGlobalShortcut]]@ || AddShortcut || int alKeyModifiers, <br />[[eKey]] aKey, <br />''[[eGuiMessage]] aMsg = eGuiMessage_ButtonPressed'', <br />''const [[cGuiMessageData]] &in aData = cGuiMessageData'', <br />''bool abBypassVisibility = true'', <br />''bool abBypassEnabled = true'' || <br />
|-<br />
| void || SetToolTip || const [[tWString]] &in asToolTip || <br />
|-<br />
| const [[tWString]]& || GetToolTip || || <br />
|-<br />
| void || SetToolTipEnabled || bool abX || <br />
|-<br />
| [[iWidget]]@ || GetToolTipWidget || || <br />
|-<br />
| bool || PointIsInside || const [[cVector2f]] &in avPoint, <br />bool abOnlyClipped || <br />
|-<br />
| void || AttachChild || [[iWidget]]@ apChild || <br />
|-<br />
| void || RemoveChild || [[iWidget]]@ apChild || <br />
|-<br />
| [[cGuiSet]]@ || GetSet || || <br />
|-<br />
| [[iWidget]]@ || GetParent || || <br />
|-<br />
| void || SetEnabled || bool abX || <br />
|-<br />
| bool || IsEnabled || || <br />
|-<br />
| void || SetVisible || bool abX || <br />
|-<br />
| bool || IsVisible || || <br />
|-<br />
| bool || HasFocus || || <br />
|-<br />
| bool || IsRightUnderMouse || || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetText || const [[tWString]] &in asText || <br />
|-<br />
| const [[tWString]]& || GetText || const || <br />
|-<br />
| [[iFontData]]@ || GetDefaultFontType || const || <br />
|-<br />
| void || SetDefaultFontType || [[iFontData]]@ apFont || <br />
|-<br />
| const [[cColor]]& || GetDefaultFontColor || const || <br />
|-<br />
| void || SetDefaultFontColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cVector2f]]& || GetDefaultFontSize || const || <br />
|-<br />
| void || SetDefaultFontSize || const [[cVector2f]] &in avSize || <br />
|-<br />
| void || SetClipActive || bool abX || <br />
|-<br />
| bool || GetClipActive || const || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetGlobalPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| const [[cVector3f]]& || GetLocalPosition || const || <br />
|-<br />
| const [[cVector3f]]& || GetGlobalPosition || || <br />
|-<br />
| void || SetChildrenOffset || const [[cVector3f]] &in || <br />
|-<br />
| const [[cVector3f]]& || GetChildrenOffset || const || <br />
|-<br />
| void || SetAffectedByScroll || bool abX || <br />
|-<br />
| void || SetScrollAmount || const [[cVector3f]] &in avX || <br />
|-<br />
| const [[cVector3f]]& || GetScrollAmount || const || <br />
|-<br />
| void || CenterGlobalPositionInSet || || <br />
|-<br />
| void || SetSize || const [[cVector2f]] &in avSize || <br />
|-<br />
| const [[cVector2f]]& || GetSize || const || <br />
|-<br />
| void || SetColorMul || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetColorMul || const || <br />
|-<br />
| bool || ClipsGraphics || || <br />
|-<br />
| bool || GetMouseIsOver || const || <br />
|-<br />
| bool || IsConnectedTo || [[iWidget]]@ apWidget, <br />''bool abIsStartWidget = true'' || <br />
|-<br />
| bool || IsConnectedToChildren || || <br />
|-<br />
| void || SetConnectedToChildren || bool abX || <br />
|-<br />
| [[cGuiGfxElement]]@ || GetPointerGfx || || <br />
|-<br />
| void || SetGlobalKeyPressListener || bool abX || <br />
|-<br />
| bool || IsGlobalKeyPressListener || const || <br />
|-<br />
| void || SetUserValue || int alX || <br />
|-<br />
| int || GetUserValue || const || <br />
|-<br />
| void || SetCallbacksDisabled || bool abX || <br />
|-<br />
| bool || GetCallbacksDisabled || const || <br />
|-<br />
| void || SetFocusNavigation || [[eUIArrow]] aDir, <br />[[iWidget]]@ apWidget || <br />
|-<br />
| [[iWidget]]@ || GetFocusNavigation || [[eUIArrow]] aDir || <br />
|-<br />
| bool || HasFocusNavigation || || <br />
|-<br />
| void || SetGlobalUIInputListener || bool abX || <br />
|-<br />
| bool || IsGlobalUIInputListener || || <br />
|-<br />
| void || SetTextAlign || [[eFontAlign]] aType || <br />
|-<br />
| [[eFontAlign]] || GetTextAlign || || <br />
|-<br />
| bool || GetWordWrap || || <br />
|-<br />
| void || SetWordWrap || bool abX || <br />
|-<br />
| void || SetMaxTextLength || int alLength || <br />
|-<br />
| int || GetMaxTextLength || || <br />
|-<br />
| void || SetAutogenerateSize || bool abX || <br />
|-<br />
| bool || GetAutogenerateSize || || <br />
|-<br />
| void || SetDrawBackGround || bool abX || <br />
|-<br />
| bool || GetDrawBackGround || || <br />
|-<br />
| void || SetBackGroundColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetBackGroundColor || || <br />
|-<br />
| void || SetScrollWaitTime || float afX || <br />
|-<br />
| float || GetScrollWaitTime || || <br />
|-<br />
| void || SetScrollOffset || float afX || <br />
|-<br />
| void || SetScrollSpeedMul || float afX || <br />
|-<br />
| float || GetScrollSpeedMul || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxscreentexticon&diff=2516
HPL3/Community/Scripting/Classes/cluxscreentexticon
2020-07-30T09:12:31Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxScreenTextIcon==<br />
<br />
===Fields===<br />
<br />
cLuxScreenTextIcon has no public fields.<br />
<br />
===Functions===<br />
<br />
cLuxScreenTextIcon has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cwidgetwindow&diff=2517
HPL3/Community/Scripting/Classes/cwidgetwindow
2020-07-30T09:12:31Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cWidgetWindow==<br />
<br />
===Fields===<br />
<br />
cWidgetWindow has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| bool || ProcessMessage || [[eGuiMessage]] aMessage, <br />const [[cGuiMessageData]] &in aData, <br />''bool abSkipVisCheck = false'', <br />''bool abSkipEnabledCheck = false'' || <br />
|-<br />
| [[eWidgetType]] || GetType || || <br />
|-<br />
| void || Init || || <br />
|-<br />
| [[cGuiGlobalShortcut]]@ || AddShortcut || int alKeyModifiers, <br />[[eKey]] aKey, <br />''[[eGuiMessage]] aMsg = eGuiMessage_ButtonPressed'', <br />''const [[cGuiMessageData]] &in aData = cGuiMessageData'', <br />''bool abBypassVisibility = true'', <br />''bool abBypassEnabled = true'' || <br />
|-<br />
| void || SetToolTip || const [[tWString]] &in asToolTip || <br />
|-<br />
| const [[tWString]]& || GetToolTip || || <br />
|-<br />
| void || SetToolTipEnabled || bool abX || <br />
|-<br />
| [[iWidget]]@ || GetToolTipWidget || || <br />
|-<br />
| bool || PointIsInside || const [[cVector2f]] &in avPoint, <br />bool abOnlyClipped || <br />
|-<br />
| void || AttachChild || [[iWidget]]@ apChild || <br />
|-<br />
| void || RemoveChild || [[iWidget]]@ apChild || <br />
|-<br />
| [[cGuiSet]]@ || GetSet || || <br />
|-<br />
| [[iWidget]]@ || GetParent || || <br />
|-<br />
| void || SetEnabled || bool abX || <br />
|-<br />
| bool || IsEnabled || || <br />
|-<br />
| void || SetVisible || bool abX || <br />
|-<br />
| bool || IsVisible || || <br />
|-<br />
| bool || HasFocus || || <br />
|-<br />
| bool || IsRightUnderMouse || || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetText || const [[tWString]] &in asText || <br />
|-<br />
| const [[tWString]]& || GetText || const || <br />
|-<br />
| [[iFontData]]@ || GetDefaultFontType || const || <br />
|-<br />
| void || SetDefaultFontType || [[iFontData]]@ apFont || <br />
|-<br />
| const [[cColor]]& || GetDefaultFontColor || const || <br />
|-<br />
| void || SetDefaultFontColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cVector2f]]& || GetDefaultFontSize || const || <br />
|-<br />
| void || SetDefaultFontSize || const [[cVector2f]] &in avSize || <br />
|-<br />
| void || SetClipActive || bool abX || <br />
|-<br />
| bool || GetClipActive || const || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetGlobalPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| const [[cVector3f]]& || GetLocalPosition || const || <br />
|-<br />
| const [[cVector3f]]& || GetGlobalPosition || || <br />
|-<br />
| void || SetChildrenOffset || const [[cVector3f]] &in || <br />
|-<br />
| const [[cVector3f]]& || GetChildrenOffset || const || <br />
|-<br />
| void || SetAffectedByScroll || bool abX || <br />
|-<br />
| void || SetScrollAmount || const [[cVector3f]] &in avX || <br />
|-<br />
| const [[cVector3f]]& || GetScrollAmount || const || <br />
|-<br />
| void || CenterGlobalPositionInSet || || <br />
|-<br />
| void || SetSize || const [[cVector2f]] &in avSize || <br />
|-<br />
| const [[cVector2f]]& || GetSize || const || <br />
|-<br />
| void || SetColorMul || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetColorMul || const || <br />
|-<br />
| bool || ClipsGraphics || || <br />
|-<br />
| bool || GetMouseIsOver || const || <br />
|-<br />
| bool || IsConnectedTo || [[iWidget]]@ apWidget, <br />''bool abIsStartWidget = true'' || <br />
|-<br />
| bool || IsConnectedToChildren || || <br />
|-<br />
| void || SetConnectedToChildren || bool abX || <br />
|-<br />
| [[cGuiGfxElement]]@ || GetPointerGfx || || <br />
|-<br />
| void || SetGlobalKeyPressListener || bool abX || <br />
|-<br />
| bool || IsGlobalKeyPressListener || const || <br />
|-<br />
| void || SetUserValue || int alX || <br />
|-<br />
| int || GetUserValue || const || <br />
|-<br />
| void || SetCallbacksDisabled || bool abX || <br />
|-<br />
| bool || GetCallbacksDisabled || const || <br />
|-<br />
| void || SetFocusNavigation || [[eUIArrow]] aDir, <br />[[iWidget]]@ apWidget || <br />
|-<br />
| [[iWidget]]@ || GetFocusNavigation || [[eUIArrow]] aDir || <br />
|-<br />
| bool || HasFocusNavigation || || <br />
|-<br />
| void || SetGlobalUIInputListener || bool abX || <br />
|-<br />
| bool || IsGlobalUIInputListener || || <br />
|-<br />
| void || SetStatic || bool abX || <br />
|-<br />
| bool || GetStatic || || <br />
|-<br />
| void || SetDrawLabel || bool abX || <br />
|-<br />
| void || SetCloseButtonDisablesWindow || bool abX || <br />
|-<br />
| bool || GetCloseButtonDisablesWindow || || <br />
|-<br />
| void || SetEscapeKeyClosesWindow || bool abX || <br />
|-<br />
| bool || GetEscapeKeyClosesWindow || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxentitycomponentiterator&diff=2518
HPL3/Community/Scripting/Classes/cluxentitycomponentiterator
2020-07-30T09:12:31Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxEntityComponentIterator==<br />
<br />
===Fields===<br />
<br />
cLuxEntityComponentIterator has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| bool || HasNext || || <br />
|-<br />
| [[iLuxEntityComponent]]@ || Next || || <br />
|-<br />
| [[iLuxEntityComponent]]@ || PeekNext || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxsoundscapehandler&diff=2519
HPL3/Community/Scripting/Classes/cluxsoundscapehandler
2020-07-30T09:12:31Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxSoundscapeHandler==<br />
<br />
===Fields===<br />
<br />
cLuxSoundscapeHandler has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetCurrentSoundPrefix || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cmeshcollider&diff=2520
HPL3/Community/Scripting/Classes/cmeshcollider
2020-07-30T09:12:31Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cMeshCollider==<br />
<br />
===Fields===<br />
<br />
cMeshCollider has no public fields.<br />
<br />
===Functions===<br />
<br />
cMeshCollider has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxmusichandler&diff=2510
HPL3/Community/Scripting/Classes/cluxmusichandler
2020-07-30T09:12:30Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxMusicHandler==<br />
<br />
===Fields===<br />
<br />
cLuxMusicHandler has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || Play || const [[tString]]& asFile, <br />bool abLoop, <br />float afVolume, <br />float afFreq, <br />float afVolumeFadeTime, <br />float afFreqFadeTime, <br />int alPrio, <br />bool abResume, <br />bool abSpecialEffect || <br />
|-<br />
| void || Stop || float afFadeTime, <br />int alPrio || <br />
|-<br />
| void || AddDynamicTrack || [[tID]] a_idEntity, <br />int alTrackPrio, <br />int alMusicPrio, <br />const [[tString]] &in asFile, <br />float afVolume, <br />float afFadeInTime, <br />float afFadeOutTime || <br />
|-<br />
| void || RemoveDynamicTrack || [[tID]] a_idEntity || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/csubmeshentity&diff=2511
HPL3/Community/Scripting/Classes/csubmeshentity
2020-07-30T09:12:30Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cSubMeshEntity==<br />
<br />
===Fields===<br />
<br />
cSubMeshEntity has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| [[eEntityType]] || GetEntityType || || <br />
|-<br />
| [[tID]] || GetID || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| void || UpdateLogic || float afTimeStep || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| bool || HasParent || || <br />
|-<br />
| bool || IsActive || const || <br />
|-<br />
| void || SetActive || bool abActive || <br />
|-<br />
| [[cVector3f]] || GetLocalPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetLocalMatrix || || <br />
|-<br />
| [[cVector3f]] || GetWorldPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetWorldMatrix || || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetWorldPosition || const [[cVector3f]] &in avWorldPos || <br />
|-<br />
| void || SetWorldMatrix || const [[cMatrixf]] &in a_mtxWorldTransform || <br />
|-<br />
| int || GetTransformUpdateCount || || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetBoundingVolume || || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| void || AddChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| void || RemoveChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| bool || IsChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| [[iEntity3D]]@ || GetEntityParent || || <br />
|-<br />
| [[cEntity3DIterator]]@ || GetChildIterator || || <br />
|-<br />
| const [[tString]]& || GetRenderName || || <br />
|-<br />
| [[cMaterial]]@ || GetMaterial || || <br />
|-<br />
| [[iVertexBuffer]]@ || GetVertexBuffer || || <br />
|-<br />
| bool || CollidesWithBV || [[cBoundingVolume]]@+ apBV || <br />
|-<br />
| bool || CollidesWithFrustum || [[cFrustum]]@ apFrustum || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetRenderBV || || <br />
|-<br />
| [[cVector3f]] || GetWorldCenterPosition || || <br />
|-<br />
| [[eRenderableType]] || GetRenderType || || <br />
|-<br />
| void || SetRenderFlagBit || int alFlagBit, <br />bool abSet || <br />
|-<br />
| bool || GetRenderFlagBit || int alFlagBit || <br />
|-<br />
| int || GetRenderFlags || const || <br />
|-<br />
| bool || IsStatic || || <br />
|-<br />
| bool || IsOccluder || || <br />
|-<br />
| bool || IsVisible || || <br />
|-<br />
| void || SetVisible || bool abVisible || <br />
|-<br />
| bool || GetVisibleVar || || <br />
|-<br />
| void || SetIlluminationColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetIlluminationColor || const || <br />
|-<br />
| void || SetCoverageAmount || float afX || <br />
|-<br />
| float || GetCoverageAmount || const || <br />
|-<br />
| int || GetMatrixUpdateCount || || <br />
|-<br />
| int || GetRenderFrameCount || const || <br />
|-<br />
| void || SetRenderFrameCount || int alCount || <br />
|-<br />
| void || UseAutomaticLiquidAmount || float 0 || <br />
|-<br />
| void || SetLiquidAmount || float afX || <br />
|-<br />
| float || GetLiquidAmount || const || <br />
|-<br />
| [[cSubMesh]]@ || GetSubMesh || const || <br />
|-<br />
| void || SetLocalNode || [[cNode3D]]@ apNode || <br />
|-<br />
| [[cNode3D]]@ || GetLocalNode || || <br />
|-<br />
| void || SetCustomMaterial || [[cMaterial]]@ apMaterial, <br />bool abDestroyOldCustom || <br />
|-<br />
| [[cMaterial]]@ || GetCustomMaterial || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cposteffect_fxaa&diff=2512
HPL3/Community/Scripting/Classes/cposteffect fxaa
2020-07-30T09:12:30Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cPostEffect_FXAA==<br />
<br />
===Fields===<br />
<br />
cPostEffect_FXAA has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || SetDisabled || bool abX || <br />
|-<br />
| bool || IsDisabled || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| void || Reset || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cdate&diff=2513
HPL3/Community/Scripting/Classes/cdate
2020-07-30T09:12:30Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cDate==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| seconds || int || <br />
|-<br />
| minutes || int || <br />
|-<br />
| hours || int || <br />
|-<br />
| month_day || int || <br />
|-<br />
| month || int || <br />
|-<br />
| year || int || <br />
|-<br />
| week_day || int || <br />
|-<br />
| year_day || int || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
cDate has no public functions<br />
<br />
===Remarks===<br />
<br />
To get the current date, use the [[hpl3:game:scripting:function_reference:hps_api#csystem_getdate|cSystem_GetDate]] function.</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/elensflaretype&diff=2514
HPL3/Community/Scripting/Classes/elensflaretype
2020-07-30T09:12:30Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eLensFlareType==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eLensFlareType_AnamorphicFlare || 0 || <br />
|-<br />
| eLensFlareType_Halo || 1 || <br />
|-<br />
| eLensFlareType_MultiIris || 2 || <br />
|-<br />
| eLensFlareType_LastEnum || 3 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cnode3d&diff=2505
HPL3/Community/Scripting/Classes/cnode3d
2020-07-30T09:12:29Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cNode3D==<br />
<br />
===Fields===<br />
<br />
cNode3D has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| bool || AddEntity || [[iEntity3D]]@ apEntity || <br />
|-<br />
| bool || RemoveEntity || [[iEntity3D]]@ apEntity || <br />
|-<br />
| void || ClearEntities || || <br />
|-<br />
| [[cNode3D]]@ || GetParent || || <br />
|-<br />
| [[cNode3DIterator]]@ || GetChildIterator || || <br />
|-<br />
| [[cNode3D]]@ || CreateChild || const [[tString]]& asName, <br />bool true || <br />
|-<br />
| void || RemoveChild || [[cNode3D]]@ apNode || <br />
|-<br />
| void || SetParent || [[cNode3D]]@ apNode || <br />
|-<br />
| void || AddChild || [[cNode3D]]@ apChild || <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| int || SetVisible || bool abX, <br />bool abCascade || <br />
|-<br />
| [[cVector3f]] || GetLocalPosition || || <br />
|-<br />
| const [[cMatrixf]]& || GetLocalMatrix || || <br />
|-<br />
| [[cVector3f]] || GetWorldPosition || || <br />
|-<br />
| const [[cMatrixf]]& || GetWorldMatrix || || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform, <br />''bool abSetChildrenUpdated = true'' || <br />
|-<br />
| void || SetWorldPosition || const [[cVector3f]] &in avWorldPos || <br />
|-<br />
| void || SetWorldMatrix || const [[cMatrixf]] &in a_mtxWorldTransform || <br />
|-<br />
| void || AddRotation || const [[cVector3f]] &in avRot, <br />[[eEulerRotationOrder]] aOrder || <br />
|-<br />
| void || AddRotation || const [[cQuaternion]] &in aqRotation, <br />bool true || <br />
|-<br />
| void || NormalizeRotation || || <br />
|-<br />
| void || AddScale || const [[cVector3f]] &in avScale || <br />
|-<br />
| void || AddTranslation || const [[cVector3f]] &in avTrans || <br />
|-<br />
| bool || GetUsePreAnimTransform || || <br />
|-<br />
| bool || GetUsePostAnimTransform || || <br />
|-<br />
| const [[cMatrixf]]& || GetPreAnimTransform || || <br />
|-<br />
| const [[cMatrixf]]& || GetPostAnimTransform || || <br />
|-<br />
| void || SetUsePreTransform || bool abX || <br />
|-<br />
| void || SetUsePostTransform || bool abX || <br />
|-<br />
| void || SetPreTransform || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetPostTransform || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || ApplyPreAnimTransform || bool abSetChildrenUpdated || <br />
|-<br />
| void || ApplyPostAnimTransform || bool abSetChildrenUpdated || <br />
|-<br />
| void || SetCustomFlags || int alX || <br />
|-<br />
| int || GetCustomFlags || || <br />
|-<br />
| void || UpdateMatrix || bool abSetChildrenUpdated || <br />
|-<br />
| void || UpdateEntityChildren || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/ceventtrigger&diff=2506
HPL3/Community/Scripting/Classes/ceventtrigger
2020-07-30T09:12:29Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cEventTrigger==<br />
<br />
===Fields===<br />
<br />
cEventTrigger has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| int || GetId || const || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cimguigfx&diff=2507
HPL3/Community/Scripting/Classes/cimguigfx
2020-07-30T09:12:29Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cImGuiGfx==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| mMaterial || [[eGuiMaterial]] || <br />
|-<br />
| mColor || [[cColor]] || <br />
|-<br />
| mType || [[eImGuiGfx]] || <br />
|-<br />
| mWrapMode || [[eImGuiWrapMode]] || <br />
|-<br />
| mvOffset || [[cVector3f]] || <br />
|-<br />
| mfAnimationTime || float || <br />
|-<br />
| mbCrossfadeAnimation || bool || <br />
|-<br />
| mvUVMin || [[cVector2f]] || <br />
|-<br />
| mvUVMax || [[cVector2f]] || <br />
|-<br />
| mbUVFlipH || bool || <br />
|-<br />
| mbUVFlipV || bool || <br />
|-<br />
| mColorCornerTopLeft || [[cColor]] || <br />
|-<br />
| mColorCornerTopRight || [[cColor]] || <br />
|-<br />
| mColorCornerBotRight || [[cColor]] || <br />
|-<br />
| mColorCornerBotLeft || [[cColor]] || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || SetFile || const [[tString]] &in asFile || <br />
|-<br />
| const [[tString]]& || GetFile || const || <br />
|-<br />
| uint64 || GetId || || <br />
|-<br />
| void || CopyFrom || const [[cImGuiGfx]]& aGfx || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cwidgetcollapsiblepane&diff=2508
HPL3/Community/Scripting/Classes/cwidgetcollapsiblepane
2020-07-30T09:12:29Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cWidgetCollapsiblePane==<br />
<br />
===Fields===<br />
<br />
cWidgetCollapsiblePane has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| bool || ProcessMessage || [[eGuiMessage]] aMessage, <br />const [[cGuiMessageData]] &in aData, <br />''bool abSkipVisCheck = false'', <br />''bool abSkipEnabledCheck = false'' || <br />
|-<br />
| [[eWidgetType]] || GetType || || <br />
|-<br />
| void || Init || || <br />
|-<br />
| [[cGuiGlobalShortcut]]@ || AddShortcut || int alKeyModifiers, <br />[[eKey]] aKey, <br />''[[eGuiMessage]] aMsg = eGuiMessage_ButtonPressed'', <br />''const [[cGuiMessageData]] &in aData = cGuiMessageData'', <br />''bool abBypassVisibility = true'', <br />''bool abBypassEnabled = true'' || <br />
|-<br />
| void || SetToolTip || const [[tWString]] &in asToolTip || <br />
|-<br />
| const [[tWString]]& || GetToolTip || || <br />
|-<br />
| void || SetToolTipEnabled || bool abX || <br />
|-<br />
| [[iWidget]]@ || GetToolTipWidget || || <br />
|-<br />
| bool || PointIsInside || const [[cVector2f]] &in avPoint, <br />bool abOnlyClipped || <br />
|-<br />
| void || AttachChild || [[iWidget]]@ apChild || <br />
|-<br />
| void || RemoveChild || [[iWidget]]@ apChild || <br />
|-<br />
| [[cGuiSet]]@ || GetSet || || <br />
|-<br />
| [[iWidget]]@ || GetParent || || <br />
|-<br />
| void || SetEnabled || bool abX || <br />
|-<br />
| bool || IsEnabled || || <br />
|-<br />
| void || SetVisible || bool abX || <br />
|-<br />
| bool || IsVisible || || <br />
|-<br />
| bool || HasFocus || || <br />
|-<br />
| bool || IsRightUnderMouse || || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetText || const [[tWString]] &in asText || <br />
|-<br />
| const [[tWString]]& || GetText || const || <br />
|-<br />
| [[iFontData]]@ || GetDefaultFontType || const || <br />
|-<br />
| void || SetDefaultFontType || [[iFontData]]@ apFont || <br />
|-<br />
| const [[cColor]]& || GetDefaultFontColor || const || <br />
|-<br />
| void || SetDefaultFontColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cVector2f]]& || GetDefaultFontSize || const || <br />
|-<br />
| void || SetDefaultFontSize || const [[cVector2f]] &in avSize || <br />
|-<br />
| void || SetClipActive || bool abX || <br />
|-<br />
| bool || GetClipActive || const || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetGlobalPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| const [[cVector3f]]& || GetLocalPosition || const || <br />
|-<br />
| const [[cVector3f]]& || GetGlobalPosition || || <br />
|-<br />
| void || SetChildrenOffset || const [[cVector3f]] &in || <br />
|-<br />
| const [[cVector3f]]& || GetChildrenOffset || const || <br />
|-<br />
| void || SetAffectedByScroll || bool abX || <br />
|-<br />
| void || SetScrollAmount || const [[cVector3f]] &in avX || <br />
|-<br />
| const [[cVector3f]]& || GetScrollAmount || const || <br />
|-<br />
| void || CenterGlobalPositionInSet || || <br />
|-<br />
| void || SetSize || const [[cVector2f]] &in avSize || <br />
|-<br />
| const [[cVector2f]]& || GetSize || const || <br />
|-<br />
| void || SetColorMul || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetColorMul || const || <br />
|-<br />
| bool || ClipsGraphics || || <br />
|-<br />
| bool || GetMouseIsOver || const || <br />
|-<br />
| bool || IsConnectedTo || [[iWidget]]@ apWidget, <br />''bool abIsStartWidget = true'' || <br />
|-<br />
| bool || IsConnectedToChildren || || <br />
|-<br />
| void || SetConnectedToChildren || bool abX || <br />
|-<br />
| [[cGuiGfxElement]]@ || GetPointerGfx || || <br />
|-<br />
| void || SetGlobalKeyPressListener || bool abX || <br />
|-<br />
| bool || IsGlobalKeyPressListener || const || <br />
|-<br />
| void || SetUserValue || int alX || <br />
|-<br />
| int || GetUserValue || const || <br />
|-<br />
| void || SetCallbacksDisabled || bool abX || <br />
|-<br />
| bool || GetCallbacksDisabled || const || <br />
|-<br />
| void || SetFocusNavigation || [[eUIArrow]] aDir, <br />[[iWidget]]@ apWidget || <br />
|-<br />
| [[iWidget]]@ || GetFocusNavigation || [[eUIArrow]] aDir || <br />
|-<br />
| bool || HasFocusNavigation || || <br />
|-<br />
| void || SetGlobalUIInputListener || bool abX || <br />
|-<br />
| bool || IsGlobalUIInputListener || || <br />
|-<br />
| bool || IsExpanded || || <br />
|-<br />
| void || SetExpanded || bool abX || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/ceventscene&diff=2509
HPL3/Community/Scripting/Classes/ceventscene
2020-07-30T09:12:29Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cEventScene==<br />
<br />
===Fields===<br />
<br />
cEventScene has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| int || GetId || const || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/eimguioffset&diff=2500
HPL3/Community/Scripting/Classes/eimguioffset
2020-07-30T09:12:28Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eImGuiOffset==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eImGuiOffset_Root || 0 || <br />
|-<br />
| eImGuiOffset_Group || 1 || <br />
|-<br />
| eImGuiOffset_Layout || 2 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxdialoghandler&diff=2501
HPL3/Community/Scripting/Classes/cluxdialoghandler
2020-07-30T09:12:28Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxDialogHandler==<br />
<br />
===Fields===<br />
<br />
cLuxDialogHandler has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || Begin || const [[tString]]& asName || <br />
|-<br />
| void || End || const [[tString]] &in asStartBranch || <br />
|-<br />
| void || SetCallbackFunc || const [[tString]] &in asFunc || <br />
|-<br />
| void || GetCharactersInSubject || const [[tString]] &in asSubject, <br /> avOutCharacters || <br />
|-<br />
| void || AddBranch || const [[tString]] &in asName, <br />const [[tString]] &in asNextBranch || <br />
|-<br />
| void || AddBranchSubject || const [[tString]] &in asSubject, <br />const [[tString]] &in asCallback || <br />
|-<br />
| void || AddBranchPause || float afTime, <br />const [[tString]] &in asCallback || <br />
|-<br />
| void || AddBranchEvent || [[eLuxDialogBranchEvent]] aType, <br />float afVar, <br />const [[tString]] &in asVar, <br />const [[tString]] &in asNewBranch, <br />bool abOnlyCheckEndOfSubject || <br />
|-<br />
| void || SetResponseTimeLimit || float afTime || <br />
|-<br />
| void || AddResponseOption || const [[tString]]& asEntry, <br />const [[tString]] &in asBranch, <br />int alId, <br />const [[tString]] &in asCallback || <br />
|-<br />
| void || AddResponseCondition || [[eLuxDialogOptionCondition]] aCondition, <br />const [[tString]] &in asVarName, <br />int alValue || <br />
|-<br />
| void || AddResponseEvent || [[eLuxDialogOptionEvent]] aEvent, <br />const [[tString]] &in asVarName, <br />int alValue || <br />
|-<br />
| bool || CharacterIsActive || const [[tString]] &in asName || <br />
|-<br />
| void || Stop || const [[tString]]& asName || <br />
|-<br />
| void || StopAll || || <br />
|-<br />
| [[tString]] || GetCharacterScene || const [[tString]] &in asCharacterName || <br />
|-<br />
| void || ReturnResponseSelectChoice || int alSelectedOption || <br />
|-<br />
| void || SetVar || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || IncVar || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| int || GetVar || const [[tString]] &in asName || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/ccolor&diff=2502
HPL3/Community/Scripting/Classes/ccolor
2020-07-30T09:12:28Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cColor==<br />
<br />
=== Constructors ===<br />
<br />
{| class="wikitable sortable" border=1<br />
!Constructor !!Description |<br />
|-<br />
| cColor() || Creates a color with a default value of opaque black. <br />
|-<br />
| cColor(float, float) || Creates a color with the first parameter given to all the RGB values (the color will be a shade of grey) and the second parameter given to the alpha channel. <br />
|-<br />
| cColor(float, float, float) || Creates an opaque color using the given values as RGB data. <br />
|-<br />
| cColor(float, float, float, float) || Creates a color using the given values as RGBA data. <br />
|-<br />
|}<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| r || float || The value of the red channel. <br />
|-<br />
| g || float || The value of the green channel. <br />
|-<br />
| b || float || The value of the blue channel. <br />
|-<br />
| a || float || The value of the alpha channel. <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| [[cColor]] || ToLinearSpace || const float afPower, <br />const bool abCorrectAlpha, <br />const || Returns the color converted into the linear space. <br />
|-<br />
| [[cColor]] || ToSRGB || const bool abCorrectAlpha, <br />const || Returns the color converted into the [[wp>sRGB || sRGB]] space. <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Color channel values are stored using a 0.0 - 1.0 range, where 0.0 is equal to 0 and 1.0 is equal to 255.<br />
<br />
Read [http://stackoverflow.com/questions/12524623/what-are-the-practical-differences-when-working-with-colors-in-a-linear-vs-a-no this post on StackOverflow] for an explanation on the differences between the linear color space and the sRGB color space.</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cguimessagedata&diff=2503
HPL3/Community/Scripting/Classes/cguimessagedata
2020-07-30T09:12:28Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cGuiMessageData==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| mvPos || [[cVector2f]] || <br />
|-<br />
| mvRel || [[cVector2f]] || <br />
|-<br />
| mlVal || int || <br />
|-<br />
| mKeyPress || [[cKeyPress]] || <br />
|-<br />
| mfVal || float || <br />
|-<br />
| mMessage || [[eGuiMessage]] || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
cGuiMessageData has no public functions<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/esoundentitydatatype&diff=2504
HPL3/Community/Scripting/Classes/esoundentitydatatype
2020-07-30T09:12:28Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eSoundEntityDataType==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eSoundEntityDataType_SoundEntityData || 0 || <br />
|-<br />
| eSoundEntityDataType_SoundFile || 1 || <br />
|-<br />
| eSoundEntityDataType_SoundEvent || 2 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/eluxdialogoptioncondition&diff=2494
HPL3/Community/Scripting/Classes/eluxdialogoptioncondition
2020-07-30T09:12:27Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eLuxDialogOptionCondition==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eLuxDialogOptionCondition_VarEqual || 0 || <br />
|-<br />
| eLuxDialogOptionCondition_VarLesser || 1 || <br />
|-<br />
| eLuxDialogOptionCondition_VarGreater || 2 || <br />
|-<br />
| eLuxDialogOptionCondition_LastEnum || 3 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cimguifont&diff=2495
HPL3/Community/Scripting/Classes/cimguifont
2020-07-30T09:12:27Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cImGuiFont==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| mMaterial || [[eGuiMaterial]] || <br />
|-<br />
| mColor || [[cColor]] || <br />
|-<br />
| mvSize || [[cVector2f]] || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || SetFile || const [[tString]] &in asFile || <br />
|-<br />
| const [[tString]]& || GetFile || const || <br />
|-<br />
| uint64 || GetId || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/iphysicsjoint&diff=2496
HPL3/Community/Scripting/Classes/iphysicsjoint
2020-07-30T09:12:27Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==iPhysicsJoint==<br />
<br />
===Fields===<br />
<br />
iPhysicsJoint has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| [[tID]] || GetID || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetParentBody || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetChildBody || || <br />
|-<br />
| void || RemoveBody || [[iPhysicsBody]]@ apBody || <br />
|-<br />
| const [[cVector3f]]& || GetPivotPoint || || <br />
|-<br />
| const [[cVector3f]]& || GetPinDir || || <br />
|-<br />
| [[ePhysicsJointType]] || GetType || || <br />
|-<br />
| void || SetCollideBodies || bool abX || <br />
|-<br />
| bool || GetCollideBodies || || <br />
|-<br />
| void || SetStiffness || float afX || <br />
|-<br />
| float || GetStiffness || || <br />
|-<br />
| [[cVector3f]] || GetVelocity || || <br />
|-<br />
| [[cVector3f]] || GetAngularVelocity || || <br />
|-<br />
| float || GetForceSize || || <br />
|-<br />
| float || GetDistance || || <br />
|-<br />
| float || GetAngle || || <br />
|-<br />
| void || SetBreakable || bool abX || <br />
|-<br />
| bool || IsBreakable || || <br />
|-<br />
| void || SetLimitAutoSleep || bool abX || <br />
|-<br />
| bool || GetLimitAutoSleep || || <br />
|-<br />
| void || SetStickyMinLimit || bool abX || <br />
|-<br />
| void || SetStickyMaxLimit || bool abX || <br />
|-<br />
| bool || GetStickyMinLimit || || <br />
|-<br />
| bool || GetStickyMaxLimit || || <br />
|-<br />
| void || Break || || <br />
|-<br />
| bool || IsBroken || || <br />
|-<br />
| void || SetMoveSound || [[tString]] &in asName || <br />
|-<br />
| void || SetMoveSpeedType || [[ePhysicsJointSpeed]] aType || <br />
|-<br />
| void || SetMinMoveSpeed || float afX || <br />
|-<br />
| void || SetAllowPositionReset || bool abX || <br />
|-<br />
| bool || GetAllowPositionReset || || <br />
|-<br />
| void || SetMinLimitSound || const [[tString]] &in asSound, <br />float afMinSpeed || <br />
|-<br />
| void || SetMaxLimitSound || const [[tString]] &in asSound, <br />float afMinSpeed || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/eimguistatevar&diff=2497
HPL3/Community/Scripting/Classes/eimguistatevar
2020-07-30T09:12:27Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eImGuiStateVar==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eImGuiStateVar_Triggered || 0 || <br />
|-<br />
| eImGuiStateVar_RepeatTimer || 1 || <br />
|-<br />
| eImGuiStateVar_Value || 2 || <br />
|-<br />
| eImGuiStateVar_ValueDefault || 3 || <br />
|-<br />
| eImGuiStateVar_Checked || 4 || <br />
|-<br />
| eImGuiStateVar_CheckedDefault || 5 || <br />
|-<br />
| eImGuiStateVar_SelectedItem || 6 || <br />
|-<br />
| eImGuiStateVar_SelectedItemDefault || 7 || <br />
|-<br />
| eImGuiStateVar_LastEnum || 8 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cropeentitybillboard&diff=2498
HPL3/Community/Scripting/Classes/cropeentitybillboard
2020-07-30T09:12:27Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cRopeEntityBillboard==<br />
<br />
===Fields===<br />
<br />
cRopeEntityBillboard has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| [[eEntityType]] || GetEntityType || || <br />
|-<br />
| [[tID]] || GetID || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| void || UpdateLogic || float afTimeStep || <br />
|-<br />
| const [[tString]]& || GetName || const || <br />
|-<br />
| void || SetName || const [[tString]] &in asName || <br />
|-<br />
| bool || HasParent || || <br />
|-<br />
| bool || IsActive || const || <br />
|-<br />
| void || SetActive || bool abActive || <br />
|-<br />
| [[cVector3f]] || GetLocalPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetLocalMatrix || || <br />
|-<br />
| [[cVector3f]] || GetWorldPosition || || <br />
|-<br />
| [[cMatrixf]]& || GetWorldMatrix || || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetWorldPosition || const [[cVector3f]] &in avWorldPos || <br />
|-<br />
| void || SetWorldMatrix || const [[cMatrixf]] &in a_mtxWorldTransform || <br />
|-<br />
| int || GetTransformUpdateCount || || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetBoundingVolume || || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| void || AddChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| void || RemoveChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| bool || IsChild || [[iEntity3D]]@ apEntity || <br />
|-<br />
| [[iEntity3D]]@ || GetEntityParent || || <br />
|-<br />
| [[cEntity3DIterator]]@ || GetChildIterator || || <br />
|-<br />
| const [[tString]]& || GetRenderName || || <br />
|-<br />
| [[cMaterial]]@ || GetMaterial || || <br />
|-<br />
| [[iVertexBuffer]]@ || GetVertexBuffer || || <br />
|-<br />
| bool || CollidesWithBV || [[cBoundingVolume]]@+ apBV || <br />
|-<br />
| bool || CollidesWithFrustum || [[cFrustum]]@ apFrustum || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetRenderBV || || <br />
|-<br />
| [[cVector3f]] || GetWorldCenterPosition || || <br />
|-<br />
| [[eRenderableType]] || GetRenderType || || <br />
|-<br />
| void || SetRenderFlagBit || int alFlagBit, <br />bool abSet || <br />
|-<br />
| bool || GetRenderFlagBit || int alFlagBit || <br />
|-<br />
| int || GetRenderFlags || const || <br />
|-<br />
| bool || IsStatic || || <br />
|-<br />
| bool || IsOccluder || || <br />
|-<br />
| bool || IsVisible || || <br />
|-<br />
| void || SetVisible || bool abVisible || <br />
|-<br />
| bool || GetVisibleVar || || <br />
|-<br />
| void || SetIlluminationColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetIlluminationColor || const || <br />
|-<br />
| void || SetCoverageAmount || float afX || <br />
|-<br />
| float || GetCoverageAmount || const || <br />
|-<br />
| int || GetMatrixUpdateCount || || <br />
|-<br />
| int || GetRenderFrameCount || const || <br />
|-<br />
| void || SetRenderFrameCount || int alCount || <br />
|-<br />
| void || UseAutomaticLiquidAmount || float 0 || <br />
|-<br />
| void || SetLiquidAmount || float afX || <br />
|-<br />
| float || GetLiquidAmount || const || <br />
|-<br />
| [[iPhysicsRope]]@ || GetPhysicsRope || || <br />
|-<br />
| void || SetMaterial || [[cMaterial]]@ apMaterial || <br />
|-<br />
| void || SetColor || const [[cColor]]& aColor || <br />
|-<br />
| const [[cColor]]& || GetColor || || <br />
|-<br />
| void || SetMultiplyAlphaWithColor || bool abX || <br />
|-<br />
| bool || GetMultiplyAlphaWithColor || || <br />
|-<br />
| void || SetRadius || float afX || <br />
|-<br />
| float || GetRadius || || <br />
|-<br />
| int || GetMaxSegments || || <br />
|-<br />
| void || SetLengthTileAmount || float afX || <br />
|-<br />
| float || GetLengthTileAmount || || <br />
|-<br />
| void || SetLengthTileSize || float afX || <br />
|-<br />
| float || GetLengthTileSize || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cluxvisibilityarea&diff=2499
HPL3/Community/Scripting/Classes/cluxvisibilityarea
2020-07-30T09:12:27Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cLuxVisibilityArea==<br />
<br />
===Fields===<br />
<br />
cLuxVisibilityArea has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| const [[tID]]& || GetID || || <br />
|-<br />
| [[eLuxEntityType]] || GetEntityType || || <br />
|-<br />
| const [[tString]]& || GetClassName || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| const [[tString]]& || GetEventTag || || <br />
|-<br />
| const [[tString]]& || GetEventInstanceTag || || <br />
|-<br />
| void || SetEventInstanceTag || const [[tString]] &in asTag || <br />
|-<br />
| [[cSoundEntity]]@ || PlaySound || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| bool || GetLastCreatedSoundIsPlaying || || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystem || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystemOnBone || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />const [[tString]] &in asBoneName, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| int || PlayAnimation || const [[tString]] &in asName, <br />''float afFadeTime = 0.3f'', <br />''bool abLoop = false'', <br />''bool abPlayTransition = true'', <br />''const [[tString]] &in asCallback = ""'', <br />''bool abGlobalSpace = false'' || <br />
|-<br />
| void || AppendAnimation || const [[tString]] &in asName, <br />bool abLoop || <br />
|-<br />
| bool || GetAnimationIsPlaying || || <br />
|-<br />
| void || SetNormalizeAnimationWeights || bool abX || <br />
|-<br />
| void || StopAllAnimations || float afFadeTime || <br />
|-<br />
| void || StopAnimation || const [[tString]] &in asName, <br />float afFadeTime || <br />
|-<br />
| void || StopAnimation || int alIdx, <br />float afFadeTime || <br />
|-<br />
| void || SetCurrentAnimationPaused || bool abX || <br />
|-<br />
| void || SetAnimationMessageEventCallback || const [[tString]] &in asFunc, <br />bool abAutoRemove || <br />
|-<br />
| int || GetCurrentAnimationIndex || || <br />
|-<br />
| [[cAnimationState]]@ || GetCurrentAnimationState || || <br />
|-<br />
| void || GiveDamage || float afAmount, <br />int alStrength, <br />const [[tString]] &in asType, <br />const [[tString]] &in asSource || <br />
|-<br />
| void || AttachToEntity || [[iLuxEntity]]@ apEntity, <br />[[iPhysicsBody]]@ apTargetBody, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || AttachToSocket || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asSocket, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || RemoveEntityAttachment || || <br />
|-<br />
| void || SetFullGameSave || bool abX || <br />
|-<br />
| bool || IsLookedAtByPlayer || || <br />
|-<br />
| void || SetForceLookAtCheck || bool abX || <br />
|-<br />
| bool || GetForceLookAtCheck || || <br />
|-<br />
| void || PreloadEntityModel || const [[tString]]& asFile || <br />
|-<br />
| bool || CollidesWithPlayer || || <br />
|-<br />
| [[cLuxMap]]@ || GetMap || || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| [[cMatrixf]] || GetMatrix || || <br />
|-<br />
| [[cVector3f]] || GetPosition || || <br />
|-<br />
| int || GetBodyNum || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBody || int alIdx || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromID || int alID || <br />
|-<br />
| int || GetBodyIndexFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetMainBody || || <br />
|-<br />
| void || SetMeshScaleMul || const [[cVector3f]] &in avScale || <br />
|-<br />
| [[cVector3f]] || GetMeshScaleMul || || <br />
|-<br />
| void || FadeMeshScaleMul || const [[cVector3f]] &in avDestScale, <br />float afTime || <br />
|-<br />
| [[cMeshEntity]]@ || GetMeshEntity || || <br />
|-<br />
| [[cMaterial]]@ || GetBaseMaterial || || <br />
|-<br />
| [[iEntity3D]]@ || GetAttachEntity || || <br />
|-<br />
| [[cNode3D]]@ || GetVoiceAttachNode || || <br />
|-<br />
| bool || CanInteract || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| bool || OnInteract || int alType, <br />[[iPhysicsBody]]@ apBody, <br />const [[cVector3f]]& avFocusPos, <br />const [[tString]] &in asData || <br />
|-<br />
| int || GetInteractIconId || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| void || SetIsInteractedWith || bool abX || <br />
|-<br />
| bool || IsInteractedWith || || <br />
|-<br />
| float || GetMaxInteractDistance || || <br />
|-<br />
| void || SetMaxInteractDistance || float afX || <br />
|-<br />
| void || SetInteractionDisabled || bool abX || <br />
|-<br />
| bool || GetInteractionDisabled || || <br />
|-<br />
| void || SetPlayerInteractCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenInteracted || <br />
|-<br />
| void || SetPlayerLookAtCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenLookedAt, <br />bool abCheckCenterOfScreen, <br />bool abCheckRayIntersection, <br />float afMaxDistance, <br />float afCallbackDelay || <br />
|-<br />
| void || SetRecieveMessageCallback || const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || SetConnectionStateChangeCallback || const [[tString]]& asCallbackFunc || <br />
|-<br />
| bool || HasPlayerInteractCallback || || <br />
|-<br />
| bool || HasPlayerLookAtCallback || || <br />
|-<br />
| void || SetupParent || int alTypeId, <br />[[tID]] alId, <br />const [[tString]]& asName || <br />
|-<br />
| int || GetParentType || || <br />
|-<br />
| [[tID]] || GetParentId || || <br />
|-<br />
| const [[tString]]& || GetParentName || || <br />
|-<br />
| void || ChangeConnectionState || int alState || <br />
|-<br />
| void || AddConnection || const [[tString]] &in asName, <br />[[iLuxEntity]]@ apEntity, <br />bool abInvertStateSent, <br />int alStatesUsed || <br />
|-<br />
| void || RemoveConnection || const [[tString]] &in asName || <br />
|-<br />
| void || RemoveAllConnections || || <br />
|-<br />
| bool || CheckEntityCollision || [[iLuxEntity]]@ apEntity || <br />
|-<br />
| bool || CheckBodyCollision || [[iPhysicsBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckShapeCollision || [[iCollideShape]]@ apShape, <br />const [[cMatrixf]]& a_mtxTransform, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckCharacterCollision || [[iCharacterBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || HasCollideCallbacks || || <br />
|-<br />
| void || AddCollideCallback || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || RemoveCollideCallback || const [[tString]] &in asEntityName || <br />
|-<br />
| bool || ScriptPrepare || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptPrepareFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| bool || ScriptExecute || || <br />
|-<br />
| bool || ScriptMethodExists || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptMethodExistsFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| void || SetArgBool || int alArgNum, <br />bool abVal || <br />
|-<br />
| void || SetArgInt || int alArg, <br />int alX || <br />
|-<br />
| void || SetArgFloat || int alArg, <br />float afX || <br />
|-<br />
| void || SetArgString || int alArg, <br />const [[tString]]& asStr || <br />
|-<br />
| bool || GetReturnBool || || <br />
|-<br />
| int || GetReturnInt || || <br />
|-<br />
| float || GetReturnFloat || || <br />
|-<br />
| [[tString]] || GetReturnString || || <br />
|-<br />
| void || BroadcastMessage || int alMessageId, <br />[[iLuxEntityComponent]]@ apSource, <br />const [[cVector3f]]& avData, <br />int alData || <br />
|-<br />
| void || SetEffectBaseColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetEffectBaseColor || || <br />
|-<br />
| void || FadeEffectBaseColor || const [[cColor]]& aDestColor, <br />float afTime || <br />
|-<br />
| void || SetEffectsActive || bool abActive, <br />bool abFadeAndPlaySounds || <br />
|-<br />
| bool || GetEffectsActive || || <br />
|-<br />
| float || GetEffectsAlpha || || <br />
|-<br />
| const [[tString]]& || GetEffectsOnSound || || <br />
|-<br />
| const [[tString]]& || GetEffectsOffSound || || <br />
|-<br />
| float || GetEffectsOnTime || || <br />
|-<br />
| float || GetEffectsOffTime || || <br />
|-<br />
| void || SetVarString || const [[tString]] &in asName, <br />const [[tString]] &in asX || <br />
|-<br />
| void || SetVarBool || const [[tString]] &in asName, <br />bool abX || <br />
|-<br />
| void || SetVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || SetVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || SetVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || SetVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| void || SetVarColor || const [[tString]] &in asName, <br />const [[cColor]] &in aX || <br />
|-<br />
| void || IncVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || IncVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || IncVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || IncVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| const [[tString]]& || GetVarString || const [[tString]] &in asName || <br />
|-<br />
| bool || GetVarBool || const [[tString]] &in asName || <br />
|-<br />
| int || GetVarInt || const [[tString]] &in asName || <br />
|-<br />
| float || GetVarFloat || const [[tString]] &in asName || <br />
|-<br />
| [[cVector2f]] || GetVarVector2f || const [[tString]] &in asName || <br />
|-<br />
| [[cVector3f]] || GetVarVector3f || const [[tString]] &in asName || <br />
|-<br />
| [[cColor]] || GetVarColor || const [[tString]] &in asName || <br />
|-<br />
| bool || CheckIsOnScreen || bool abUseRayCast || <br />
|-<br />
| const [[tString]]& || GetFileName || || <br />
|-<br />
| const [[cVector3f]]& || GetOnLoadScale || || <br />
|-<br />
| const [[cMatrixf]]& || GetOnLoadTransform || || <br />
|-<br />
| [[iLight]]@ || GetLightFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cParticleSystem]]@ || GetParticleSystemFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cBillboard]]@ || GetBillboardFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cSoundEntity]]@ || GetSoundEntityFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cLensFlare]]@ || GetLensFlareFromName || const [[tString]] &in asName || <br />
|-<br />
| bool || IsOccluder || || <br />
|-<br />
| void || SetIsOccluder || bool abX || <br />
|-<br />
| void || Sleep || || <br />
|-<br />
| void || WakeUp || || <br />
|-<br />
| void || SetAutoSleep || bool abX || <br />
|-<br />
| bool || GetAutoSleep || || <br />
|-<br />
| bool || IsSleeping || || <br />
|-<br />
| float || GetVariableUpdateRate || || <br />
|-<br />
| void || SetVariableUpdateRate || float afX || <br />
|-<br />
| void || GetClosestEntity || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />int alInteractType, <br />bool abCheckLineOfSight || <br />
|-<br />
| void || GetClosestBody || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength || <br />
|-<br />
| void || GetClosestCharCollider || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />bool abCheckDynamic || <br />
|-<br />
| void || GetLightLevelAtPos || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avPos, <br />[[iLight]]@ apSkipLight, <br />float afRadiusAdd || <br />
|-<br />
| void || DrawProjDebugText || const [[tString]] &in asText, <br />''float afFontSize = 16.0f'', <br />''bool abProjectSize = false'', <br />''[[eFontAlign]] aAlignment = eFontAlign_Left'', <br />''const [[cColor]] &in aColor = cColor'', <br /> 1, <br /> 1, <br />''const [[cVector3f]] &in avOffset = cVector3f'', <br /> 0, <br />''float afMaxDistance = 20'' || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetIsDoor || bool abX || <br />
|-<br />
| bool || GetIsDoor || || <br />
|-<br />
| void || SetIsClosedDoor || bool abX || <br />
|-<br />
| bool || GetIsClosedDoor || || <br />
|-<br />
| void || UpdateEntityAttachment || || <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| void || PostUpdate || float afTimeStep || <br />
|-<br />
| void || VariableUpdate || float afDeltaTime || <br />
|-<br />
| bool || GetSaveDataIsUpdated || || <br />
|-<br />
| void || SetSaveDataIsUpdated || bool abX || <br />
|-<br />
| void || Timer_ClearAll || || <br />
|-<br />
| void || Timer_Add || uint64 alID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || uint64 alID || <br />
|-<br />
| bool || Timer_Exists || uint64 alID || <br />
|-<br />
| float || Timer_GetTimeLeft || uint64 alID || <br />
|-<br />
| void || Timer_SetPaused || uint64 alID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || uint64 alID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || uint64 alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Timer_Add || const [[tString]] &in asID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || const [[tString]] &in asID || <br />
|-<br />
| bool || Timer_Exists || const [[tString]] &in asID || <br />
|-<br />
| float || Timer_GetTimeLeft || const [[tString]] &in asID || <br />
|-<br />
| void || Timer_SetPaused || const [[tString]] &in asID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || const [[tString]] &in asID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || const [[tString]] &in asID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_ClearAll || || <br />
|-<br />
| void || Fader_FadeTo || uint alID, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || uint alID, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || uint alID, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || uint alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_FadeTo || const [[tString]] &in asName, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || const [[tString]] &in asName, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || const [[tString]] &in asName, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || const [[tString]] &in asName, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || MoveLinearTo || const [[cVector3f]] &in avGoal, <br />float afAcc, <br />float afMaxSpeed, <br />float afSlowdownDist, <br />bool abResetSpeed, <br />''const [[tString]] &in asCallback = ""'' || <br />
|-<br />
| void || StopMove || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetAreaBody || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cimguiwindowdata&diff=2489
HPL3/Community/Scripting/Classes/cimguiwindowdata
2020-07-30T09:12:26Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cImGuiWindowData==<br />
<br />
===Fields===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Field Name !! Type !! Description <br />
|-<br />
| mColorBase || [[cColor]] || <br />
|-<br />
| mColorText || [[cColor]] || <br />
|-<br />
| mColorDisabled || [[cColor]] || <br />
|-<br />
| mvDefaultSize || [[cVector2f]] || <br />
|-<br />
| mbUseBackgroundGfx || bool || <br />
|-<br />
| mGfxBackground || [[cImGuiGfx]] || <br />
|-<br />
| mFont || [[cImGuiFont]] || <br />
|-<br />
| mFontAlign || [[eFontAlign]] || <br />
|-<br />
| mbUseDisabledColor || bool || <br />
|-<br />
| mHeaderType || [[eImGuiWindowHeader]] || <br />
|-<br />
| mGfxWindowData || [[cImGuiFrameGfx]] || <br />
|-<br />
| mbUseHeader || bool || <br />
|-<br />
| mvLabelOffset || [[cVector3f]] || <br />
|-<br />
| mfCaptionSizeMul || float || <br />
|-<br />
| mGfxLabelData || [[cImGuiFrameGfx]] || <br />
|-<br />
| mfLabelPaddingTop || float || <br />
|-<br />
| mfLabelPaddingRight || float || <br />
|-<br />
| mfLabelPaddingBottom || float || <br />
|-<br />
| mfLabelPaddingLeft || float || <br />
|-<br />
| mfLabelMinWidth || float || <br />
|-<br />
| mfPaddingTop || float || <br />
|-<br />
| mfPaddingRight || float || <br />
|-<br />
| mfPaddingBottom || float || <br />
|-<br />
| mfPaddingLeft || float || <br />
|-<br />
|}<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || SetLabelPadding || float afTop, <br />float afRight, <br />float afBottom, <br />float afLeft || <br />
|-<br />
| void || SetPadding || float afTop, <br />float afRight, <br />float afBottom, <br />float afLeft || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/icollideshape&diff=2490
HPL3/Community/Scripting/Classes/icollideshape
2020-07-30T09:12:26Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==iCollideShape==<br />
<br />
===Fields===<br />
<br />
iCollideShape has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| [[iCollideShape]]@ || GetSubShape || int alIdx || <br />
|-<br />
| int || GetSubShapeNum || || <br />
|-<br />
| const [[cVector3f]]& || GetSize || || <br />
|-<br />
| float || GetHeight || || <br />
|-<br />
| float || GetWidth || || <br />
|-<br />
| float || GetDepth || || <br />
|-<br />
| const [[cMatrixf]]& || GetOffset || || <br />
|-<br />
| [[eCollideShapeType]] || GetType || || <br />
|-<br />
| float || GetVolume || || <br />
|-<br />
| [[cBoundingVolume]]@+ || GetBoundingVolume || || <br />
|-<br />
| [[cVector3f]] || GetHeightMapOffset || || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cposteffect_radialblur&diff=2491
HPL3/Community/Scripting/Classes/cposteffect radialblur
2020-07-30T09:12:26Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cPostEffect_RadialBlur==<br />
<br />
===Fields===<br />
<br />
cPostEffect_RadialBlur has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || SetDisabled || bool abX || <br />
|-<br />
| bool || IsDisabled || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| void || Reset || || <br />
|-<br />
| void || GetParams || float& afSize, <br />float& afAlpha, <br />float& afBlurStartDist || <br />
|-<br />
| void || SetParams || float afSize, <br />float afAlpha, <br />float afBlurStartDist || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/iluxentity&diff=2492
HPL3/Community/Scripting/Classes/iluxentity
2020-07-30T09:12:26Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==iLuxEntity==<br />
<br />
===Fields===<br />
<br />
iLuxEntity has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| const [[tID]]& || GetID || || <br />
|-<br />
| [[eLuxEntityType]] || GetEntityType || || <br />
|-<br />
| const [[tString]]& || GetClassName || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| const [[tString]]& || GetEventTag || || <br />
|-<br />
| const [[tString]]& || GetEventInstanceTag || || <br />
|-<br />
| void || SetEventInstanceTag || const [[tString]] &in asTag || <br />
|-<br />
| [[cSoundEntity]]@ || PlaySound || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| bool || GetLastCreatedSoundIsPlaying || || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystem || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| [[cParticleSystem]]@ || CreateParticleSystemOnBone || const [[tString]] &in asName, <br />const [[tString]] &in asFile, <br />const [[tString]] &in asBoneName, <br />bool abRemoveWhenDone, <br />bool abAttach || <br />
|-<br />
| int || PlayAnimation || const [[tString]] &in asName, <br />''float afFadeTime = 0.3f'', <br />''bool abLoop = false'', <br />''bool abPlayTransition = true'', <br />''const [[tString]] &in asCallback = ""'', <br />''bool abGlobalSpace = false'' || <br />
|-<br />
| void || AppendAnimation || const [[tString]] &in asName, <br />bool abLoop || <br />
|-<br />
| bool || GetAnimationIsPlaying || || <br />
|-<br />
| void || SetNormalizeAnimationWeights || bool abX || <br />
|-<br />
| void || StopAllAnimations || float afFadeTime || <br />
|-<br />
| void || StopAnimation || const [[tString]] &in asName, <br />float afFadeTime || <br />
|-<br />
| void || StopAnimation || int alIdx, <br />float afFadeTime || <br />
|-<br />
| void || SetCurrentAnimationPaused || bool abX || <br />
|-<br />
| void || SetAnimationMessageEventCallback || const [[tString]] &in asFunc, <br />bool abAutoRemove || <br />
|-<br />
| int || GetCurrentAnimationIndex || || <br />
|-<br />
| [[cAnimationState]]@ || GetCurrentAnimationState || || <br />
|-<br />
| void || GiveDamage || float afAmount, <br />int alStrength, <br />const [[tString]] &in asType, <br />const [[tString]] &in asSource || <br />
|-<br />
| void || AttachToEntity || [[iLuxEntity]]@ apEntity, <br />[[iPhysicsBody]]@ apTargetBody, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || AttachToSocket || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asSocket, <br />bool abUseRotation, <br />bool abSnapToParent, <br />''bool abLocked = false'' || <br />
|-<br />
| void || RemoveEntityAttachment || || <br />
|-<br />
| void || SetFullGameSave || bool abX || <br />
|-<br />
| bool || IsLookedAtByPlayer || || <br />
|-<br />
| void || SetForceLookAtCheck || bool abX || <br />
|-<br />
| bool || GetForceLookAtCheck || || <br />
|-<br />
| void || PreloadEntityModel || const [[tString]]& asFile || <br />
|-<br />
| bool || CollidesWithPlayer || || <br />
|-<br />
| [[cLuxMap]]@ || GetMap || || <br />
|-<br />
| void || SetMatrix || const [[cMatrixf]] &in a_mtxTransform || <br />
|-<br />
| void || SetPosition || const [[cVector3f]] &in avPos || <br />
|-<br />
| [[cMatrixf]] || GetMatrix || || <br />
|-<br />
| [[cVector3f]] || GetPosition || || <br />
|-<br />
| int || GetBodyNum || || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBody || int alIdx || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromID || int alID || <br />
|-<br />
| int || GetBodyIndexFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetBodyFromName || const [[tString]] &in asName || <br />
|-<br />
| [[iPhysicsBody]]@ || GetMainBody || || <br />
|-<br />
| void || SetMeshScaleMul || const [[cVector3f]] &in avScale || <br />
|-<br />
| [[cVector3f]] || GetMeshScaleMul || || <br />
|-<br />
| void || FadeMeshScaleMul || const [[cVector3f]] &in avDestScale, <br />float afTime || <br />
|-<br />
| [[cMeshEntity]]@ || GetMeshEntity || || <br />
|-<br />
| [[cMaterial]]@ || GetBaseMaterial || || <br />
|-<br />
| [[iEntity3D]]@ || GetAttachEntity || || <br />
|-<br />
| [[cNode3D]]@ || GetVoiceAttachNode || || <br />
|-<br />
| bool || CanInteract || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| bool || OnInteract || int alType, <br />[[iPhysicsBody]]@ apBody, <br />const [[cVector3f]]& avFocusPos, <br />const [[tString]] &in asData || <br />
|-<br />
| int || GetInteractIconId || int alType, <br />[[iPhysicsBody]]@ apBody || <br />
|-<br />
| void || SetIsInteractedWith || bool abX || <br />
|-<br />
| bool || IsInteractedWith || || <br />
|-<br />
| float || GetMaxInteractDistance || || <br />
|-<br />
| void || SetMaxInteractDistance || float afX || <br />
|-<br />
| void || SetInteractionDisabled || bool abX || <br />
|-<br />
| bool || GetInteractionDisabled || || <br />
|-<br />
| void || SetPlayerInteractCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenInteracted || <br />
|-<br />
| void || SetPlayerLookAtCallback || const [[tString]]& asCallbackFunc, <br />bool abRemoveWhenLookedAt, <br />bool abCheckCenterOfScreen, <br />bool abCheckRayIntersection, <br />float afMaxDistance, <br />float afCallbackDelay || <br />
|-<br />
| void || SetRecieveMessageCallback || const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || SetConnectionStateChangeCallback || const [[tString]]& asCallbackFunc || <br />
|-<br />
| bool || HasPlayerInteractCallback || || <br />
|-<br />
| bool || HasPlayerLookAtCallback || || <br />
|-<br />
| void || SetupParent || int alTypeId, <br />[[tID]] alId, <br />const [[tString]]& asName || <br />
|-<br />
| int || GetParentType || || <br />
|-<br />
| [[tID]] || GetParentId || || <br />
|-<br />
| const [[tString]]& || GetParentName || || <br />
|-<br />
| void || ChangeConnectionState || int alState || <br />
|-<br />
| void || AddConnection || const [[tString]] &in asName, <br />[[iLuxEntity]]@ apEntity, <br />bool abInvertStateSent, <br />int alStatesUsed || <br />
|-<br />
| void || RemoveConnection || const [[tString]] &in asName || <br />
|-<br />
| void || RemoveAllConnections || || <br />
|-<br />
| bool || CheckEntityCollision || [[iLuxEntity]]@ apEntity || <br />
|-<br />
| bool || CheckBodyCollision || [[iPhysicsBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckShapeCollision || [[iCollideShape]]@ apShape, <br />const [[cMatrixf]]& a_mtxTransform, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || CheckCharacterCollision || [[iCharacterBody]]@ apBody, <br />[[cLuxMap]]@ apMap || <br />
|-<br />
| bool || HasCollideCallbacks || || <br />
|-<br />
| void || AddCollideCallback || [[iLuxEntity]]@ apEntity, <br />const [[tString]] &in asCallbackFunc || <br />
|-<br />
| void || RemoveCollideCallback || const [[tString]] &in asEntityName || <br />
|-<br />
| bool || ScriptPrepare || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptPrepareFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| bool || ScriptExecute || || <br />
|-<br />
| bool || ScriptMethodExists || const [[tString]] &in asMethod || <br />
|-<br />
| bool || ScriptMethodExistsFast || const [[tString]] &in asMethod, <br />int alId || <br />
|-<br />
| void || SetArgBool || int alArgNum, <br />bool abVal || <br />
|-<br />
| void || SetArgInt || int alArg, <br />int alX || <br />
|-<br />
| void || SetArgFloat || int alArg, <br />float afX || <br />
|-<br />
| void || SetArgString || int alArg, <br />const [[tString]]& asStr || <br />
|-<br />
| bool || GetReturnBool || || <br />
|-<br />
| int || GetReturnInt || || <br />
|-<br />
| float || GetReturnFloat || || <br />
|-<br />
| [[tString]] || GetReturnString || || <br />
|-<br />
| void || BroadcastMessage || int alMessageId, <br />[[iLuxEntityComponent]]@ apSource, <br />const [[cVector3f]]& avData, <br />int alData || <br />
|-<br />
| void || SetEffectBaseColor || const [[cColor]] &in aColor || <br />
|-<br />
| const [[cColor]]& || GetEffectBaseColor || || <br />
|-<br />
| void || FadeEffectBaseColor || const [[cColor]]& aDestColor, <br />float afTime || <br />
|-<br />
| void || SetEffectsActive || bool abActive, <br />bool abFadeAndPlaySounds || <br />
|-<br />
| bool || GetEffectsActive || || <br />
|-<br />
| float || GetEffectsAlpha || || <br />
|-<br />
| const [[tString]]& || GetEffectsOnSound || || <br />
|-<br />
| const [[tString]]& || GetEffectsOffSound || || <br />
|-<br />
| float || GetEffectsOnTime || || <br />
|-<br />
| float || GetEffectsOffTime || || <br />
|-<br />
| void || SetVarString || const [[tString]] &in asName, <br />const [[tString]] &in asX || <br />
|-<br />
| void || SetVarBool || const [[tString]] &in asName, <br />bool abX || <br />
|-<br />
| void || SetVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || SetVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || SetVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || SetVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| void || SetVarColor || const [[tString]] &in asName, <br />const [[cColor]] &in aX || <br />
|-<br />
| void || IncVarInt || const [[tString]] &in asName, <br />int alX || <br />
|-<br />
| void || IncVarFloat || const [[tString]] &in asName, <br />float afX || <br />
|-<br />
| void || IncVarVector2f || const [[tString]] &in asName, <br />const [[cVector2f]] &in avX || <br />
|-<br />
| void || IncVarVector3f || const [[tString]] &in asName, <br />const [[cVector3f]] &in avX || <br />
|-<br />
| const [[tString]]& || GetVarString || const [[tString]] &in asName || <br />
|-<br />
| bool || GetVarBool || const [[tString]] &in asName || <br />
|-<br />
| int || GetVarInt || const [[tString]] &in asName || <br />
|-<br />
| float || GetVarFloat || const [[tString]] &in asName || <br />
|-<br />
| [[cVector2f]] || GetVarVector2f || const [[tString]] &in asName || <br />
|-<br />
| [[cVector3f]] || GetVarVector3f || const [[tString]] &in asName || <br />
|-<br />
| [[cColor]] || GetVarColor || const [[tString]] &in asName || <br />
|-<br />
| bool || CheckIsOnScreen || bool abUseRayCast || <br />
|-<br />
| const [[tString]]& || GetFileName || || <br />
|-<br />
| const [[cVector3f]]& || GetOnLoadScale || || <br />
|-<br />
| const [[cMatrixf]]& || GetOnLoadTransform || || <br />
|-<br />
| [[iLight]]@ || GetLightFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cParticleSystem]]@ || GetParticleSystemFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cBillboard]]@ || GetBillboardFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cSoundEntity]]@ || GetSoundEntityFromName || const [[tString]] &in asName || <br />
|-<br />
| [[cLensFlare]]@ || GetLensFlareFromName || const [[tString]] &in asName || <br />
|-<br />
| bool || IsOccluder || || <br />
|-<br />
| void || SetIsOccluder || bool abX || <br />
|-<br />
| void || Sleep || || <br />
|-<br />
| void || WakeUp || || <br />
|-<br />
| void || SetAutoSleep || bool abX || <br />
|-<br />
| bool || GetAutoSleep || || <br />
|-<br />
| bool || IsSleeping || || <br />
|-<br />
| float || GetVariableUpdateRate || || <br />
|-<br />
| void || SetVariableUpdateRate || float afX || <br />
|-<br />
| void || GetClosestEntity || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />int alInteractType, <br />bool abCheckLineOfSight || <br />
|-<br />
| void || GetClosestBody || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength || <br />
|-<br />
| void || GetClosestCharCollider || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avStart, <br />const [[cVector3f]] &in avDir, <br />float afRayLength, <br />bool abCheckDynamic || <br />
|-<br />
| void || GetLightLevelAtPos || const [[tString]] &in asCallbackFunc, <br />const [[cVector3f]] &in avPos, <br />[[iLight]]@ apSkipLight, <br />float afRadiusAdd || <br />
|-<br />
| void || DrawProjDebugText || const [[tString]] &in asText, <br />''float afFontSize = 16.0f'', <br />''bool abProjectSize = false'', <br />''[[eFontAlign]] aAlignment = eFontAlign_Left'', <br />''const [[cColor]] &in aColor = cColor'', <br /> 1, <br /> 1, <br />''const [[cVector3f]] &in avOffset = cVector3f'', <br /> 0, <br />''float afMaxDistance = 20'' || <br />
|-<br />
| void || SetScriptableIsSaved || bool abX || <br />
|-<br />
| bool || GetScriptableIsSaved || || <br />
|-<br />
| void || SetIsDoor || bool abX || <br />
|-<br />
| bool || GetIsDoor || || <br />
|-<br />
| void || SetIsClosedDoor || bool abX || <br />
|-<br />
| bool || GetIsClosedDoor || || <br />
|-<br />
| void || UpdateEntityAttachment || || <br />
|-<br />
| void || Update || float afTimeStep || <br />
|-<br />
| void || PostUpdate || float afTimeStep || <br />
|-<br />
| void || VariableUpdate || float afDeltaTime || <br />
|-<br />
| bool || GetSaveDataIsUpdated || || <br />
|-<br />
| void || SetSaveDataIsUpdated || bool abX || <br />
|-<br />
| void || Timer_ClearAll || || <br />
|-<br />
| void || Timer_Add || uint64 alID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || uint64 alID || <br />
|-<br />
| bool || Timer_Exists || uint64 alID || <br />
|-<br />
| float || Timer_GetTimeLeft || uint64 alID || <br />
|-<br />
| void || Timer_SetPaused || uint64 alID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || uint64 alID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || uint64 alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Timer_Add || const [[tString]] &in asID, <br />float afTime, <br />''const [[tString]] &in asFunc = ""'', <br />''bool abCreateIfExist = true'', <br />''bool abRepeat = false'' || <br />
|-<br />
| void || Timer_Remove || const [[tString]] &in asID || <br />
|-<br />
| bool || Timer_Exists || const [[tString]] &in asID || <br />
|-<br />
| float || Timer_GetTimeLeft || const [[tString]] &in asID || <br />
|-<br />
| void || Timer_SetPaused || const [[tString]] &in asID, <br />bool abX || <br />
|-<br />
| bool || Timer_TimeHasPassed || const [[tString]] &in asID, <br />float afLength || <br />
|-<br />
| float || Timer_GetValue || const [[tString]] &in asID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_ClearAll || || <br />
|-<br />
| void || Fader_FadeTo || uint alID, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || uint alID, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || uint alID, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || uint alID, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
| void || Fader_FadeTo || const [[tString]] &in asName, <br />float afGoal, <br />float afTime, <br />''bool abReverseAtEnd = false'', <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_Set || const [[tString]] &in asName, <br />float afX, <br />''bool abSkipIfExists = false'' || <br />
|-<br />
| void || Fader_SetPaused || const [[tString]] &in asName, <br />bool abPaused || <br />
|-<br />
| float || Fader_GetValue || const [[tString]] &in asName, <br />''float afMin = 0'', <br />''float afMax = 1'', <br />''[[eEasing]] aEasing = eEasing_Linear'', <br />''bool abAbsValue = false'' || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/iphysicscloth&diff=2493
HPL3/Community/Scripting/Classes/iphysicscloth
2020-07-30T09:12:26Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==iPhysicsCloth==<br />
<br />
===Fields===<br />
<br />
iPhysicsCloth has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| const [[tString]]& || GetName || || <br />
|-<br />
| int || GetUniqueID || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || GetActive || || <br />
|-<br />
| void || RemoveAttachedBody || [[iPhysicsBody]]@ apBody, <br />bool abRemoveContainerFromBody || <br />
|-<br />
| void || SetGravityForce || const [[cVector3f]] &in avX || <br />
|-<br />
| const [[cVector3f]]& || GetGravityForce || || <br />
|-<br />
| void || SetDamping || float afX || <br />
|-<br />
| float || GetDamping || || <br />
|-<br />
| void || SetParticleRadius || float afX || <br />
|-<br />
| float || GetParticleRadius || || <br />
|-<br />
| void || SetSlideAmount || float afX || <br />
|-<br />
| float || GetSlideAmount || || <br />
|-<br />
| void || SetCollide || bool abX || <br />
|-<br />
| bool || GetCollide || || <br />
|-<br />
| void || SetSleeping || bool abX || <br />
|-<br />
| int || GetParticleNum || || <br />
|-<br />
| [[cVerletParticle]]@ || GetParticle || int alIdx || <br />
|-<br />
| int || GetUpdateCount || const || <br />
|-<br />
| void || IncUpdateCount || || <br />
|-<br />
| void || UpdateLengthConstraint || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afLength || <br />
|-<br />
| void || UpdateLengthConstraint || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afLength, <br />float afStiffness || <br />
|-<br />
| void || UpdateLengthConstraint || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afMinLength, <br />float afMaxLength, <br />float afStiffness || <br />
|-<br />
| void || UpdateLengthConstraintStretch || [[cVerletParticle]]@ apP1, <br />[[cVerletParticle]]@ apP2, <br />float afLength, <br />float afStiffness || <br />
|-<br />
| void || UpdateParticleCollisionConstraint || [[cVerletParticle]]@ apPart, <br />const [[cVector3f]]& avPrevPos, <br />float afRadius || <br />
|-<br />
| void || ApplyForceToParticles || const [[cVector3f]]& avForce, <br />[[cVerletParticle]]@ apBaseParticle, <br />const [[cVector3f]]& 0 || <br />
|-<br />
| void || AttachToLine || [[cVector3f]] avStart, <br />[[cVector3f]] avEnd, <br />int alRow, <br />int alColumnStride, <br />bool false || <br />
|-<br />
| [[cVector2f]] || GetClothSize || || <br />
|-<br />
| [[cVector3f]] || GetWindForce || || <br />
|-<br />
| void || SetWindForce || const [[cVector3f]] avWindForce || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/cposteffect_tonemapping&diff=2486
HPL3/Community/Scripting/Classes/cposteffect tonemapping
2020-07-30T09:12:25Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==cPostEffect_ToneMapping==<br />
<br />
===Fields===<br />
<br />
cPostEffect_ToneMapping has no public fields.<br />
<br />
===Functions===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Return Type !! Function Name !! Parameters !! Description <br />
|-<br />
| void || SetDisabled || bool abX || <br />
|-<br />
| bool || IsDisabled || || <br />
|-<br />
| void || SetActive || bool abX || <br />
|-<br />
| bool || IsActive || || <br />
|-<br />
| void || Reset || || <br />
|-<br />
| void || FadeGradingTexture || [[iTexture]]@ apGrading, <br />float afTime || <br />
|-<br />
| void || FadeExposure || float afExposure, <br />float afWhiteCut, <br />float afTime || <br />
|-<br />
| void || FadeWindowExposure || float afExposure, <br />float afWhiteCut || <br />
|-<br />
| float || GetTransitionTime || || <br />
|-<br />
| void || SetColorGradingActive || bool abX || <br />
|-<br />
| void || SetBloomActive || bool abX || <br />
|-<br />
| void || SetFilmGrainActive || bool abX || <br />
|-<br />
| bool || GetColorGradingActive || || <br />
|-<br />
| bool || GetBloomActive || || <br />
|-<br />
| bool || GetFilmGrainActive || || <br />
|-<br />
| void || SetSRGBGamma || bool abX || <br />
|-<br />
| float || GetExposure || || <br />
|-<br />
| void || GetParams || float& afKey, <br />float& afGammaCorrection, <br />float& afFilmGrainIntensity, <br />float& afBrightPass, <br />float& afBloomWidth, <br />[[cColor]]& avBloomTint, <br />float& afBloomFalloff || <br />
|-<br />
| void || SetParams || float afKey, <br />float afGammaCorrection, <br />float afFilmGrainIntensity, <br />float afBrightPass, <br />float afBloomWidth, <br />const [[cColor]] &in avBloomTint, <br />float afBloomFalloff || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script
https://wiki.frictionalgames.com/page?title=HPL3/Community/Scripting/Classes/ecollision&diff=2487
HPL3/Community/Scripting/Classes/ecollision
2020-07-30T09:12:25Z
<p>Maintenance script: Upload classes to sub</p>
<hr />
<div>==eCollision==<br />
<br />
===Values===<br />
<br />
{| class="wikitable sortable" border=1<br />
! Enum Name !! Integer Value !! Description <br />
|-<br />
| eCollision_Inside || 0 || <br />
|-<br />
| eCollision_Outside || 1 || <br />
|-<br />
| eCollision_Intersect || 2 || <br />
|-<br />
| eCollision_LastEnum || 3 || <br />
|-<br />
|}<br />
<br />
===Remarks===<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!</div>
Maintenance script