]> git.xonotic.org Git - xonotic/xonotic-maps.pk3dir.git/blobdiff - scripts/entities.ent
Remove legacy item_key1 and item_key2, use item_key instead
[xonotic/xonotic-maps.pk3dir.git] / scripts / entities.ent
index d6d6a6f27fadeeb5890ec4fd07b83bf1bda61a1e..66a0f3b9e1b918f9396ba09adc68f28e318d57e1 100644 (file)
@@ -135,7 +135,7 @@ When a button is touched by a player, it moves in the direction set by the &quot
 </group>
 
 <group name="func_conveyor" color="0 .5 .8">
-A conveyor. Solid brush version. Will run forever if it's not targeted.
+A conveyor. Solid brush version. Will run forever if it's not targeted. Use relay_activate, relay_deactivate or relay_activatetoggle to activate/deactivate it.
 -------- KEYS --------
 <targetname key="targetname" name="targetname">if set, it can be turned on/off</targetname>
 <direction key="angle" name="angle">determines the opening direction</direction>
@@ -145,7 +145,7 @@ A conveyor. Solid brush version. Will run forever if it's not targeted.
 </group>
 
 <group name="trigger_conveyor" color="0 .5 .8">
-A conveyor. Nonsolid trigger version.
+A conveyor. Nonsolid trigger version. Use relay_activate, relay_deactivate or relay_activatetoggle to activate/deactivate it.
 -------- KEYS --------
 <targetname key="targetname" name="targetname">if set, it can be turned on/off</targetname>
 <direction key="angle" name="angle">determines the opening direction</direction>
@@ -276,9 +276,9 @@ Rising platform the player can ride to reach higher places. Plats must always be
 <real key="height" name="height">if set, this will determine the total amount of vertical travel of the plat.</real>
 <real key="dmg" name="dmg">damage to inflict on player when he blocks operation of plat. Plat will reverse direction when blocked.</real>
 <targetname key="targetname" name="targetname">if set, the trigger that points to this will lower the plat each time it fires. The plat lowers and lifts someone up later.</targetname>
-<real key="sounds" name="sounds">2 for alternate sound set, -1 for silence, or use the fields below</real>
-<string key="sound1" name="sound1">platform starts moving sound</string>
-<string key="sound2" name="sound2">platform stop sound</string>
+<real key="sounds" name="sounds">2 for alternate sound set, 0 for silence, or use the fields below</real>
+<string key="noise" name="noise">platform starts moving sound</string>
+<string key="noise1" name="noise1">platform stop sound</string>
 <string key="message" name="message">kill message, when someone gets killed by this plat</string>
 <string key="message2" name="message2">death message when someone gets pushed into this (default: &quot;was thrown into a world of hurt by&quot;). The # character is replaced by the attacker name if present (and it instead does not get appended to the end)</string>
 -------- SPAWNFLAGS --------
@@ -292,7 +292,7 @@ This is an invisible area like a trigger, which rain falls inside of.
 -------- KEYS --------
 <real3 key="velocity" name="velocity">falling direction (should be something like '0 0 -700', use the X and Y velocity for wind)</real3>
 <real key="cnt" name="cnt">sets color of rain in the Quake palette (default 12 - white)</real>
-<real key="count" name="count">adjusts density, this many particles fall every second for a 1024x1024 area, default is 2000</real>
+<real key="count" name="count">adjusts density, this many particles fall every second for a 1024x1024 area (on average), default is 2000</real>
 </group>
 
 <group name="func_rotating" color="0 .5 .8">
@@ -315,7 +315,7 @@ This is an invisible area like a trigger, which snow falls inside of.
 -------- KEYS --------
 <real3 key="velocity" name="velocity">falling direction (should be something like '0 0 -300', use the X and Y velocity for wind)</real3>
 <real key="cnt" name="cnt">sets color of snow in the Quake palette (default 12 - white)</real>
-<real key="count" name="count">adjusts density, this many particles fall every second for a 1024x1024 area, default is 2000</real>
+<real key="count" name="count">adjusts density, this many particles fall every second for a 1024x1024 area (on average), default is 2000</real>
 </group>
 
 <point name="func_stardust" color=".5 .5 .5" box="-8 -8 -8 8 8 8">
