HPL3/Amnesia: Rebirth/Scripting/cFogArea

From Frictional Wiki
< HPL3‎ | Amnesia: Rebirth‎ | Scripting
Revision as of 22:08, 15 November 2020 by Abion47 (talk | contribs) (Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Fields== cFogArea has no public fields. ==Function...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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!

Contents

Fields

cFogArea has no public fields.

Functions

Return Type Function And Description
void AddChild(iEntity3D@ apEntity)
bool CollidesWithBV(cBoundingVolume@+ apBV)
bool CollidesWithFrustum(cFrustum@ apFrustum)
cBoundingVolume GetBoundingVolume()
cEntity3DIterator GetChildIterator()
cColor GetColor()
float GetCoverageAmount()
float GetDensity()
float GetEnd()
iEntity3D GetEntityParent()
eEntityType GetEntityType()
bool GetExponential()
float GetFalloffExp()
bool GetHeightBased()
float GetHeightDensity()
float GetHeightHorizon()
tID GetID()
cColor GetIlluminationColor()
float GetLiquidAmount()
cMatrixf GetLocalMatrix()
cVector3f GetLocalPosition()
cMaterial GetMaterial()
int GetMatrixUpdateCount()
tString GetName()
int GetPrio()
cBoundingVolume GetRenderBV()
bool GetRenderFlagBit(int alFlagBit)
int GetRenderFlags()
int GetRenderFrameCount()
int GetRenderLayer()
tString GetRenderName()
eRenderableType GetRenderType()
bool GetScriptableIsSaved()
bool GetShowBacksideWhenInside()
bool GetShowBacksideWhenOutside()
cVector3f GetSize()
float GetStart()
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 SetColor(const cColor &in aCol)
void SetCoverageAmount(float afX)
void SetDensity(float afX)
void SetEnd(float afX)
void SetExponential(bool abX)
void SetFalloffExp(float afX)
void SetHeightBased(bool abX)
void SetHeightDensity(float afX)
void SetHeightHorizon(float afX)
void SetIlluminationColor(const cColor &in aColor)
void SetLiquidAmount(float afX)
void SetMatrix(const cMatrixf &in a_mtxTransform)
void SetName(const tString &in asName)
void SetPosition(const cVector3f &in avPos)
void SetPrio(int alX)
void SetRenderFlagBit(int alFlagBit, bool abSet)
void SetRenderFrameCount(int alCount)
void SetRenderLayer(int alX)
void SetScriptableIsSaved(bool abX)
void SetShowBacksideWhenInside(bool abX)
void SetShowBacksideWhenOutside(bool abX)
void SetSize(const cVector3f &in avSize)
void SetStart(float afX)
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

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

  • cBoundingVolume@+

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

  • cEntity3DIterator@

GetColor

const cColor& GetColor()

Returns:

  • const cColor&

GetCoverageAmount

float GetCoverageAmount()

Returns:

  • float

GetDensity

float GetDensity()

Returns:

  • float

GetEnd

float GetEnd()

Returns:

  • float

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

  • iEntity3D@

GetEntityType

eEntityType GetEntityType()

Returns:

  • eEntityType

GetExponential

bool GetExponential()

Returns:

  • bool

GetFalloffExp

float GetFalloffExp()

Returns:

  • float

GetHeightBased

bool GetHeightBased()

Returns:

  • bool

GetHeightDensity

float GetHeightDensity()

Returns:

  • float

GetHeightHorizon

float GetHeightHorizon()

Returns:

  • float

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

GetName

const tString& GetName()

Returns:

  • const tString&

GetPrio

int GetPrio()

Returns:

  • int

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

GetShowBacksideWhenInside

bool GetShowBacksideWhenInside()

Returns:

  • bool

GetShowBacksideWhenOutside

bool GetShowBacksideWhenOutside()

Returns:

  • bool

GetSize

const cVector3f& GetSize()

Returns:

  • const cVector3f&

GetStart

float GetStart()

Returns:

  • float

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

SetColor

void SetColor(const cColor &in aCol)


Parameters

Returns:

  • void

SetCoverageAmount

void SetCoverageAmount(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetDensity

void SetDensity(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetEnd

void SetEnd(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetExponential

void SetExponential(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetFalloffExp

void SetFalloffExp(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetHeightBased

void SetHeightBased(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetHeightDensity

void SetHeightDensity(float afX)


Parameters

  • afX (float) —

Returns:

  • void

SetHeightHorizon

void SetHeightHorizon(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

SetName

void SetName(const tString &in asName)


Parameters

Returns:

  • void

SetPosition

void SetPosition(const cVector3f &in avPos)


Parameters

Returns:

  • void

SetPrio

void SetPrio(int alX)


Parameters

  • alX (int) —

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

SetShowBacksideWhenInside

void SetShowBacksideWhenInside(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetShowBacksideWhenOutside

void SetShowBacksideWhenOutside(bool abX)


Parameters

  • abX (bool) —

Returns:

  • void

SetSize

void SetSize(const cVector3f &in avSize)


Parameters

Returns:

  • void

SetStart

void SetStart(float afX)


Parameters

  • afX (float) —

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...