Add func_sparks to entities.ent

[xonotic/xonotic-maps.pk3dir.git] / scripts / entities.ent

diff --git a/scripts/entities.ent b/scripts/entities.ent
index fc1dcbf611f10e78e7e40f2c021ec01a881df9d9..70010d8ed1f2cecb2c4107469ddc9c0da538e561 100644 (file)
--- a/scripts/entities.ent
+++ b/scripts/entities.ent
@@ -1574,7 +1574,7 @@ A brush that emits particles. Can be (de)activated with relays.
 <real key="bgmscriptrelease" name="bgmscriptrelease">release time of the effect strength (0 to 3.9)</real>
 -------- SPAWNFLAGS --------
 <flag key="START_ON" name="START_ON" bit="0">when targeted, the particle emitter will start switched on</flag>
-<flag key="IMPULSE" name="IMPULSE" bit="1">only send the full amount of impulse particles when the entity is triggered</flag>
+<flag key="IMPULSE" name="IMPULSE" bit="1">only send the full amount of impulse particles when the entity is toggled on/off</flag>
 <flag key="VISCULLING" name="VISCULLING" bit="2">only emit particles if the emitter brush is in the current PVS</flag>
 -------- NOTES --------
 Use trigger_monoflop and relay_activatetoggle if you want the particles to turn off for a while, then turn back on.
@@ -1586,6 +1586,30 @@ e.g.
 The lines MUST be sorted by emitter class as primary key, and by the time since start of the BGM as secondary key.
 </group>
 
+<group name="func_sparks" color=".5 .5 .5">
+A brush that emits sparks. Can be (de)activated with relays.
+-------- KEYS --------
+<real key="waterlevel" name="waterlevel">extra velocity jitter amount</real>
+<real key="impulse" name="impulse">number of particles to emit per second (min 0.5, default 2.5)</real>
+<real key="count" name="count">particle count multiplier (per spawned particle)</real>
+<real3 key="movedir" name="movedir">when set, trace direction (particles will then be emitted from the surface the trace hits); the length of the vector is used as strength of taking the normal of the trace into account</real3>
+<sound key="noise" name="noise">sound to play when the particle is emitted</sound>
+<real key="atten" name="atten">distance attenuation of the sound (a value from 0.1 to 3.9), default is 0.5; set to -1 for no attenuation (global sound)</real>
+<real key="volume" name="volume">volume of the sound</real>
+<targetname key="targetname" name="targetname">name to target this (use relays)</targetname>
+<string key="bgmscript" name="bgmscript">emitter class from the BGM script</string>
+<real key="bgmscriptattack" name="bgmscriptattack">attack time of the effect strength (0 to 3.9)</real>
+<real key="bgmscriptdecay" name="bgmscriptdecay">decay time of the effect strength (0 to 3.9)</real>
+<real key="bgmscriptsustain" name="bgmscriptsustain">sustain level of the effect strength (0.1 to 1, set to -1 to disable sustain)</real>
+<real key="bgmscriptrelease" name="bgmscriptrelease">release time of the effect strength (0 to 3.9)</real>
+-------- SPAWNFLAGS --------
+<flag key="START_ON" name="START_ON" bit="0">when targeted, the particle emitter will start switched on</flag>
+<flag key="IMPULSE" name="IMPULSE" bit="1">only send the full amount of impulse particles when the entity is toggled on/off</flag>
+<flag key="VISCULLING" name="VISCULLING" bit="2">only emit particles if the emitter brush is in the current PVS</flag>
+-------- NOTES --------
+Specialised version of func_pointparticles
+</group>
+
 <point name="trigger_flipflop" color=".5 .5 .5" box="-8 -8 -8 8 8 8">
 &quot;Flip-flop&quot; trigger gate... let's only every second trigger event through
 -------- KEYS --------