https://wiki.frictionalgames.com/page?action=history&feed=atom&title=HPL3%2FSOMA%2FScripting%2FScripting_Api%2FParticleSystemHPL3/SOMA/Scripting/Scripting Api/ParticleSystem - Revision history2026-05-02T13:57:02ZRevision history for this page on the wikiMediaWiki 1.34.2https://wiki.frictionalgames.com/page?title=HPL3/SOMA/Scripting/Scripting_Api/ParticleSystem&diff=5045&oldid=prevAbion47: Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte..."2020-08-24T20:57:46Z<p>Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte..."</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 />
==Summary==<br />
{{CodeDocSummaryTop}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_AttachToEntity|ParticleSystem_AttachToEntity]](const [[../../tString|tString]] &in asPSName, const [[../../tString|tString]] &in asEntityName)|Attaches a particle system to an entity}}<br />
{{CodeDocSummaryItem|[[../../cParticleSystem|cParticleSystem]]|[[#ParticleSystem_CreateAtEntity|ParticleSystem_CreateAtEntity]](const [[../../tString|tString]] &in asPSName, const [[../../tString|tString]] &in asPSFile, const [[../../tString|tString]] &in asEntity, bool abAttach)|Creates a particle system at entity}}<br />
{{CodeDocSummaryItem|[[../../cParticleSystem|cParticleSystem]]|[[#ParticleSystem_CreateAtEntityExt|ParticleSystem_CreateAtEntityExt]](const [[../../tString|tString]] &in asPSName, const [[../../tString|tString]] &in asPSFile, const [[../../tString|tString]] &in asEntity, bool abAttach, const [[../../cColor|cColor]] &in acColor, float afBrightness <nowiki>=</nowiki> 1.0f, bool abFadeAtDistance <nowiki>=</nowiki> false, float afFadeMinEnd <nowiki>=</nowiki> 1.0f, float afFadeMinStart <nowiki>=</nowiki> 2.0f, float afFadeMaxStart <nowiki>=</nowiki> 100.0f, float afFadeMaxEnd <nowiki>=</nowiki> 110.0f)|Creates a particle system at entity with extra options}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_Destroy|ParticleSystem_Destroy]](const [[../../tString|tString]] &in asPSName)|Destroy a particle system}}<br />
{{CodeDocSummaryItem|bool|[[#ParticleSystem_Exists|ParticleSystem_Exists]](const [[../../tString|tString]] &in asPSName)|Returns true or false if a given particle system exists}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_Preload|ParticleSystem_Preload]](const [[../../tString|tString]] &in asFile)|Preload particle system data}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_SetActive|ParticleSystem_SetActive]](const [[../../tString|tString]] &in asPSName, bool abActive)|Activates or deactivates a particle system}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_SetBrightness|ParticleSystem_SetBrightness]](const [[../../tString|tString]] &in asPSName, float afBrightness)|Sets the brightness of a particle system}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_SetColor|ParticleSystem_SetColor]](const [[../../tString|tString]] &in asPSName, const [[../../cColor|cColor]] &in acColor)|Sets the color of a particle system}}<br />
{{CodeDocSummaryItem|void|[[#ParticleSystem_SetVisible|ParticleSystem_SetVisible]](const [[../../tString|tString]] &in asPSName, bool abVisible)|Sets the visibility of a particle system}}<br />
{{CodeDocSummaryBottom}}<br />
<br />
==Function Detail==<br />
{{CodeDocDetailTop|ParticleSystem_AttachToEntity}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_AttachToEntity(const tString &in asPSName,<br />
const tString &in asEntityName)</syntaxhighlight><br />
{{CodeDocDetailBody|Attaches a particle system to an entity.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system, can contain wildcards(*).}}<br />
{{CodeDocDetailParam|asEntityName|[[../../tString|tString]]|name of the entity to attach the particle system to.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_CreateAtEntity}}<br />
<syntaxhighlight lang="c++">cParticleSystem@ ParticleSystem_CreateAtEntity(const tString &in asPSName,<br />
const tString &in asPSFile,<br />
const tString &in asEntity,<br />
bool abAttach)</syntaxhighlight><br />
{{CodeDocDetailBody|Creates a particle system at entity.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system entity to be created.}}<br />
{{CodeDocDetailParam|asPSFile|[[../../tString|tString]]|.ps file to create particle system from.}}<br />
{{CodeDocDetailParam|asEntity|[[../../tString|tString]]|entity to create particle system at. Can be "player".}}<br />
{{CodeDocDetailParam|abAttach|bool|whether the particle system should be attached to the entity it is created at.}}<br />
{{CodeDocDetailReturn|cParticleSystem@|cParticleSystem, the created particle system or null if the function fails.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_CreateAtEntityExt}}<br />
<syntaxhighlight lang="c++">cParticleSystem@ ParticleSystem_CreateAtEntityExt(const tString &in asPSName,<br />
const tString &in asPSFile,<br />
const tString &in asEntity,<br />
bool abAttach,<br />
const cColor &in acColor,<br />
float afBrightness = 1.0f,<br />
bool abFadeAtDistance = false,<br />
float afFadeMinEnd = 1.0f,<br />
float afFadeMinStart = 2.0f,<br />
float afFadeMaxStart = 100.0f,<br />
float afFadeMaxEnd = 110.0f)</syntaxhighlight><br />
{{CodeDocDetailBody|Creates a particle system at entity with extra options.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system entity to be created.}}<br />
{{CodeDocDetailParam|asPSFile|[[../../tString|tString]]|.ps file to create particle system from.}}<br />
{{CodeDocDetailParam|asEntity|[[../../tString|tString]]|entity to create particle system at. Can be "player".}}<br />
{{CodeDocDetailParam|abAttach|bool|whether the particle system should be attached to the entity it is created at.}}<br />
{{CodeDocDetailParam|acColor|[[../../cColor|cColor]]|color of the particle system.}}<br />
{{CodeDocDetailParam|afBrightness|float|brightness of the particle system.}}<br />
{{CodeDocDetailParam|abFadeAtDistance|bool|if the particles should fade depending on distance from the player.}}<br />
{{CodeDocDetailParam|afFadeMinEnd|float|when the player is closer than this, the particles are invisible.}}<br />
{{CodeDocDetailParam|afFadeMinStart|float|distance to the player where the particles will start fading if the player gets closer.}}<br />
{{CodeDocDetailParam|afFadeMaxStart|float|distance to the player where the particles will start fading if the player gets further away.}}<br />
{{CodeDocDetailParam|afFadeMaxEnd|float|when the player is further away than this, the particles are invisible.}}<br />
{{CodeDocDetailReturn|cParticleSystem@|the created particle system or null if the function fails.}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_Destroy}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_Destroy(const tString &in asPSName)</syntaxhighlight><br />
{{CodeDocDetailBody|Destroy a particle system. Can contain wildcards.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system entity to be destroyed.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_Exists}}<br />
<syntaxhighlight lang="c++">bool ParticleSystem_Exists(const tString &in asPSName)</syntaxhighlight><br />
{{CodeDocDetailBody|Returns true or false if a given particle system exists}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system. Can contain wildcards.}}<br />
{{CodeDocDetailReturn|bool|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_Preload}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_Preload(const tString &in asFile)</syntaxhighlight><br />
{{CodeDocDetailBody|Preload particle system data}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asFile|[[../../tString|tString]]|file to preload}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_SetActive}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_SetActive(const tString &in asPSName,<br />
bool abActive)</syntaxhighlight><br />
{{CodeDocDetailBody|Activates or deactivates a particle system.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system. Can contain wildcards.}}<br />
{{CodeDocDetailParam|abActive|bool|if is should be set to active.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_SetBrightness}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_SetBrightness(const tString &in asPSName,<br />
float afBrightness)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the brightness of a particle system.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system. Can contain wildcards.}}<br />
{{CodeDocDetailParam|afBrightness|float|the color to set}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_SetColor}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_SetColor(const tString &in asPSName,<br />
const cColor &in acColor)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the color of a particle system.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system. Can contain wildcards.}}<br />
{{CodeDocDetailParam|acColor|[[../../cColor|cColor]]|the color to set}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}<br />
<br />
{{CodeDocDetailTop|ParticleSystem_SetVisible}}<br />
<syntaxhighlight lang="c++">void ParticleSystem_SetVisible(const tString &in asPSName,<br />
bool abVisible)</syntaxhighlight><br />
{{CodeDocDetailBody|Sets the visibility of a particle system.}}<br />
{{CodeDocDetailParamStart}}<br />
{{CodeDocDetailParam|asPSName|[[../../tString|tString]]|name of the particle system. Can contain wildcards.}}<br />
{{CodeDocDetailParam|abVisible|bool|if is should be set to visible or not.}}<br />
{{CodeDocDetailReturn|void|}}<br />
{{CodeDocDetailBottom}}</div>Abion47