<real key="wait" name="wait">number of seconds button stays pressed (default 1, -1 = return immediately).</real>
<real key="lip" name="lip">lip remaining at end of move (default 4 units).</real>
<real key="health" name="health">(default 0) if set to any non-zero value, the button must take damage (any amount) to activate.</real>
+<sound key="noise" name="noise">Noise that is played when the button is activated</sound>
-------- SPAWNFLAGS --------
<flag key="NOSPLASH" name="NOSPLASH" bit="8">if set, splash damage cannot activate the door, only direct damage can (requires health to be set)</flag>
<flag key="DONTACCUMULATEDMG" name="DONTACCUMULATEDMG" bit="7">if set, all the damage needs to be done in one hit (requires health to be set)</flag>
</group>
<group name="func_conveyor" color="0 .5 .8">
-A conveyor. Solid brush version.
+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>
</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>
<real key="speed" name="speed">movement speed (200 default)</real>
-------- SPAWNFLAGS --------
<flag key="START_ON" name="START_ON" bit="0">the conveyor is turned on if not triggered</flag>
+-------- NOTES --------
+Almost the same as func_conveyor.
</group>
<group name="func_door" color="0 .5 .8">
-Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it.
+Normal sliding door entity. By default, the door will activate when player walks close to it or when damage is inflicted to it. Can be locked with keys.
If DOOR_DONT_LINK is not set, the door will be linked with all doors it touches. Note however that for linked doors to work properly, it is necessary that ALL linked doors have SOME volume of common area (that is, there must be a point that is part of ALL doors).
-------- KEYS --------
<string key="message" name="message">is printed when the door is touched if it is a trigger door and it hasn't been fired yet, or death message if dmg is set</string>
<real key="lip" name="lip">lip remaining at end of move (8 default)</real>
<real key="dmg" name="dmg">damage to inflict when blocked (when triggered and someone is in the way)</real>
<real key="sounds" name="sounds">when 1, use default door sounds</real>
-<sound key="noise1" name="noise1">sound when the door opens</sound>
-<sound key="noise2" name="noise2">sound when the door closes</sound>
-<real key="itemkeys" name="itemkeys">keys required to open this door.</real>
+<sound key="noise" name="noise">sound when the door is unlocked</sound>
+<sound key="noise1" name="noise1">sound when the door stops moving</sound>
+<sound key="noise2" name="noise2">sound when the door is moving</sound>
+<sound key="noise3" name="noise3">sound when the door can't be unlocked</sound>
+<real key="itemkeys" name="itemkeys">keys required to open this door (1 for gold key, 2 for silver key, 3 for both)</real>
-------- SPAWNFLAGS --------
<flag key="START_OPEN" name="START_OPEN" bit="0">causes the door to move to its destination when spawned, and operate in reverse. It is used to temporarily or permanently close off an area when triggered (not useful for touch or damage triggered doors).</flag>
<flag key="DOOR_DONT_LINK" name="DOOR_DONT_LINK" bit="2">the door won't link with another door it touches</flag>
-<flag key="GOLD_KEY" name="GOLD_KEY" bit="3">causes the door to open only if the activator holds a gold key (Q1 compatibility).</flag>
-<flag key="SILVER_KEY" name="SILVER_KEY" bit="4">causes the door to open only if the activator holds a silver key (Q1 compatibility).</flag>
<flag key="TOGGLE" name="TOGGLE" bit="5">causes the door to wait in both the start and end states for a trigger event.</flag>
<flag key="NOSPLASH" name="NOSPLASH" bit="8">if set, splash damage cannot activate the door, only direct damage can (requires health to be set)</flag>
+<flag key="CRUSH" name="CRUSH" bit="11">crush players hit by the door instantly</flag>
-------- NOTES --------
More information about keys can be found in item_key description.
</group>
BIDIR makes the door work bidirectional, so that the opening direction is always away from the requestor.
The usage of bidirectional doors requires two manually instantiated triggers (trigger_multiple), the one to open it in the other direction
must have set trigger_reverse to 1.
-BIDIR_IN_DOWN will the door prevent from reopening while closing if it is triggered from the other side.
+BIDIR_IN_DOWN will prevent the door from reopening while closing if it is triggered from the other side.
-------- KEYS --------
<string key="message" name="message">is printed when the door is touched if it is a trigger door and it hasn't been fired yet, or death message if dmg is set</string>
<string key="message2" name="message2">death message when someone gets pushed into this (default: "was thrown into a world of hurt by"). The # character is replaced by the attacker name if present (and it instead does not get appended to the end)</string>
<real key="wait" name="wait">wait before returning (3 default, -1 = never return)</real>
<real key="dmg" name="dmg">damage to inflict when blocked (when triggered and someone is in the way)</real>
<real key="sounds" name="sounds">when 1, use default door sounds</real>
-<sound key="noise1" name="noise1">sound when the door opens</sound>
-<sound key="noise2" name="noise2">sound when the door closes</sound>
+<sound key="noise" name="noise">sound when the door is unlocked</sound>
+<sound key="noise1" name="noise1">sound when the door stops moving</sound>
+<sound key="noise2" name="noise2">sound when the door is moving</sound>
+<sound key="noise3" name="noise3">sound when the door can't be unlocked</sound>
+<real key="itemkeys" name="itemkeys">keys required to open this door (1 for gold key, 2 for silver key, 3 for both)</real>
-------- SPAWNFLAGS --------
<flag key="START_OPEN" name="START_OPEN" bit="0">causes the door to move to its destination when spawned, and operate in reverse. It is used to temporarily or permanently close off an area when triggered (not useful for touch or damage triggered doors).</flag>
<flag key="DOOR_DONT_LINK" name="DOOR_DONT_LINK" bit="2">the door won't link with another door it touches</flag>
<flag key="NOSPLASH" name="NOSPLASH" bit="8">if set, splash damage cannot activate the door, only direct damage can (requires health to be set)</flag>
<flag key="X_AXIS" name="X_AXIS" bit="6">rotate around the X axis</flag>
<flag key="Y_AXIS" name="Y_AXIS" bit="7">rotate around the Y axis</flag>
+<flag key="BIDIR" name="BIDIR" bit="1">door can open in both directions</flag>
+<flag key="BIDIR_IN_DOWN" name="BIDIR_IN_DOWN" bit="3">don't reopen the door while closing if it's triggered from the wrong side</flag>
+<flag key="CRUSH" name="CRUSH" bit="11">crush players hit by the door instantly</flag>
+-------- NOTES --------
+This entity is similar to func_door.
</group>
<group name="func_door_secret" color="0 .5 .8">
Basic secret door. Slides back, then to the side. Angle determines direction. Opens when targeted or when shot; does not create its own trigger field like func_door does.
-------- KEYS --------
<real key="platmovetype" name="platmovetype">movement type (1 = linear, 2 = cosine [default])</real>
-<real key="wait" name="wait"># of seconds before coming back</real>
+<real key="wait" name="wait">time in seconds before coming back, -1 keeps the door open forever</real>
<string key="key1" name="key1">first entity key with one-line description</string>
<string key="key2" name="key2">second entity key with one-line description</string>
<real key="t_width" name="t_width">override WIDTH to move back (or height if going down)</real>
<real key="dmg" name="dmg">damage to inflict when blocked (2 default)</real>
<string key="message" name="message">text to display when activating the door, or death message if dmg is set</string>
<string key="message2" name="message2">death message when someone gets pushed into this (default: "was thrown into a world of hurt by"). The # character is replaced by the attacker name if present (and it instead does not get appended to the end)</string>
+<real key="sounds" name="sounds">when 1, use default door sounds</real>
<sound key="noise1" name="noise1">sound when opening backwards or closing</sound>
<sound key="noise2" name="noise2">sound when opening sideways</sound>
<sound key="noise3" name="noise3">sound when stopping</sound>
-------- SPAWNFLAGS --------
-<flag key="OPEN_ONCE" name="OPEN_ONCE" bit="0">only work once, then stay open</flag>
<flag key="1ST_LEFT" name="1ST_LEFT" bit="1">1st move is left of arrow</flag>
<flag key="1ST_DOWN" name="1ST_DOWN" bit="2">1st move is down from arrow</flag>
<flag key="NO_SHOOT" name="NO_SHOOT" bit="3">never respond to shots</flag>
<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: "was thrown into a world of hurt by"). The # character is replaced by the attacker name if present (and it instead does not get appended to the end)</string>
-------- SPAWNFLAGS --------
</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>
<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>
<flag key="IMPULSE" name="IMPULSE" bit="1">only send the full amount of impulse particles when the entity is triggered</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
<emitter class> <time since start of background music> <0 if the emitters are to be switched off, >0 and <=1 if they are to be switched on>
e.g.
-------- SPAWNFLAGS --------
<flag key="DISABLED" name="DISABLED" bit="0">do not allow damaging this until it is first activated</flag>
<flag key="INDICATE" name="INDICATE" bit="1">indicate amount of damage already taken by coloring</flag>
-<flag key="NOSPLASH" name="NOSPLASH" bit="8">if set, splash damage cannot activate the door, only direct damage can (requires health to be set)</flag>
+<flag key="NODAMAGE" name="NODAMAGE" bit="2">don't take damage (needs to be triggered to 'explode', then triggered again to restore)</flag>
+<flag key="NOSPLASH" name="NOSPLASH" bit="8">if set, only direct hits do damage (requires health to be set)</flag>
</group>
<point name="trigger_relay_if" color="0 1 0" box="-8 -8 -8 8 8 8">
<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
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>
<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
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>
<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
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>
projects / xonotic / xonotic-maps.pk3dir.git / blobdiff