HPL3/Amnesia: Rebirth/Scripting/cBeam

From Frictional Wiki
Jump to navigation Jump to search

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 And Description
void AddChild(iEntity3D@ apEntity)
bool CollidesWithBV(cBoundingVolume@+ apBV)
bool CollidesWithFrustum(cFrustum@ apFrustum)
cVector3f GetAxis()
cBoundingVolume GetBoundingVolume()
float GetBrightness()
cEntity3DIterator GetChildIterator()
cColor GetColor()
float GetCoverageAmount()
cBeamEnd GetEnd()
iEntity3D GetEntityParent()
eEntityType GetEntityType()
tID GetID()
cColor GetIlluminationColor()
float GetLiquidAmount()
cMatrixf GetLocalMatrix()
cVector3f GetLocalPosition()
cMaterial GetMaterial()
int GetMatrixUpdateCount()
cVector3f GetMidPosition()
bool GetMultiplyAlphaWithColor()
tString GetName()
cBoundingVolume GetRenderBV()
bool GetRenderFlagBit(int alFlagBit)
int GetRenderFlags()
int GetRenderFrameCount()
int GetRenderLayer()
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 &in 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 SetRenderLayer(int alX)
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)

Details

AddChild

void AddChild(iEntity3D@ apEntity)


Parameters

Returns:

  • void

CollidesWithBV

bool CollidesWithBV(cBoundingVolume@+ apBV)


Parameters

Returns:

  • bool

CollidesWithFrustum

bool CollidesWithFrustum(cFrustum@ apFrustum)


Parameters

Returns:

  • bool

GetAxis

cVector3f GetAxis()

Returns:

  • cVector3f

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

  • cBoundingVolume@+

GetBrightness

float GetBrightness()

Returns:

  • float

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

  • cEntity3DIterator@

GetColor

const cColor& GetColor()

Returns:

  • const cColor&

GetCoverageAmount

float GetCoverageAmount()

Returns:

  • float

GetEnd

cBeamEnd@ GetEnd()

Returns:

  • cBeamEnd@

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

  • iEntity3D@

GetEntityType

eEntityType GetEntityType()

Returns:

  • eEntityType

GetID

tID GetID()

Returns:

  • tID

GetIlluminationColor

const cColor& GetIlluminationColor()

Returns:

  • const cColor&

GetLiquidAmount

float GetLiquidAmount()

Returns:

  • float

GetLocalMatrix

cMatrixf& GetLocalMatrix()

Returns:

  • cMatrixf&

GetLocalPosition

cVector3f GetLocalPosition()

Returns:

  • cVector3f

GetMaterial

cMaterial@ GetMaterial()

Returns:

  • cMaterial@

GetMatrixUpdateCount

int GetMatrixUpdateCount()

Returns:

  • int

GetMidPosition

cVector3f GetMidPosition()

Returns:

  • cVector3f

GetMultiplyAlphaWithColor

bool GetMultiplyAlphaWithColor()

Returns:

  • bool

GetName

const tString& GetName()

Returns:

  • const tString&

GetRenderBV

cBoundingVolume@+ GetRenderBV()

Returns:

  • cBoundingVolume@+

GetRenderFlagBit

bool GetRenderFlagBit(int alFlagBit)


Parameters

  • alFlagBit (int) —

Returns:

  • bool

GetRenderFlags

int GetRenderFlags()

Returns:

  • int

GetRenderFrameCount

int GetRenderFrameCount()

Returns:

  • int

GetRenderLayer

int GetRenderLayer()

Returns:

  • int

GetRenderName

const tString& GetRenderName()

Returns:

  • const tString&

GetRenderType

eRenderableType GetRenderType()

Returns:

  • eRenderableType

GetScriptableIsSaved

bool GetScriptableIsSaved()

Returns:

  • bool

GetSize

cVector2f GetSize()

Returns:

  • cVector2f

GetTileHeight

bool GetTileHeight()

Returns:

  • bool

GetTransformUpdateCount

int GetTransformUpdateCount()

Returns:

  • int

GetUniqueID

int GetUniqueID()

Returns:

  • int

GetVertexBuffer

iVertexBuffer@ GetVertexBuffer()

Returns:

  • iVertexBuffer@

GetVisibleVar

bool GetVisibleVar()

Returns:

  • bool

GetWorldCenterPosition

cVector3f GetWorldCenterPosition()

Returns:

  • cVector3f

GetWorldMatrix

cMatrixf& GetWorldMatrix()

Returns:

  • cMatrixf&

GetWorldPosition

cVector3f GetWorldPosition()

Returns:

  • cVector3f

HasParent

bool HasParent()

Returns:

  • bool

IsActive

bool IsActive()

Returns:

  • bool

IsChild

bool IsChild(iEntity3D@ apEntity)


Parameters

Returns:

  • bool

IsOccluder

bool IsOccluder()

Returns:

  • bool

IsStatic

bool IsStatic()

Returns:

  • bool

IsVisible

bool IsVisible()

Returns:

  • bool

RemoveChild

void RemoveChild(iEntity3D@ apEntity)


Parameters

Returns:

  • void

SetActive

void SetActive(bool abActive)


Parameters

  • abActive (bool) —

Returns:

  • void

SetBrightness

void SetBrightness(float afBrightness)


Parameters

  • afBrightness (float) —

Returns:

  • void

SetColor

void SetColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetCoverageAmount

void SetCoverageAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetIlluminationColor

void SetIlluminationColor(const cColor &in aColor)


Parameters

Returns:

  • void

SetLiquidAmount

void SetLiquidAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)


Parameters

Returns:

  • void

SetMultiplyAlphaWithColor

void SetMultiplyAlphaWithColor(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetName

void SetName(const tString &in asName)


Parameters

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetRenderFlagBit

void SetRenderFlagBit(int alFlagBit,
                      bool abSet)


Parameters

  • alFlagBit (int) —
  • abSet (bool) —

Returns:

  • void

SetRenderFrameCount

void SetRenderFrameCount(int alCount)


Parameters

  • alCount (int) —

Returns:

  • void

SetRenderLayer

void SetRenderLayer(int alX)


Parameters

  • alX (int) —

Returns:

  • void

SetScriptableIsSaved

void SetScriptableIsSaved(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSize

void SetSize(const cVector2f &in avSize)


Parameters

Returns:

  • void

SetTileHeight

void SetTileHeight(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetVisible

void SetVisible(bool abVisible)


Parameters

  • abVisible (bool) —

Returns:

  • void

SetWorldMatrix

void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)


Parameters

Returns:

  • void

SetWorldPosition

void SetWorldPosition(const cVector3f &in avWorldPos)


Parameters

Returns:

  • void

UpdateLogic

void UpdateLogic(float afTimeStep)


Parameters

  • afTimeStep (float) —

Returns:

  • void

UseAutomaticLiquidAmount

void UseAutomaticLiquidAmount(float afTime = 0)


Parameters

  • afTime (float) —

Returns:

  • void

References

See all references...