@@ -325,10 +325,9 @@ Point entity with EF_STARDUST applied. This will spawn a particle cloud with mos
 <group name="func_train" color="0 .5 .8">
 Trains are moving solids that follow a cycle of path_corner entities. Origin brushes are NOT supported; they use the &quot;mins&quot; corner as reference (that is, lowest x, y, and z coordinates).
 At each node, the train's mins corner hits exactly the path_corner.
-Trains always start on in the game.
+Trains always start on mapstart unless NEEDACTIVATION is set.
 Trains do not damage the player when blocked.
 Trains cannot emit sound.
-Trains are not trigger-able or toggle-able.
 Trains cannot be block-stopped just by getting in their way, the player must be wedged between the train and another obstacle to block it.
 -------- KEYS --------
 <real key="speed" name="speed">default/initial speed of train (default 100 or overridden by speed value of targeted path_corner)</real>
@@ -339,6 +338,10 @@ Trains cannot be block-stopped just by getting in their way, the player must be
 <real key="dmgtime" name="dmgtime">interval to apply dmg to a player who is in the way</real>
 <string key="message" name="message">death message when a player gets crushed</string>
 <string key="message2" name="message2">death message when someone gets pushed into this (default: &quot;was thrown into a world of hurt by&quot;). The # character is replaced by the attacker name if present (and it instead does not get appended to the end)</string>
+-------- SPAWNFLAGS --------
+<flag key="CURVE" name="CURVE" bit="0">don't use the direct path to the next target, instead create a curved path using the current path_corner's curvetarget</flag>
+<flag key="TURN" name="TURN" bit="1">turn the train when it reaches a path_corner</flag>
+<flag key="NEEDACTIVATION" name="NEEDACTIVATION" bit="2">train needs to be triggered to start</flag>
 </group>
 
 <point name="info_autoscreenshot" color="0 0 0.2" box="-8 -8 -8 8 8 8">
@@ -694,32 +697,6 @@ This is the only correct way to put keys on the map!
 itemkeys MUST always have exactly one bit set.
 </point>
 
-<point name="item_key1" color="0 .5 .8" box="-16 -16 -24 16 16 32">
-SILVER key.
------------KEYS------------
-<color key="colormod" name="colormod">color of the key (default: '.9 .9 .9').</color>
-<string key="message" name="message">message to print when player picks up this key.</string>
-<model key="model" name="model">custom model to use.</model>
-<sound key="noise" name="noise">custom sound to play when player picks up the key.</sound>
--------- SPAWNFLAGS --------
-<flag key="FLOATING" name="FLOATING" bit="0">the item will float in air, instead of aligning to the floor by falling</flag>
----------NOTES----------
-Don't use this entity on new maps! Use item_key instead.
-</point>
-
-<point name="item_key2" color="0 .5 .8" box="-16 -16 -24 16 16 32">
-GOLD key.
------------KEYS------------
-<color key="colormod" name="colormod">color of the key (default: '1 .9 0').</color>
-<string key="message" name="message">message to print when player picks up this key.</string>
-<model key="model" name="model">custom model to use.</model>
-<sound key="noise" name="noise">custom sound to play when player picks up the key.</sound>
--------- SPAWNFLAGS --------
-<flag key="FLOATING" name="FLOATING" bit="0">the item will float in air, instead of aligning to the floor by falling</flag>
----------NOTES----------
-Don't use this entity on new maps! Use item_key instead.
-</point>
-
 <point name="item_minst_cells" color=".3 .3 1" box="-30 -30 0 30 30 32">
 Instagib ammo.
 Always contains 5 (g_instagib_ammo_drop) shots.
@@ -1098,10 +1075,12 @@ All path_corner entities of a train have to connect in a circular manner, while
 <target key="target2" name="target2">triggered when a func_train stops at this target</target>
 <target key="target3" name="target3">triggered when a func_train stops at this target</target>
 <target key="target4" name="target4">triggered when a func_train stops at this target</target>
