HPL3/Amnesia: Rebirth/Scripting/cEnvironmentParticles

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

Fields

cEnvironmentParticles has no public fields.

Functions

Return Type	Function And Description
void	AddClipArea(iEntity3D@ apClipEntity, bool abSubtractive)
float	GetBrightness()
bool	GetClipActive()
cColor	GetColor()
cVector3f	GetGravityVelocity()
float	GetIterationNum()
int	GetIterationNumInt()
tString	GetName()
cVector3f	GetRotateVelocity()
cVector3f	GetWindVelocity()
void	RemoveClipArea(iEntity3D@ apClipEntity)
void	SetBoxDistance(float afDistance)
void	SetBrightness(float afX)
void	SetClipActive(bool abX)
void	SetColor(const cColor &in aCol)
void	SetFadeInEnd(float afX)
void	SetFadeInStart(float afX)
void	SetFadeOutEnd(float afX)
void	SetFadeOutStart(float afX)
void	SetGravitySpeedRandomAmount(float afX)
void	SetGravityVelocity(const cVector3f &in avVel)
void	SetIterationNum(float afNum)
void	SetRotateSpeedRandomAmount(float afX)
void	SetRotateSpeedRandomBothDirs(bool abX)
void	SetRotateVelocity(const cVector3f &in avVel)
void	SetSpotLight(cLightSpot@ apSpotLight, float afMul)
bool	SetVisible(bool abX)
void	SetWindDirectionRandomAmount(float afX)
void	SetWindSpeedRandomAmount(float afX)
void	SetWindVelocity(const cVector3f &in avVel)

Details

AddClipArea

void AddClipArea(iEntity3D@ apClipEntity,
                 bool abSubtractive)

Parameters

• apClipEntity (iEntity3D@) —
• abSubtractive (bool) —

Returns:

• void

GetBrightness

float GetBrightness()

Returns:

• float—

GetClipActive

bool GetClipActive()

Returns:

• bool—

GetColor

cColor GetColor()

Returns:

• cColor—

GetGravityVelocity

cVector3f GetGravityVelocity()

Returns:

• cVector3f—

GetIterationNum

float GetIterationNum()

Returns:

• float—

GetIterationNumInt

int GetIterationNumInt()

Returns:

• int—

GetName

const tString& GetName()

Returns:

• const tString&—

GetRotateVelocity

cVector3f GetRotateVelocity()

Returns:

• cVector3f—

GetWindVelocity

cVector3f GetWindVelocity()

Returns:

• cVector3f—

RemoveClipArea

void RemoveClipArea(iEntity3D@ apClipEntity)

Parameters

• apClipEntity (iEntity3D@) —

Returns:

• void

SetBoxDistance

void SetBoxDistance(float afDistance)

Parameters

• afDistance (float) —

Returns:

• void

SetBrightness

void SetBrightness(float afX)

Parameters

• afX (float) —

Returns:

• void

SetClipActive

void SetClipActive(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetColor

void SetColor(const cColor &in aCol)

Parameters

• aCol (cColor) —

Returns:

• void

SetFadeInEnd

void SetFadeInEnd(float afX)

Parameters

• afX (float) —

Returns:

• void

SetFadeInStart

void SetFadeInStart(float afX)

Parameters

• afX (float) —

Returns:

• void

SetFadeOutEnd

void SetFadeOutEnd(float afX)

Parameters

• afX (float) —

Returns:

• void

SetFadeOutStart

void SetFadeOutStart(float afX)

Parameters

• afX (float) —

Returns:

• void

SetGravitySpeedRandomAmount

void SetGravitySpeedRandomAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetGravityVelocity

void SetGravityVelocity(const cVector3f &in avVel)

Parameters

• avVel (cVector3f) —

Returns:

• void

SetIterationNum

void SetIterationNum(float afNum)

Parameters

• afNum (float) —

Returns:

• void

SetRotateSpeedRandomAmount

void SetRotateSpeedRandomAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetRotateSpeedRandomBothDirs

void SetRotateSpeedRandomBothDirs(bool abX)

Parameters

• abX (bool) —

Returns:

• void

SetRotateVelocity

void SetRotateVelocity(const cVector3f &in avVel)

Parameters

• avVel (cVector3f) —

Returns:

• void

SetSpotLight

void SetSpotLight(cLightSpot@ apSpotLight,
                  float afMul)

Parameters

• apSpotLight (cLightSpot@) —
• afMul (float) —

Returns:

• void

SetVisible

bool SetVisible(bool abX)

Parameters

• abX (bool) —

Returns:

• bool—

SetWindDirectionRandomAmount

void SetWindDirectionRandomAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetWindSpeedRandomAmount

void SetWindSpeedRandomAmount(float afX)

Parameters

• afX (float) —

Returns:

• void

SetWindVelocity

void SetWindVelocity(const cVector3f &in avVel)

Parameters

• avVel (cVector3f) —

Returns:

• void

References

• HPL3/Amnesia: Rebirth/Scripting/cWorld ‎ (← links)

See all references...