]> de.git.xonotic.org Git - xonotic/xonotic-maps.pk3dir.git/blobdiff - scripts/entities.def
Fixed documentation
[xonotic/xonotic-maps.pk3dir.git] / scripts / entities.def
index 301ad206f2545f7f6f8fab55dfa15061783e9dab..5b0f1c14f36cba0e14a5aff8af8dc462342fe017 100644 (file)
@@ -22,9 +22,13 @@ zbqry="zbqryf/qbzvangvba/qbz_hapynvzrq.zq3"
 /*QUAKED dom_team (.3 .3 1) (-16 -16 -16) (16 16 16) 
 Domination team.
 In order to get Domination working well in your map, you need to place dom_team and dom_controlpoint entities.  You *must* have at least 3 dom_team entities - 2 minimum teams and one blank one (empty netname and no team).  You can have up to 4 teams (5 dom_team entities).
+
+dom_team entites declare the teams (and the models the team uses) that are available in the domination game. Their position does not matter.
+
+model should be set to models/domination/dom_<team>.md3, where <team> is either "red", "blue", "yellow", or "pink".
 -------- KEYS --------
 netname: name of team (Red Team).  Set to "" or don't define for the required blank team.
-cnt: color of the team.  See the "Helpful Extras" section for info.
+cnt: color of the team.  See the "Helpful Extras" section in Docs/mapping.txt for info.
 model: When this team captures control points, the points turn to this model.  If this is the neutral team, points start out as this model.
 noise: Sound to be played on the control point when it's captured.  Only players nearby will hear it.
 noise1: Sound to be played to all players when the control point is captured.  Also good for an announcer voice ("Red Team has captured a control point")
@@ -637,7 +641,7 @@ Use trigger_monoflop if you want the laser to turn off for a while, then turn ba
 When the laser's target has itself target set, its targets are triggered when someone enters or leaves the laser.
 */
 
-/*QUAKED misc_model (1 .5 .25) (-16 -16 -16) (16 16 16) - SOLID - EXTRUDE_NORMALS EXTRUDE_TERRAIN COLOR_TO_ALPHA
+/*QUAKED misc_model (1 .5 .25) (-16 -16 -16) (16 16 16) - SOLID FORCE_META EXTRUDE_NORMALS EXTRUDE_TERRAIN COLOR_TO_ALPHA DONT_FIX_NORMALS
 Generic placeholder for inserting MD3 models in game. Requires compilation of map geometry to be added to level. If the map is compiled with Q3Map2, then ASE, 3DS, OBJ and other model formats are supported.
 -------- Q3MAP2 KEYS --------
 model: file name of model to include
@@ -653,9 +657,11 @@ _lightmapscale: light map resolution factor
 _celshader: the cel shader for this
 -------- SPAWNFLAGS --------
 SOLID: make the model solid
+FORCE_META: force the model to go through the -meta pipeline and enable lightmapping
 EXTRUDE_NORMALS: for converting triangles to clip brushes, extrude along the model normals (by default, extrusion happens in a coordinate axis direction that is decided per triangle)
 EXTRUDE_TERRAIN: always extrude downwards (for terrain)
 COLOR_TO_ALPHA: use the color value as alpha (for terrain blending)
+DONT_FIX_NORMALS: do not regenerate normals
 */
 
 /*QUAKED misc_gamemodel (0 .5 .8) (-8 -8 -8) (8 8 8) ALIGN_ORIGIN ALIGN_BOTTOM
@@ -1266,7 +1272,7 @@ race_place: if target points to the trigger_race_checkpoint with cnt 0 (finish l
 restriction: when 1, only bots can spawn here; when 2, only humans can spawn here (be careful with these, or the game will crash because someone cannot spawn)
 */
 
-/*QUAKED func_pointparticles (.5 .5 .5) ? START_ON IMPULSE
+/*QUAKED func_pointparticles (.5 .5 .5) ? START_ON IMPULSE VISCULLING
 A brush that emits particles.
 -------- KEYS --------
 mdl: particle effect name from effectinfo.txt
@@ -1287,6 +1293,7 @@ bgmscriptrelease: release time of the effect strength (0 to 3.9)
 -------- SPAWNFLAGS --------
 START_ON: when targeted, the particle emitter will start switched on
 IMPULSE: only send the full amount of impulse particles when the entity is triggered
+VISCULLING: only emit particles if the emitter brush is in the current PVS
 -------- NOTES --------
 Use trigger_monoflop 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
@@ -1501,6 +1508,20 @@ FLOATING: the item will float in air, instead of aligning to the floor by fallin
 model="models/weapons/g_hlac.md3"
 */
 
