This article's documentation is for anything that uses the Source engine. Click here for more information.

Info particle system: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Added in a description.)
mNo edit summary
 
(46 intermediate revisions by 24 users not shown)
Line 1: Line 1:
{{wrongtitle|title=info_particle_system}}
{{LanguageBar}}
==Entity Description==
{{CD|CParticleSystem|file1=particle_system.cpp}}
A entity that controls a defined particle, and can also be activated to turn on or off.
{{This is a|point entity|name=info_particle_system|since=Source 2007}} It dispatches and offers some control over a specified [[particle system]].
 
==Keyvalues==
==Keyvalues==
*{{kv targetname}}
{{KV Targetname}}
*{{kv parentname}}
{{KV|Particle System Name|intn=effect_name|string|The name of the particle system to spawn. NOT the name of a PCF file!}}
*{{kv angles}}
{{KV|Start Active?|intn=start_active|bool|Whether the particle system should begin as soon as the entity spawns.}}
*'''effect_name'''
{{KV|Control Point 1|to=Control Point 63|intn=cpoint1|intn2=cpoint63|targetname|Parents a [[Control Point (particles)|control point]] to the given entity's origin. If any value is left blank all those following it will be ignored. {{tip|Control point 0 is the origin of the <code>info_particle_system</code> itself.}} {{note|Because the control point is configured on the client, the entity you specify must exist there. This means that most invisible entities (info_target is an exception, as it has the "Transmit to client" spawnflag) ''will not work''. Your best bet is an info_particle_system, e.g. itself or another one with blank particle name.}}
:<string> Particle System Name
{{KV|Control Point 1's Parent|to=Control Point 7's Parent|intn=cpoint1_parent|intn2=cpoint7_parent|int|The control point to act as a [[parent]] to this one.}}}}
*'''start_active'''
{{KV|Flag as Weather?|intn=flag_as_weather|bool|Is this particle system going to be used as a weather effect? If so the particle system will not be rendered if the user has disabled weather effects.|not={{l4ds}}{{asw}}{{portal2}}{{csgo}}}}
:{{boolean}} If set, particle effect starts enabled.
<br>{{KV|snapshot_file|intn=snapshot_file|string|{{note|Only CSGO ? Loads file {{font color|white|"particles/%s.psf"}}<br>{{font color|#D4FF00|// Init from a DMX (.psf) file}}<br>CParticleSnapshot::Unserialize}}{{todo|More info}}|only={{CSGO}}}}
*'''cpoint''1-63'''''
{{KV|<s>Render in front?</s>|intn=render_in_front|bool|<s>Hack to allow particles to render in front of everything else.</s> Doesn't exist, left over in fgd|only={{l4d2}}}}
:<target_destination> If set, control point <code>n</code> of the effect will be at this entity's location.
*'''cpoint''1-7''_parent'''
:<target_destination> If set and nonzero, control point <code>n</code> of the effect will use this point for its parent.
==Inputs==
*{{i targetname}}
*{{i parentname}}
*'''Start'''
:Tell the particle system to start emitting.
*'''Stop'''
:Tell the particle system to stop emitting.
==Outputs==
*{{o targetname}}
[[Category:Half-Life 2: Episode Two Entities]]


==See Also==
== Inputs ==
{{I|Start|Tell the particle system to start emitting. {{note|To forcibly restart an effect, you must fire <code>Stop</code> first. <code>Start</code> has no effect if the server thinks the system is already running.}}}}
{{I|Stop|Tell the particle system to stop emitting.}}
{{I|DestroyImmediately|Particle system disappears immediately instead of fading out.|since=p2|also={{bms}}{{mapbase}}}}
{{I|Reset|Tell the particle system to restart.|only={{bms}}|nofgd=1}}
{{I|StopPlayEndCap|Tells the particle system to stop emitting but also play its [https://developer.valvesoftware.com/wiki/Particle_System_Operators/Generic_Operator_Options  End Cap State]|since={{portal2}}}}
{{note|This can be useful to fade out particles with long lifetimes, that otherwise wouldn't go away with the normal Stop.}}


*[[Half-Life 2: Episode Two Particle Effect List]]
== See also ==
*[[Portal Particle Effect List]]
* {{ent|info_particle_target}}
*[[List of TF2 Particles]]
* [[:Category:Particle Effects]]
* [[:Category:Particle System]].


[[Category:Particle_Effects]]
[[Category:Particle System]]

Latest revision as of 08:37, 10 April 2025

English (en)Translate (Translate)
C++ Class hierarchy
CParticleSystem
↳CBaseEntity
C++ particle_system.cpp

info_particle_system is a point entity available in all Source Source games since Source 2007 Source 2007. It dispatches and offers some control over a specified particle system.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Particle System Name (effect_name) <string>
The name of the particle system to spawn. NOT the name of a PCF file!
Start Active? (start_active) <boolean>
Whether the particle system should begin as soon as the entity spawns.
Control Point 1 (cpoint1) to Control Point 63 (cpoint63) <targetname>
Parents a control point to the given entity's origin. If any value is left blank all those following it will be ignored.
Tip.pngTip:Control point 0 is the origin of the info_particle_system itself.
Note.pngNote:Because the control point is configured on the client, the entity you specify must exist there. This means that most invisible entities (info_target is an exception, as it has the "Transmit to client" spawnflag) will not work. Your best bet is an info_particle_system, e.g. itself or another one with blank particle name.
Control Point 1's Parent (cpoint1_parent) to Control Point 7's Parent (cpoint7_parent) <integer>
The control point to act as a parent to this one.
Flag as Weather? (flag_as_weather) <boolean> (not in Left 4 Dead seriesLeft 4 Dead seriesAlien SwarmPortal 2Counter-Strike: Global Offensive)
Is this particle system going to be used as a weather effect? If so the particle system will not be rendered if the user has disabled weather effects.


snapshot_file (snapshot_file) <string> (only in Counter-Strike: Global Offensive)
Note.pngNote:Only CSGO ? Loads file "particles/%s.psf"
// Init from a DMX (.psf) file
CParticleSnapshot::Unserialize
Todo: More info
Render in front? (render_in_front) <boolean> (only in Left 4 Dead 2)
Hack to allow particles to render in front of everything else. Doesn't exist, left over in fgd

Inputs

Start
Tell the particle system to start emitting.
Note.pngNote:To forcibly restart an effect, you must fire Stop first. Start has no effect if the server thinks the system is already running.
Stop
Tell the particle system to stop emitting.
DestroyImmediately  (in all games since Portal 2) (also in Black MesaMapbase)
Particle system disappears immediately instead of fading out.
Reset  (only in Black Mesa) !FGD
Tell the particle system to restart.
StopPlayEndCap  (in all games since Portal 2)
Tells the particle system to stop emitting but also play its End Cap State
Note.pngNote:This can be useful to fade out particles with long lifetimes, that otherwise wouldn't go away with the normal Stop.

See also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Info_particle_system&oldid=470399"