Difference between revisions of "HPL3/SOMA/Scripting/cBeam"
Jump to navigation
Jump to search
Line 10: | Line 10: | ||
! Return Type !! Function Name !! Parameters !! Description | ! Return Type !! Function Name !! Parameters !! Description | ||
|- | |- | ||
− | | [[../ | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || AddChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] || |
|- | |- | ||
− | | [[../ | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || CollidesWithBV || [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+ apBV</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || CollidesWithFrustum || [[../cFrustum|<syntaxhighlight lang="c++" inline>cFrustum@ apFrustum</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetAxis || || |
|- | |- | ||
− | | [[../ | + | | [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+</syntaxhighlight>]] || GetBoundingVolume || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetBrightness || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cEntity3DIterator|<syntaxhighlight lang="c++" inline>cEntity3DIterator@</syntaxhighlight>]] || GetChildIterator || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetColor || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetCoverageAmount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> || |
|- | |- | ||
− | | [[../ | + | | [[../cBeamEnd|<syntaxhighlight lang="c++" inline>cBeamEnd@</syntaxhighlight>]] || GetEnd || || |
|- | |- | ||
− | | [[../ | + | | [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@</syntaxhighlight>]] || GetEntityParent || || |
|- | |- | ||
− | | [[../ | + | | [[../eEntityType|<syntaxhighlight lang="c++" inline>eEntityType</syntaxhighlight>]] || GetEntityType || || |
|- | |- | ||
− | | [[../ | + | | [[../tID|<syntaxhighlight lang="c++" inline>tID</syntaxhighlight>]] || GetID || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cColor|<syntaxhighlight lang="c++" inline>const cColor&</syntaxhighlight>]] || GetIlluminationColor || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>float</syntaxhighlight> || GetLiquidAmount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> || |
|- | |- | ||
− | + | | [[../cMatrixf|<syntaxhighlight lang="c++" inline>cMatrixf&</syntaxhighlight>]] || GetLocalMatrix || || | |
|- | |- | ||
− | + | | [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetLocalPosition || || | |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cMaterial|<syntaxhighlight lang="c++" inline>cMaterial@</syntaxhighlight>]] || GetMaterial || || |
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetMatrixUpdateCount || || | |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetMidPosition || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetMultiplyAlphaWithColor || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetName || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> || |
|- | |- | ||
− | + | | [[../cBoundingVolume|<syntaxhighlight lang="c++" inline>cBoundingVolume@+</syntaxhighlight>]] || GetRenderBV || || | |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>bool</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> || GetRenderFrameCount || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> || | |
|- | |- | ||
| [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetRenderName || || | | [[../tString|<syntaxhighlight lang="c++" inline>const tString&</syntaxhighlight>]] || GetRenderName || || | ||
|- | |- | ||
− | | [[../ | + | | [[../eRenderableType|<syntaxhighlight lang="c++" inline>eRenderableType</syntaxhighlight>]] || GetRenderType || || |
+ | |- | ||
+ | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetScriptableIsSaved || || | ||
+ | |- | ||
+ | | [[../cVector2f|<syntaxhighlight lang="c++" inline>cVector2f</syntaxhighlight>]] || GetSize || || | ||
+ | |- | ||
+ | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetTileHeight || || | ||
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetTransformUpdateCount || || | |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>int</syntaxhighlight> || GetUniqueID || || |
|- | |- | ||
− | + | | [[../iVertexBuffer|<syntaxhighlight lang="c++" inline>iVertexBuffer@</syntaxhighlight>]] || GetVertexBuffer || || | |
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || GetVisibleVar || || | |
|- | |- | ||
| [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetWorldCenterPosition || || | | [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetWorldCenterPosition || || | ||
|- | |- | ||
− | | [[../ | + | | [[../cMatrixf|<syntaxhighlight lang="c++" inline>cMatrixf&</syntaxhighlight>]] || GetWorldMatrix || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | [[../cVector3f|<syntaxhighlight lang="c++" inline>cVector3f</syntaxhighlight>]] || GetWorldPosition || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || HasParent || || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsActive || <syntaxhighlight lang="c++" inline>const</syntaxhighlight> || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] || |
|- | |- | ||
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsOccluder || || | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsOccluder || || | ||
+ | |- | ||
+ | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsStatic || || | ||
|- | |- | ||
| <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsVisible || || | | <syntaxhighlight lang="c++" inline>bool</syntaxhighlight> || IsVisible || || | ||
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || RemoveChild || [[../iEntity3D|<syntaxhighlight lang="c++" inline>iEntity3D@ apEntity</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetActive || <syntaxhighlight lang="c++" inline>bool abActive</syntaxhighlight> || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetBrightness || <syntaxhighlight lang="c++" inline>float afBrightness</syntaxhighlight> || |
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetColor || [[../cColor|<syntaxhighlight lang="c++" inline>const cColor& aColor</syntaxhighlight>]] || | |
|- | |- | ||
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetCoverageAmount || <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> | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetIlluminationColor || [[../cColor|<syntaxhighlight lang="c++" inline>const cColor &in aColor</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetLiquidAmount || <syntaxhighlight lang="c++" inline>float afX</syntaxhighlight> || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetMatrix || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf &in a_mtxTransform</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetMultiplyAlphaWithColor || <syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetName || [[../tString|<syntaxhighlight lang="c++" inline>const tString &in asName</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetPosition || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f &in avPos</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <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>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetRenderFrameCount || <syntaxhighlight lang="c++" inline>int alCount</syntaxhighlight> || |
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetScriptableIsSaved || <syntaxhighlight lang="c++" inline>bool abX</syntaxhighlight> || | |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetSize || [[../cVector2f|<syntaxhighlight lang="c++" inline>const cVector2f &in avSize</syntaxhighlight>]] || |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetTileHeight || <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> | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetVisible || <syntaxhighlight lang="c++" inline>bool abVisible</syntaxhighlight> || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetWorldMatrix || [[../cMatrixf|<syntaxhighlight lang="c++" inline>const cMatrixf &in a_mtxWorldTransform</syntaxhighlight>]] || |
|- | |- | ||
− | | <syntaxhighlight lang="c++" inline> | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || SetWorldPosition || [[../cVector3f|<syntaxhighlight lang="c++" inline>const cVector3f &in avWorldPos</syntaxhighlight>]] || |
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UpdateLogic || <syntaxhighlight lang="c++" inline>float afTimeStep</syntaxhighlight> || | |
|- | |- | ||
− | + | | <syntaxhighlight lang="c++" inline>void</syntaxhighlight> || UseAutomaticLiquidAmount || <syntaxhighlight lang="c++" inline>float 0</syntaxhighlight> || | |
− | | | ||
− | | | ||
|} | |} | ||
Revision as of 23:19, 3 August 2020
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
Contents
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 | const |
|
cBeamEnd@ |
GetEnd | ||
iEntity3D@ |
GetEntityParent | ||
eEntityType |
GetEntityType | ||
tID |
GetID | ||
const cColor& |
GetIlluminationColor | const |
|
float |
GetLiquidAmount | const |
|
cMatrixf& |
GetLocalMatrix | ||
cVector3f |
GetLocalPosition | ||
cMaterial@ |
GetMaterial | ||
int |
GetMatrixUpdateCount | ||
cVector3f |
GetMidPosition | ||
bool |
GetMultiplyAlphaWithColor | ||
const tString& |
GetName | const |
|
cBoundingVolume@+ |
GetRenderBV | ||
bool |
GetRenderFlagBit | int alFlagBit |
|
int |
GetRenderFlags | const |
|
int |
GetRenderFrameCount | const |
|
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 | const |
|
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 0 |