+/*QUAKED weapon_seeker (1 0 .5) (-30 -30 0) (30 30 32) FLOATING
+Placing this entity on a map kills your dog, voids the warranty on your car, and makes your map an unenjoyable noobs' paradise.
+the T.A.G. Seeker.
+-------- KEYS --------
+ammo_rockets: initial rockets of the weapon (if unset, g_pickup_rockets is used)
+respawntime: time till it respawns (default: 30)
+team: out of items with the same value here, only one (random one) will spawn. Useful to put multiple items on one spot.
+cnt: weight of this item for random selection using "team". Set to a lower value for items you want to see less likely.
+-------- SPAWNFLAGS --------
+FLOATING: the item will float in air, instead of aligning to the floor by falling
+-------- MODEL FOR RADIANT ONLY - DO NOT SET THIS AS A KEY --------
+model="models/weapons/g_seeker.md3"
+*/
+
 /*QUAKED weapon_hook (1 0 .5) (-30 -30 0) (30 30 32) FLOATING
 the on-hand Grappling Hook.
 -------- KEYS --------
@@ -1742,7 +1763,7 @@ model="models/weapons/g_fireball.md3"
 
 /*QUAKED trigger_warpzone (1 .5 1) ?
 A warp zone, i.e. seamlessly connecting two parts of the map.
-One surface of this entity must have the common/warpzone shader - this will be the warp plane - the others should be common/trigger.
+One surface of this entity must have the common/warpzone shader (or a similar selfmade shader) - this will be the warp plane - the others must be common/trigger.
 Must target, or be targeted by, another trigger_warpzone with a congruent common/warpzone surface.
 Should target a target_position, or be targeted by a misc_warpzone_position.
 Should be thick enough to fit a player entity (i.e. 32 units), preferably even thicker.
@@ -1775,3 +1796,42 @@ Must target a target_position that indicates the view to be shown (and whose ang
 target: must point to a target_position
 */
 
+/*QUAKED target_music (1 0 0) (-8 -8 -8) (8 8 8)
+Background music target (when this is used, the cdtrack line in mapinfo must not be used, and there MUST be a default target_music).
+When triggered, the background music is switched to the given track.
+When targetname is not set, this is the default track of the map.
+-------- KEYS --------
+targetname: The name other entities can use to target this entity (when not set, this one is the default)
+noise: the music to play (as full sound file name)
+volume: the volume (default: 1)
+fade_time: fade-in time
+fade_rate: fade-out time
+lifetime: when set, the music created by this target is switched back to the default one when this time expires
+-------- SPAWNFLAGS --------
+START_OFF: the trigger is off initially
+*/
+
+/*QUAKED trigger_music (1 0 0) ?
+Background music trigger (when this is used, the cdtrack line in mapinfo must not be used, and there MUST be a default target_music).
+When triggered, its effect is turned off until triggered again.
+-------- KEYS --------
+targetname: The name other entities can use to target this entity
+noise: the music to play (as full sound file name)
+volume: the volume (default: 1)
+fade_time: fade-in time
+fade_rate: fade-out time
+-------- SPAWNFLAGS --------
+START_OFF: the trigger is off initially
+*/
+
+/*QUAKED trigger_gravity (.5 .5 1) ? STICKY START_OFF
+An area where gravity differs from the rest of the map.
+This acts as a modifier over the normal gravity (sv_gravity). eg: 0.5 is half the normal gravity, 2 is twice the normal gravity.
+-------- KEYS --------
+gravity: gravity offset in this area, defaults to 0 if not set
+noise: sound to play when an entity enters the gravity zone, leave empty to disable
+targetname: you can use this to target the grazity zone with a trigger, which will toggle it when activated
+-------- SPAWNFLAGS --------
+STICKY: entities keep their gravity after leaving the gravity zone
+START_OFF: when targeted, the gravity zone starts off and is enabled upon triggering
+*/