HPL3/Amnesia: Rebirth/Scripting/cForceField

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

Fields

cForceField has no public fields.

Functions

Return Type	Function And Description
void	AddChild(iEntity3D@ apEntity)
bool	CollidesWithBV(cBoundingVolume@+ apBV)
bool	CollidesWithFrustum(cFrustum@ apFrustum)
void	FadeOut(float afTime)
void	FadeTo(float afAmount, float afTime)
bool	GetAutoRemove()
cBoundingVolume	GetBoundingVolume()
cEntity3DIterator	GetChildIterator()
float	GetCoverageAmount()
iEntity3D	GetEntityParent()
eEntityType	GetEntityType()
float	GetFalloffStartRadius()
float	GetFinalFalloffStartRadius()
float	GetFinalForce()
float	GetFinalFreq()
float	GetFinalRadius()
float	GetForce()
float	GetFreq()
tID	GetID()
cColor	GetIlluminationColor()
float	GetLiquidAmount()
cMatrixf	GetLocalMatrix()
cVector3f	GetLocalPosition()
cMaterial	GetMaterial()
int	GetMatrixUpdateCount()
tString	GetName()
bool	GetPulsateActive()
cVector2f	GetPulsateDecSpeed()
cVector2f	GetPulsateForceMulMax()
cVector2f	GetPulsateForceMulMin()
cVector2f	GetPulsateIncSpeed()
cVector2f	GetPulsateRadiusMulMax()
cVector2f	GetPulsateRadiusMulMin()
float	GetRadius()
cBoundingVolume	GetRenderBV()
bool	GetRenderFlagBit(int alFlagBit)
int	GetRenderFlags()
int	GetRenderFrameCount()
int	GetRenderLayer()
tString	GetRenderName()
eRenderableType	GetRenderType()
bool	GetScriptableIsSaved()
float	GetT()
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	SetAutoRemove(bool abX)
void	SetCoverageAmount(float afX)
void	SetFalloffStartRadius(float afX)
void	SetForce(float afX)
void	SetFreq(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	SetPulsateActive(bool abX)
void	SetPulsateDecSpeed(const cVector2f &in avVec)
void	SetPulsateForceMulMax(const cVector2f &in avVec)
void	SetPulsateForceMulMin(const cVector2f &in avVec)
void	SetPulsateIncSpeed(const cVector2f &in avVec)
void	SetPulsateRadiusMulMax(const cVector2f &in avVec)
void	SetPulsateRadiusMulMin(const cVector2f &in avVec)
void	SetRadius(float afX)
void	SetRenderFlagBit(int alFlagBit, bool abSet)
void	SetRenderFrameCount(int alCount)
void	SetRenderLayer(int alX)
void	SetScriptableIsSaved(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

• apEntity (iEntity3D@) —

Returns:

• void

CollidesWithBV

bool CollidesWithBV(cBoundingVolume@+ apBV)

Parameters

• apBV (cBoundingVolume@+) —

Returns:

• bool—

CollidesWithFrustum

bool CollidesWithFrustum(cFrustum@ apFrustum)

Parameters

• apFrustum (cFrustum@) —

Returns:

• bool—

FadeOut

void FadeOut(float afTime)

Parameters

• afTime (float) —

Returns:

• void

FadeTo

void FadeTo(float afAmount,
            float afTime)

Parameters

• afAmount (float) —
• afTime (float) —

Returns:

• void

GetAutoRemove

bool GetAutoRemove()

Returns:

• bool—

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

• cBoundingVolume@+—

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

• cEntity3DIterator@—

GetCoverageAmount

float GetCoverageAmount()

Returns:

• float—

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

• iEntity3D@—

GetEntityType

eEntityType GetEntityType()

Returns:

• eEntityType—

GetFalloffStartRadius

float GetFalloffStartRadius()

Returns:

• float—

GetFinalFalloffStartRadius

float GetFinalFalloffStartRadius()

Returns:

• float—

GetFinalForce

float GetFinalForce()

Returns:

• float—

GetFinalFreq

float GetFinalFreq()

Returns:

• float—

GetFinalRadius

float GetFinalRadius()

Returns:

• float—

GetForce

float GetForce()

Returns:

• float—

GetFreq

float GetFreq()

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&—

GetPulsateActive

bool GetPulsateActive()

Returns:

• bool—

GetPulsateDecSpeed

const cVector2f& GetPulsateDecSpeed()

Returns:

• const cVector2f&—

GetPulsateForceMulMax

const cVector2f& GetPulsateForceMulMax()

Returns:

• const cVector2f&—

GetPulsateForceMulMin

const cVector2f& GetPulsateForceMulMin()

Returns:

• const cVector2f&—

GetPulsateIncSpeed

const cVector2f& GetPulsateIncSpeed()

Returns:

• const cVector2f&—

GetPulsateRadiusMulMax

const cVector2f& GetPulsateRadiusMulMax()

Returns:

• const cVector2f&—

GetPulsateRadiusMulMin

const cVector2f& GetPulsateRadiusMulMin()

Returns:

• const cVector2f&—

GetRadius

float GetRadius()

Returns:

• float—

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—

GetT

float GetT()

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

• apEntity (iEntity3D@) —

Returns:

• bool—

IsOccluder

bool IsOccluder()

Returns:

• bool—

IsStatic

bool IsStatic()

Returns:

• bool—

IsVisible

bool IsVisible()

Returns:

• bool—

RemoveChild

void RemoveChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

SetActive

void SetActive(bool abActive)

Parameters

• abActive (bool) —

Returns:

• void

SetAutoRemove

void SetAutoRemove(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetCoverageAmount

void SetCoverageAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetFalloffStartRadius

void SetFalloffStartRadius(float afX)

Parameters

• afX (float) —

Returns:

• void

SetForce

void SetForce(float afX)

Parameters

• afX (float) —

Returns:

• void

SetFreq

void SetFreq(float afX)

Parameters

• afX (float) —

Returns:

• void

SetIlluminationColor

void SetIlluminationColor(const cColor &in aColor)

Parameters

• aColor (cColor) —

Returns:

• void

SetLiquidAmount

void SetLiquidAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)

Parameters

• a_mtxTransform (cMatrixf) —

Returns:

• void

SetName

void SetName(const tString &in asName)

Parameters

• asName (tString) —

Returns:

• void

SetPosition

void SetPosition(const cVector3f &in avPos)

Parameters

• avPos (cVector3f) —

Returns:

• void

SetPulsateActive

void SetPulsateActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetPulsateDecSpeed

void SetPulsateDecSpeed(const cVector2f &in avVec)

Parameters

• avVec (cVector2f) —

Returns:

• void

SetPulsateForceMulMax

void SetPulsateForceMulMax(const cVector2f &in avVec)

Parameters

• avVec (cVector2f) —

Returns:

• void

SetPulsateForceMulMin

void SetPulsateForceMulMin(const cVector2f &in avVec)

Parameters

• avVec (cVector2f) —

Returns:

• void

SetPulsateIncSpeed

void SetPulsateIncSpeed(const cVector2f &in avVec)

Parameters

• avVec (cVector2f) —

Returns:

• void

SetPulsateRadiusMulMax

void SetPulsateRadiusMulMax(const cVector2f &in avVec)

Parameters

• avVec (cVector2f) —

Returns:

• void

SetPulsateRadiusMulMin

void SetPulsateRadiusMulMin(const cVector2f &in avVec)

Parameters

• avVec (cVector2f) —

Returns:

• void

SetRadius

void SetRadius(float afX)

Parameters

• afX (float) —

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

SetVisible

void SetVisible(bool abVisible)

Parameters

• abVisible (bool) —

Returns:

• void

SetWorldMatrix

void SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)

Parameters

• a_mtxWorldTransform (cMatrixf) —

Returns:

• void

SetWorldPosition

void SetWorldPosition(const cVector3f &in avWorldPos)

Parameters

• avWorldPos (cVector3f) —

Returns:

• void

UpdateLogic

void UpdateLogic(float afTimeStep)

Parameters

• afTimeStep (float) —

Returns:

• void

UseAutomaticLiquidAmount

void UseAutomaticLiquidAmount(float afTime = 0)

Parameters

• afTime (float) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cForceFieldIterator ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cWorld ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cScene ‎ (← links)

See all references...