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

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{ScriptingStub}}
 +
 
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
 
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
  
Line 26: Line 28:
 
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetColor ||  ||
 
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetColor ||  ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetCoverageAmount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetCoverageAmount || ||
 
|-
 
|-
 
| [[../cBeamEnd|<syntaxhighlight lang="c++" inline>cBeamEnd@</syntaxhighlight>]] || GetEnd ||  ||
 
| [[../cBeamEnd|<syntaxhighlight lang="c++" inline>cBeamEnd@</syntaxhighlight>]] || GetEnd ||  ||
Line 36: Line 38:
 
| [[../tID|<syntaxhighlight lang="c++" inline>tID</syntaxhighlight>]] || GetID ||  ||
 
| [[../tID|<syntaxhighlight lang="c++" inline>tID</syntaxhighlight>]] || GetID ||  ||
 
|-
 
|-
−
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetIlluminationColor || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetIlluminationColor || ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetLiquidAmount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetLiquidAmount || ||
 
|-
 
|-
 
| [[../cMatrixf|<syntaxhighlight lang="c++" inline>cMatrixf&</syntaxhighlight>]] || GetLocalMatrix ||  ||
 
| [[../cMatrixf|<syntaxhighlight lang="c++" inline>cMatrixf&</syntaxhighlight>]] || GetLocalMatrix ||  ||
Line 52: Line 54:
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetMultiplyAlphaWithColor ||  ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetMultiplyAlphaWithColor ||  ||
 
|-
 
|-
−
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetName || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetName || ||
 
|-
 
|-
 
| [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+</syntaxhighlight>]] || GetRenderBV ||  ||
 
| [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+</syntaxhighlight>]] || GetRenderBV ||  ||
Line 58: Line 60:
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetRenderFlagBit || <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>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFlags || ||
 
|-
 
|-
−
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFrameCount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetRenderFrameCount || ||
 
|-
 
|-
 
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetRenderName ||  ||
 
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetRenderName ||  ||
Line 88: Line 90:
 
| <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>const</syntaxhighlight> ||
+
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsActive || ||
 
|-
 
|-
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
 
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] ||
Line 141: Line 143:
 
|}
 
|}
  
−
[[Category:HPL3]]
+
{{ReferencesSection}}
−
[[Category:HPL3 Scripting]]
+
 
−
[[Category:HPL3 Classes]]
+
{{HPL3SOMAScriptingCategories}}
 
__FORCETOC__
 
__FORCETOC__

Latest revision as of 14:20, 6 August 2020

Info icon.png

This page has been automatically generated, but it needs descriptions added to the various fields/functions in order to be complete.

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

Fields

cBeam has no public fields.

Functions

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

References

See all references...

Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/cBeam&oldid=3529"