Difference between revisions of "HPL3/SOMA/Scripting/cBeam"

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting
Jump to navigation Jump to search
Line 16: Line 16:
 
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetUniqueID ||  ||
 
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetUniqueID ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UpdateLogic || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UpdateLogic || <syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> ||
 
|-
 
|-
−
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetName || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetName || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetName || <syntaxhighlight lang="c++" inline>[[../tString|<syntaxhighlight lang="c++" inline>const tString &in asName</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetName || [[../tString|<syntaxhighlight lang="c++" inline>const tString &in asName</syntaxhighlight>]] ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || HasParent ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || HasParent ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsActive || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsActive || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetActive || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>bool abActive</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetActive || <syntaxhighlight lang="c++" inline>bool abActive</syntaxhighlight> ||
 
|-
 
|-
 
| [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetLocalPosition ||  ||
 
| [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetLocalPosition ||  ||
Line 36: Line 36:
 
| [[../cMatrixf|<syntaxhighlight lang="c++" inline>cMatrixf&</syntaxhighlight>]] || GetWorldMatrix ||  ||
 
| [[../cMatrixf|<syntaxhighlight lang="c++" inline>cMatrixf&</syntaxhighlight>]] || GetWorldMatrix ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetPosition || <syntaxhighlight lang="c++" inline>[[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f &in avPos</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetPosition || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f &in avPos</syntaxhighlight>]] ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetMatrix || <syntaxhighlight lang="c++" inline>[[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf &in a_mtxTransform</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetMatrix || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf &in a_mtxTransform</syntaxhighlight>]] ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetWorldPosition || <syntaxhighlight lang="c++" inline>[[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f &in avWorldPos</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetWorldPosition || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f &in avWorldPos</syntaxhighlight>]] ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetWorldMatrix || <syntaxhighlight lang="c++" inline>[[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf &in a_mtxWorldTransform</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetWorldMatrix || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf &in a_mtxWorldTransform</syntaxhighlight>]] ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetTransformUpdateCount ||  ||
 
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetTransformUpdateCount ||  ||
Line 50: Line 50:
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetScriptableIsSaved ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetScriptableIsSaved ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetScriptableIsSaved || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetScriptableIsSaved || <syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || AddChild || <syntaxhighlight lang="c++" inline>[[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || AddChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || RemoveChild || <syntaxhighlight lang="c++" inline>[[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || RemoveChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsChild || <syntaxhighlight lang="c++" inline>[[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
 
|-
 
|-
 
| [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@</syntaxhighlight>]] || GetEntityParent ||  ||
 
| [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@</syntaxhighlight>]] || GetEntityParent ||  ||
Line 68: Line 68:
 
| [[../iVertexBuffer|<syntaxhighlight lang="c++" inline>iVertexBuffer@</syntaxhighlight>]] || GetVertexBuffer ||  ||
 
| [[../iVertexBuffer|<syntaxhighlight lang="c++" inline>iVertexBuffer@</syntaxhighlight>]] || GetVertexBuffer ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || CollidesWithBV || <syntaxhighlight lang="c++" inline>[[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+ apBV</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || CollidesWithBV || [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+ apBV</syntaxhighlight>]] ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || CollidesWithFrustum || <syntaxhighlight lang="c++" inline>[[../cFrustum|<syntaxhighlight lang="c++" inline>cFrustum@ apFrustum</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || CollidesWithFrustum || [[../cFrustum|<syntaxhighlight lang="c++" inline>cFrustum@ apFrustum</syntaxhighlight>]] ||
 
|-
 
|-
 
| [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+</syntaxhighlight>]] || GetRenderBV ||  ||
 
| [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+</syntaxhighlight>]] || GetRenderBV ||  ||
Line 78: Line 78:
 
| [[../eRenderableType|<syntaxhighlight lang="c++" inline>eRenderableType</syntaxhighlight>]] || GetRenderType ||  ||
 
| [[../eRenderableType|<syntaxhighlight lang="c++" inline>eRenderableType</syntaxhighlight>]] || GetRenderType ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetRenderFlagBit || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>int alFlagBit</syntaxhighlight>,<br /><syntaxhighlight lang="c++" inline>bool abSet</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetRenderFlagBit || <syntaxhighlight lang="c++" inline>int alFlagBit</syntaxhighlight>,<br /><syntaxhighlight lang="c++" inline>bool abSet</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetRenderFlagBit || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>int alFlagBit</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetRenderFlagBit || <syntaxhighlight lang="c++" inline>int alFlagBit</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFlags || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFlags || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsStatic ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsStatic ||  ||
Line 90: Line 90:
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsVisible ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsVisible ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetVisible || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>bool abVisible</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetVisible || <syntaxhighlight lang="c++" inline>bool abVisible</syntaxhighlight> ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetVisibleVar ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetVisibleVar ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetIlluminationColor || <syntaxhighlight lang="c++" inline>[[../cColor|<syntaxhighlight lang="c++" inline>const cColor &in aColor</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetIlluminationColor || [[../cColor|<syntaxhighlight lang="c++" inline>const cColor &in aColor</syntaxhighlight>]] ||
 
|-
 
|-
−
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetIlluminationColor || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetIlluminationColor || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetCoverageAmount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>float afX</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetCoverageAmount || <syntaxhighlight lang="c++" inline>float afX</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetCoverageAmount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetCoverageAmount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetMatrixUpdateCount ||  ||
 
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetMatrixUpdateCount ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFrameCount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFrameCount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetRenderFrameCount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>int alCount</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetRenderFrameCount || <syntaxhighlight lang="c++" inline>int alCount</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UseAutomaticLiquidAmount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>float 0</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UseAutomaticLiquidAmount || <syntaxhighlight lang="c++" inline>float 0</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetLiquidAmount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>float afX</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetLiquidAmount || <syntaxhighlight lang="c++" inline>float afX</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetLiquidAmount || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetLiquidAmount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetSize || <syntaxhighlight lang="c++" inline>[[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f &in avSize</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetSize || [[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f &in avSize</syntaxhighlight>]] ||
 
|-
 
|-
 
| [[../cVector2f|<syntaxhighlight lang="c++" inline>cVector2f</syntaxhighlight>]] || GetSize ||  ||
 
| [[../cVector2f|<syntaxhighlight lang="c++" inline>cVector2f</syntaxhighlight>]] || GetSize ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetColor || <syntaxhighlight lang="c++" inline>[[../cColor|<syntaxhighlight lang="c++" inline>const cColor& aColor</syntaxhighlight>]] ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetColor || [[../cColor|<syntaxhighlight lang="c++" inline>const cColor& aColor</syntaxhighlight>]] ||
 
|-
 
|-
 
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetColor ||  ||
 
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetColor ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetBrightness || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>float afBrightness</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetBrightness || <syntaxhighlight lang="c++" inline>float afBrightness</syntaxhighlight> ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetBrightness ||  ||
 
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetBrightness ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetTileHeight || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetTileHeight || <syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetTileHeight ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetTileHeight ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetMultiplyAlphaWithColor || <syntaxhighlight lang="c++" inline><syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetMultiplyAlphaWithColor || <syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetMultiplyAlphaWithColor ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetMultiplyAlphaWithColor ||  ||

Revision as of 23:18, 3 August 2020

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

Fields

cBeam has no public fields.

Functions

Return Type Function Name Parameters Description
eEntityType GetEntityType
tID GetID
int GetUniqueID
void UpdateLogic float afTimeStep
const tString& GetName const
void SetName const tString &in asName
bool HasParent
bool IsActive const
void SetActive bool abActive
cVector3f GetLocalPosition
cMatrixf& GetLocalMatrix
cVector3f GetWorldPosition
cMatrixf& GetWorldMatrix
void SetPosition const cVector3f &in avPos
void SetMatrix const cMatrixf &in a_mtxTransform
void SetWorldPosition const cVector3f &in avWorldPos
void SetWorldMatrix const cMatrixf &in a_mtxWorldTransform
int GetTransformUpdateCount
cBoundingVolume@+ GetBoundingVolume
bool GetScriptableIsSaved
void SetScriptableIsSaved bool abX
void AddChild iEntity3D@ apEntity
void RemoveChild iEntity3D@ apEntity
bool IsChild iEntity3D@ apEntity
iEntity3D@ GetEntityParent
cEntity3DIterator@ GetChildIterator
const tString& GetRenderName
cMaterial@ GetMaterial
iVertexBuffer@ GetVertexBuffer
bool CollidesWithBV cBoundingVolume@+ apBV
bool CollidesWithFrustum cFrustum@ apFrustum
cBoundingVolume@+ GetRenderBV
cVector3f GetWorldCenterPosition
eRenderableType GetRenderType
void SetRenderFlagBit int alFlagBit,
bool abSet
bool GetRenderFlagBit int alFlagBit
int GetRenderFlags const
bool IsStatic
bool IsOccluder
bool IsVisible
void SetVisible bool abVisible
bool GetVisibleVar
void SetIlluminationColor const cColor &in aColor
const cColor& GetIlluminationColor const
void SetCoverageAmount float afX
float GetCoverageAmount const
int GetMatrixUpdateCount
int GetRenderFrameCount const
void SetRenderFrameCount int alCount
void UseAutomaticLiquidAmount float 0
void SetLiquidAmount float afX
float GetLiquidAmount const
void SetSize const cVector2f &in avSize
cVector2f GetSize
void SetColor const cColor& aColor
const cColor& GetColor
void SetBrightness float afBrightness
float GetBrightness
void SetTileHeight bool abX
bool GetTileHeight
void SetMultiplyAlphaWithColor bool abX
bool GetMultiplyAlphaWithColor
cBeamEnd@ GetEnd
cVector3f GetAxis
cVector3f GetMidPosition
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/cBeam&oldid=2826"