https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FAmnesia%3A_Rebirth%2FScripting%2FcEnvironmentParticles
HPL3/Amnesia: Rebirth/Scripting/cEnvironmentParticles - Revision history
2026-06-20T00:05:05Z
Revision history for this page on the wiki
MediaWiki 1.34.2
https://wiki.frictionalgames.com/page?title=HPL3/Amnesia:_Rebirth/Scripting/cEnvironmentParticles&diff=5681&oldid=prev
Abion47: Created page with "{{ScriptingStub}} 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..."
2020-11-15T21:06:34Z
<p>Created page with "{{ScriptingStub}} 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..."</p>
<p><b>New page</b></p><div>{{ScriptingStub}}<br />
<br />
Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!<br />
<br />
==Fields==<br />
cEnvironmentParticles has no public fields.<br />
<br />
==Functions==<br />
{{CodeDocSummaryTop|Return Type|Function And Description}}<br />
{{CodeDocSummaryItem|void|[[#AddClipArea|AddClipArea]]([[../iEntity3D|iEntity3D@]] apClipEntity, bool abSubtractive)|}}<br />
{{CodeDocSummaryItem|float|[[#GetBrightness|GetBrightness]]()|}}<br />
{{CodeDocSummaryItem|bool|[[#GetClipActive|GetClipActive]]()|}}<br />
{{CodeDocSummaryItem|[[../cColor|cColor]]|[[#GetColor|GetColor]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetGravityVelocity|GetGravityVelocity]]()|}}<br />
{{CodeDocSummaryItem|float|[[#GetIterationNum|GetIterationNum]]()|}}<br />
{{CodeDocSummaryItem|int|[[#GetIterationNumInt|GetIterationNumInt]]()|}}<br />
{{CodeDocSummaryItem|[[../tString|tString]]|[[#GetName|GetName]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetRotateVelocity|GetRotateVelocity]]()|}}<br />
{{CodeDocSummaryItem|[[../cVector3f|cVector3f]]|[[#GetWindVelocity|GetWindVelocity]]()|}}<br />
{{CodeDocSummaryItem|void|[[#RemoveClipArea|RemoveClipArea]]([[../iEntity3D|iEntity3D@]] apClipEntity)|}}<br />
{{CodeDocSummaryItem|void|[[#SetBoxDistance|SetBoxDistance]](float afDistance)|}}<br />
{{CodeDocSummaryItem|void|[[#SetBrightness|SetBrightness]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetClipActive|SetClipActive]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetColor|SetColor]](const [[../cColor|cColor]] &in aCol)|}}<br />
{{CodeDocSummaryItem|void|[[#SetFadeInEnd|SetFadeInEnd]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetFadeInStart|SetFadeInStart]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetFadeOutEnd|SetFadeOutEnd]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetFadeOutStart|SetFadeOutStart]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetGravitySpeedRandomAmount|SetGravitySpeedRandomAmount]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetGravityVelocity|SetGravityVelocity]](const [[../cVector3f|cVector3f]] &in avVel)|}}<br />
{{CodeDocSummaryItem|void|[[#SetIterationNum|SetIterationNum]](float afNum)|}}<br />
{{CodeDocSummaryItem|void|[[#SetRotateSpeedRandomAmount|SetRotateSpeedRandomAmount]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetRotateSpeedRandomBothDirs|SetRotateSpeedRandomBothDirs]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetRotateVelocity|SetRotateVelocity]](const [[../cVector3f|cVector3f]] &in avVel)|}}<br />
{{CodeDocSummaryItem|void|[[#SetSpotLight|SetSpotLight]]([[../cLightSpot|cLightSpot@]] apSpotLight, float afMul)|}}<br />
{{CodeDocSummaryItem|bool|[[#SetVisible|SetVisible]](bool abX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetWindDirectionRandomAmount|SetWindDirectionRandomAmount]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetWindSpeedRandomAmount|SetWindSpeedRandomAmount]](float afX)|}}<br />
{{CodeDocSummaryItem|void|[[#SetWindVelocity|SetWindVelocity]](const [[../cVector3f|cVector3f]] &in avVel)|}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Details==<br />
{{CodeDocDetailTop|AddClipArea}}<br />
<syntaxhighlight lang="c++">void AddClipArea(iEntity3D@ apClipEntity,<br />
bool abSubtractive)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apClipEntity|[[../iEntity3D|iEntity3D@]]|}}<br />
{{CodeDocDetailParam|abSubtractive|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetBrightness}}<br />
<syntaxhighlight lang="c++">float GetBrightness()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetClipActive}}<br />
<syntaxhighlight lang="c++">bool GetClipActive()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetColor}}<br />
<syntaxhighlight lang="c++">cColor GetColor()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cColor|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetGravityVelocity}}<br />
<syntaxhighlight lang="c++">cVector3f GetGravityVelocity()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cVector3f|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetIterationNum}}<br />
<syntaxhighlight lang="c++">float GetIterationNum()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|float|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetIterationNumInt}}<br />
<syntaxhighlight lang="c++">int GetIterationNumInt()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|int|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetName}}<br />
<syntaxhighlight lang="c++">const tString& GetName()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|const tString&|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetRotateVelocity}}<br />
<syntaxhighlight lang="c++">cVector3f GetRotateVelocity()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cVector3f|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|GetWindVelocity}}<br />
<syntaxhighlight lang="c++">cVector3f GetWindVelocity()</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailReturn|cVector3f|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|RemoveClipArea}}<br />
<syntaxhighlight lang="c++">void RemoveClipArea(iEntity3D@ apClipEntity)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apClipEntity|[[../iEntity3D|iEntity3D@]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetBoxDistance}}<br />
<syntaxhighlight lang="c++">void SetBoxDistance(float afDistance)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afDistance|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetBrightness}}<br />
<syntaxhighlight lang="c++">void SetBrightness(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetClipActive}}<br />
<syntaxhighlight lang="c++">void SetClipActive(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetColor}}<br />
<syntaxhighlight lang="c++">void SetColor(const cColor &in aCol)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|aCol|[[../cColor|cColor]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetFadeInEnd}}<br />
<syntaxhighlight lang="c++">void SetFadeInEnd(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetFadeInStart}}<br />
<syntaxhighlight lang="c++">void SetFadeInStart(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetFadeOutEnd}}<br />
<syntaxhighlight lang="c++">void SetFadeOutEnd(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetFadeOutStart}}<br />
<syntaxhighlight lang="c++">void SetFadeOutStart(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetGravitySpeedRandomAmount}}<br />
<syntaxhighlight lang="c++">void SetGravitySpeedRandomAmount(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetGravityVelocity}}<br />
<syntaxhighlight lang="c++">void SetGravityVelocity(const cVector3f &in avVel)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avVel|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetIterationNum}}<br />
<syntaxhighlight lang="c++">void SetIterationNum(float afNum)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afNum|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetRotateSpeedRandomAmount}}<br />
<syntaxhighlight lang="c++">void SetRotateSpeedRandomAmount(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetRotateSpeedRandomBothDirs}}<br />
<syntaxhighlight lang="c++">void SetRotateSpeedRandomBothDirs(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetRotateVelocity}}<br />
<syntaxhighlight lang="c++">void SetRotateVelocity(const cVector3f &in avVel)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avVel|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetSpotLight}}<br />
<syntaxhighlight lang="c++">void SetSpotLight(cLightSpot@ apSpotLight,<br />
float afMul)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|apSpotLight|[[../cLightSpot|cLightSpot@]]|}}<br />
{{CodeDocDetailParam|afMul|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetVisible}}<br />
<syntaxhighlight lang="c++">bool SetVisible(bool abX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|abX|bool|}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetWindDirectionRandomAmount}}<br />
<syntaxhighlight lang="c++">void SetWindDirectionRandomAmount(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetWindSpeedRandomAmount}}<br />
<syntaxhighlight lang="c++">void SetWindSpeedRandomAmount(float afX)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|afX|float|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|SetWindVelocity}}<br />
<syntaxhighlight lang="c++">void SetWindVelocity(const cVector3f &in avVel)</syntaxhighlight><br />
{{CodeDocDetailBody|}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|avVel|[[../cVector3f|cVector3f]]|}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{ReferencesSection}}<br />
<br />
{{HPL3SOMAScriptingCategories}}</div>
Abion47