-<boolean key="target_random" name="target_random">instead of triggering ALL matched entities, trigger ONE of them by random</boolean>
+<boolean key="target_random" name="target_random">choose a random next corner from the list of all path_corners with targetname specified in &quot;target&quot;</boolean>
 <targetname key="targetname" name="targetname">the train following the path or the previous path_corner in the path points to this.</targetname>
 <real key="speed" name="speed">speed of func_train while moving to this path corner. If unset, the value from the func_train will be used.</real>
 <real key="wait" name="wait">number of seconds func_train will pause on this path corner before moving to next path corner (default: 0.1; to not wait, set this to -1</real>
+-------- SPAWNFLAGS --------
+<flag key="NEEDACTIVATION" name="NEEDACTIVATION" bit="2">train needs to be triggered to move to this corner</flag>
 </point>
 
 <point name="target_assault_roundend" color="1 0 0" box="-8 -8 -8 8 8 8">
@@ -1555,7 +1534,7 @@ NOTE for race_place: when the race starts after the qualifying, the player with
 </point>
 
 <group name="func_pointparticles" color=".5 .5 .5">
-A brush that emits particles.
+A brush that emits particles. Can be (de)activated with relays.
 -------- KEYS --------
 <string key="mdl" name="mdl">particle effect name from effectinfo.txt</string>
 <real key="impulse" name="impulse">when positive, number of particles to emit per second; when negative; number of particles to emit per second and 64^3 block</real>
@@ -1566,7 +1545,7 @@ A brush that emits particles.
 <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 (then its state is toggled)</targetname>
+<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>
@@ -1574,10 +1553,10 @@ A brush that emits particles.
 <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 if you want the particles to turn off for a while, then turn back on.
+Use trigger_monoflop and relay_activatetoggle if you want the particles to turn off for a while, then turn back on.
 A BGM script is a .bgs file named like the map, in the maps directory. Its format is lines of the form
   &lt;emitter class&gt; &lt;time since start of background music&gt; &lt;0 if the emitters are to be switched off, &gt;0 and &lt;=1 if they are to be switched on&gt;
 e.g.
@@ -1586,6 +1565,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 --------
@@ -2343,6 +2346,7 @@ This acts as a modifier over the normal gravity (sv_gravity). e.g.: 0.5 is half
 <point name="relay_activate" color="0 1 0" box="-8 -8 -8 8 8 8">
 Activates all targets
 List of currently supported target ents:
+trigger_conveyor
 trigger_hurt
 trigger_heal
 trigger_impulse
@@ -2351,7 +2355,9 @@ trigger_teleport
 func_rotating
 func_bobbing
 func_button
+func_conveyor
 func_fourier
+func_pointparticles
 func_vectormamamam
 -------- KEYS --------
 <target key="target" name="target">trigger all entities with this targetname when triggered</target>
@@ -2361,6 +2367,7 @@ func_vectormamamam
 <point name="relay_deactivate" color="1 0 0" box="-8 -8 -8 8 8 8">
 Deactivates all targets
 List of currently supported target ents:
+trigger_conveyor
 trigger_hurt
 trigger_heal
 trigger_impulse
@@ -2369,7 +2376,9 @@ trigger_teleport
 func_rotating
 func_bobbing
 func_button
+func_conveyor
 func_fourier
+func_pointparticles
 func_vectormamamam
 -------- KEYS --------
 <target key="target" name="target">trigger all entities with this targetname when triggered</target>
@@ -2379,6 +2388,7 @@ func_vectormamamam
 <point name="relay_activatetoggle" color="0 1 1" box="-8 -8 -8 8 8 8">
 Toggles all targets de/active
 List of currently supported target ents:
+trigger_conveyor
 trigger_hurt
 trigger_heal
 trigger_impulse
@@ -2387,7 +2397,9 @@ trigger_teleport
 func_rotating
 func_bobbing
 func_button
+func_conveyor
 func_fourier
+func_pointparticles
 func_vectormamamam
 -------- KEYS --------
 <target key="target" name="target">trigger all entities with this targetname when triggered</target>