HPL3/Amnesia: Rebirth/Scripting/cParticleSystem

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

Fields

cParticleSystem has no public fields.

Functions

Return Type	Function And Description
void	AddChild(iEntity3D@ apEntity)
cBoundingVolume	GetBoundingVolume()
float	GetBrightness()
cEntity3DIterator	GetChildIterator()
cColor	GetColor()
cVector3f	GetCustomOrigin()
iEntity3D	GetEntityParent()
eEntityType	GetEntityType()
bool	GetFadeAtDistance()
tID	GetID()
cMatrixf	GetLocalMatrix()
cVector3f	GetLocalPosition()
float	GetMaxFadeDistanceEnd()
float	GetMaxFadeDistanceStart()
float	GetMinFadeDistanceEnd()
float	GetMinFadeDistanceStart()
tString	GetName()
bool	GetRemoveWhenDead()
bool	GetScriptableIsSaved()
int	GetTransformUpdateCount()
int	GetUniqueID()
bool	GetUseCustomOrigin()
cMatrixf	GetWorldMatrix()
cVector3f	GetWorldPosition()
bool	HasParent()
bool	IsActive()
bool	IsChild(iEntity3D@ apEntity)
bool	IsDead()
bool	IsDying()
bool	IsVisible()
void	Kill()
void	KillInstantly()
void	RemoveChild(iEntity3D@ apEntity)
void	Restart()
void	SetActive(bool abActive)
void	SetBrightness(float afX)
void	SetColor(const cColor &in aColor)
void	SetCustomOrigin(const cVector3f &in avCustomOrigin)
void	SetFadeAtDistance(bool abX)
void	SetMatrix(const cMatrixf &in a_mtxTransform)
void	SetMaxFadeDistanceEnd(float afX)
void	SetMaxFadeDistanceStart(float afX)
void	SetMinFadeDistanceEnd(float afX)
void	SetMinFadeDistanceStart(float afX)
void	SetName(const tString &in asName)
void	SetPosition(const cVector3f &in avPos)
void	SetRemoveWhenDead(bool abX)
void	SetScriptableIsSaved(bool abX)
void	SetUseCustomOrigin(bool abX)
void	SetVisible(bool abVisible)
void	SetWorldMatrix(const cMatrixf &in a_mtxWorldTransform)
void	SetWorldPosition(const cVector3f &in avWorldPos)
void	UpdateLogic(float afTimeStep)

Details

AddChild

void AddChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

GetBoundingVolume

cBoundingVolume@+ GetBoundingVolume()

Returns:

• cBoundingVolume@+—

GetBrightness

float GetBrightness()

Returns:

• float—

GetChildIterator

cEntity3DIterator@ GetChildIterator()

Returns:

• cEntity3DIterator@—

GetColor

const cColor& GetColor()

Returns:

• const cColor&—

GetCustomOrigin

const cVector3f& GetCustomOrigin()

Returns:

• const cVector3f&—

GetEntityParent

iEntity3D@ GetEntityParent()

Returns:

• iEntity3D@—

GetEntityType

eEntityType GetEntityType()

Returns:

• eEntityType—

GetFadeAtDistance

bool GetFadeAtDistance()

Returns:

• bool—

GetID

tID GetID()

Returns:

• tID—

GetLocalMatrix

cMatrixf& GetLocalMatrix()

Returns:

• cMatrixf&—

GetLocalPosition

cVector3f GetLocalPosition()

Returns:

• cVector3f—

GetMaxFadeDistanceEnd

float GetMaxFadeDistanceEnd()

Returns:

• float—

GetMaxFadeDistanceStart

float GetMaxFadeDistanceStart()

Returns:

• float—

GetMinFadeDistanceEnd

float GetMinFadeDistanceEnd()

Returns:

• float—

GetMinFadeDistanceStart

float GetMinFadeDistanceStart()

Returns:

• float—

GetName

const tString& GetName()

Returns:

• const tString&—

GetRemoveWhenDead

bool GetRemoveWhenDead()

Returns:

• bool—

GetScriptableIsSaved

bool GetScriptableIsSaved()

Returns:

• bool—

GetTransformUpdateCount

int GetTransformUpdateCount()

Returns:

• int—

GetUniqueID

int GetUniqueID()

Returns:

• int—

GetUseCustomOrigin

bool GetUseCustomOrigin()

Returns:

• bool—

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—

IsDead

bool IsDead()

Returns:

• bool—

IsDying

bool IsDying()

Returns:

• bool—

IsVisible

bool IsVisible()

Returns:

• bool—

Kill

void Kill()

Returns:

• void

KillInstantly

void KillInstantly()

Returns:

• void

RemoveChild

void RemoveChild(iEntity3D@ apEntity)

Parameters

• apEntity (iEntity3D@) —

Returns:

• void

Restart

void Restart()

Returns:

• void

SetActive

void SetActive(bool abActive)

Parameters

• abActive (bool) —

Returns:

• void

SetBrightness

void SetBrightness(float afX)

Parameters

• afX (float) —

Returns:

• void

SetColor

void SetColor(const cColor &in aColor)

Parameters

• aColor (cColor) —

Returns:

• void

SetCustomOrigin

void SetCustomOrigin(const cVector3f &in avCustomOrigin)

Parameters

• avCustomOrigin (cVector3f) —

Returns:

• void

SetFadeAtDistance

void SetFadeAtDistance(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetMatrix

void SetMatrix(const cMatrixf &in a_mtxTransform)

Parameters

• a_mtxTransform (cMatrixf) —

Returns:

• void

SetMaxFadeDistanceEnd

void SetMaxFadeDistanceEnd(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMaxFadeDistanceStart

void SetMaxFadeDistanceStart(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMinFadeDistanceEnd

void SetMinFadeDistanceEnd(float afX)

Parameters

• afX (float) —

Returns:

• void

SetMinFadeDistanceStart

void SetMinFadeDistanceStart(float afX)

Parameters

• afX (float) —

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

SetRemoveWhenDead

void SetRemoveWhenDead(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetScriptableIsSaved

void SetScriptableIsSaved(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetUseCustomOrigin

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

References

• HPL3/Amnesia: Rebirth/Scripting/Scripting Api ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLightBox ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLightDirectional ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLightPoint ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLightSpot ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxAgent ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxCritter ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxLiquidArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxProp ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxPushableFogArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxSoundscapeArea ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cLuxVisibilityPortal ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cParticleSystemIterator ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/cWorld ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iLight ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/iLuxEntity ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/cLux ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/Map ‎ (← links)
• HPL3/Amnesia: Rebirth/Scripting/Scripting Api/ParticleSystem ‎ (← links)

See all references...