3 <title>Q3Radiant Editor Manual: Appendix B2</title>
\r
4 <link rel = "stylesheet" type = "text/css" href = "../styles/q3rad.css">
\r
7 <h1 class = "MsoTitle">Q3Radiant Editor Manual</h1>
\r
9 <h1>Appendix B: Entity Descriptions</h1>
\r
10 <h2><a name = "func">Func_* Entities</a></h2>
\r
11 Func_Entities include a wider variety of game purposes than
\r
12 other entity classes. They are sometimes represented by simple
\r
13 function boxes. But many are built out of brushes, patches and
\r
14 models. These constructions are sometimes called "b_models", though
\r
15 for many of them the word "mover" works as well, since they are
\r
16 made to be moving objects in the game world.
\r
18 <p><div class = "subheading">func_bobbing</div>
\r
20 <b>Map Entity Color:</b> N/A
\r
22 <br><b>Dimensions:</b> size of map components used
\r
24 <br><b>Game Function:</b> Solid entity that oscillates back and
\r
25 forth in a linear motion. By default, it will have an amount of
\r
26 displacement in either direction equal to the dimension of the
\r
27 brush in the axis in which it's bobbing. Entity bobs on the Z axis
\r
28 (up-down) by default. It can also emit sound if the "noise" key is
\r
29 set. Will crush the player when blocked.
\r
33 <p><strong>Keys</strong>
\r
35 <br><b>speed:</b> amount of time in seconds for one complete
\r
36 oscillation cycle (default 4).
\r
38 <br><b>height:</b> sets the amount of travel of the oscillation
\r
39 movement (default 32).
\r
41 <br><b>phase:</b> sets the start offset of the oscillation cycle.
\r
42 Values must be 0 < phase < 1. Any integer phase value is the
\r
43 same as no offset (default 0).
\r
45 <br><b>noise:</b> path/name of .wav file to play. Use looping sounds
\r
46 only (eg. sound/world/drone6.wav - See Notes).
\r
48 <br><b>model2:</b> path/name of model to include (eg:
\r
49 models/mapobjects/jets/jets01.md3).
\r
51 <br><b>origin:</b> alternate method of setting XYZ origin of sound
\r
52 and .md3 model included with entity (See Notes).
\r
54 <br><b>light:</b> constantLight radius of .md3 model included with
\r
55 entity. Has no effect on the entity's brushes (default 0).
\r
57 <br><b>color:</b> constantLight color of .md3 model included with
\r
58 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
60 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
61 for all" and "Tournament" modes.
\r
63 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
64 "Teamplay" and "CTF" modes.
\r
66 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
67 Player mode (bot play mode).
\r
71 <p><strong>Check Boxes/Spawnflags</strong>
\r
72 <br>X_AXIS : entity will bob along the X axis.
\r
73 <br>Y_AXIS : entity will bob along the Y axis.
\r
77 <p><strong>Notes</strong>
\r
78 <br>In order for the sound to be emitted from the location of the
\r
79 entity, it is recommended to include a brush with an origin shader
\r
80 at its center, otherwise the sound will not follow the entity as it
\r
81 moves. Setting the origin key is simply an alternate method to
\r
82 using an origin brush. When using the model2 key, the origin point
\r
83 of the model will correspond to the origin point defined by either
\r
84 the origin brush or the origin coordinate value. The movement of
\r
85 the func_bobbing follows a sinoid wave pattern.
\r
89 <p><div class = "subheading">func_button</div>
\r
90 <b>Map Entity Color:</b> N/A
\r
92 <br><b>Dimensions:</b> size of map components used
\r
94 <br><b>Game Function:</b> When a button is touched by a player, it
\r
95 moves in the direction set by the "angle" key, triggers all its
\r
96 targets, stays pressed by an amount of time set by the "wait" key,
\r
97 then returns to its original position where it can be operated
\r
102 <p><strong>Keys</strong>
\r
103 <br><b>angle:</b> determines the direction in which the button will
\r
104 move (up = -1, down = -2).
\r
106 <br><b>target:</b> all entities with a matching targetname will be
\r
109 <br><b>speed:</b> speed of button's displacement (default 40). Speed
\r
110 is in game units per second.
\r
112 <br><b>wait:</b> number of seconds button stays pressed (default 1,
\r
113 -1 = return immediately).
\r
115 <br><b>lip:</b> lip remaining at end of move (default 4 units).
\r
117 <br><b>health:</b> if set to a non-zero value, the button must be
\r
118 damaged by "health" amount of points to operate.
\r
120 <br><b>light:</b> constantLight radius of .md3 model included with
\r
121 entity. Has no effect on the entity's brushes (default 0).
\r
123 <br><b>color:</b> constantLight color of .md3 model included with
\r
124 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
126 <br><b>model2:</b> path/name of model to include (eg:
\r
127 models/mapobjects/pipe/pipe02.md3).
\r
129 <br><b>origin:</b> alternate method of setting XYZ origin of .md3
\r
130 model included with entity (See Notes).
\r
132 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
133 for all" and "Tournament" modes.
\r
135 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
136 "Teamplay" and "CTF" modes.
\r
138 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
139 Player mode (bot play mode).
\r
143 <p><strong>Notes</strong>
\r
144 <br>Setting the origin key is simply an alternate method to using an
\r
145 origin brush. When using the model2 key, the origin point of the
\r
146 model will correspond to the origin point defined by either the
\r
147 origin brush or the origin coordinate value.
\r
151 <p><div class = "subheading">func_door</div>
\r
153 <b>Map Entity Color:</b> N/A
\r
155 <br><b>Dimensions:</b> size of map components used
\r
157 <br><b>Game Function:</b> Normal sliding door entity. By default,
\r
158 the door will activate when player walks close to it or when damage
\r
159 is inflicted on it. Doors move a distance equal to their dimension
\r
160 along the selected angle of travel, minus the "lip" key
\r
165 <p><strong>Keys</strong>
\r
167 <br><b>angle:</b> determines the opening direction of door (up
\r
170 <br><b>speed:</b> determines how fast the door moves (default 100).
\r
171 Speed is in game units per second.
\r
173 <br><b>wait:</b> number of seconds before door returns (default 2,
\r
174 -1 = return immediately - see Notes).
\r
176 <br><b>lip:</b> lip remaining at end of move (default 8).
\r
178 <br><b>targetname:</b> if set, a func_button or trigger is required
\r
179 to activate the door.
\r
181 <br><b>health:</b> if set to a non-zero value, the door must be
\r
182 damaged by "health" amount of points to activate (default 0).
\r
184 <br><b>dmg:</b> damage to inflict on player when he blocks operation
\r
185 of door (default 4). Door will reverse direction when blocked
\r
186 unless CRUSHER spawnflag is set.
\r
188 <br><b>team:</b> assign the same team name to multiple doors that
\r
189 should operate together (see Notes).
\r
191 <br>light: constantLight radius of .md3 model included with entity.
\r
192 Has no effect on the entity's brushes (default 0).
\r
194 <br><b>color:</b> constantLight color of .md3 model included with
\r
195 entity. Has no effect on the entity's brushes. (default 1 1 1).
\r
197 <br><b>model2:</b> path/name of model to include (eg:
\r
198 models/mapobjects/pipe/pipe02.md3).
\r
200 <br><b>origin:</b> alternate method of setting XYZ origin of .md3
\r
201 model included with entity (See Notes).
\r
203 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
204 for all" and "Tournament" modes.
\r
206 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
207 "Teamplay" and "CTF" modes.
\r
209 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
210 Player mode (bot play mode).
\r
214 <p><strong>Check Boxes/Spawnflags</strong>
\r
216 <br><b>START_OPEN:</b> the door will spawn in the open state and
\r
217 operate in reverse.
\r
219 <br><b>CRUSHER:</b> door will not reverse direction when blocked and
\r
220 will keep damaging player until he dies or gets out of the way.
\r
224 <p><strong>Notes</strong>
\r
226 <br>Unlike in Quake 2, doors that touch are NOT automatically
\r
227 teamed. If you want doors to operate together, you have to team
\r
228 them manually by assigning the same team name to all of them.
\r
229 Setting wait =-1 for normal touch doors makes them work
\r
230 erratically. Use this only for damage-only ("health" key set to
\r
231 non-zero value) or targeted doors. Setting the origin key is simply
\r
232 an alternate method to using an origin brush. When using the model2
\r
233 key, the origin point of the model will correspond to the origin
\r
234 point defined by either the origin brush or the origin coordinate
\r
239 <p><div class = "subheading">func_group</div>
\r
241 <b>Map Entity Color:</b> Light blue
\r
243 <br><b>Dimensions</b>: Determined by dimensions of map
\r
246 <br><b>Game Function:</b> This is not an entity. It is strictly an
\r
247 editor utility to group world brushes and patches together for
\r
248 convenience (selecting, moving, copying, etc). You cannot group
\r
249 entities with this.
\r
253 <p><strong>Notes</strong>
\r
255 <br>The TAB key can be used to flip through the component pieces of
\r
256 a selected func_group entity, isolating individual components.
\r
260 <p><div class = "subheading">func_pendulum</div>
\r
262 <b>Map Entity Color:</b> Light blue
\r
264 <br><b>Dimensions</b>: Determined by dimensions of map
\r
267 <br><b>Game Function:</b> Solid entity that describes a pendulum
\r
268 back and forth rotation movement. Rotates on the X axis by default.
\r
269 Pendulum frequency is a physical constant based on the length of
\r
270 the beam and gravity. Contact with the pendulum instantly kills a
\r
275 <p><strong>Keys</strong>
\r
277 <br><b>angle:</b> angle offset of axis of rotation from default X
\r
278 axis (default 0/360).
\r
280 <br><b>speed:</b> angle of swing arc in either direction from
\r
281 initial vertical position (default 30).
\r
283 <br><b>phase:</b> sets the start offset of the swinging cycle.
\r
284 Values must be 0 < phase < 1. Any integer phase value is the
\r
285 same as no offset (default 0).
\r
287 <br><b>noise:</b> path/name of .wav file to play. Use looping sounds
\r
288 only (eg. sound/world/drone6.wav).
\r
290 <br><b>model2:</b> path/name of model to include (eg:
\r
291 models/mapobjects/jets/jets01.md3).
\r
293 <br><b>origin:</b> alternate method of setting XYZ origin of
\r
294 entity's rotation axis and .md3 model included with entity (default
\r
295 "0 0 0" - See Notes).
\r
297 <br><b>light:</b> constantLight radius of .md3 model included with
\r
298 entity. Has no effect on the entity's brushes (default 0).
\r
300 <br><b>color:</b> constantLight color of .md3 model included with
\r
301 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
303 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
304 for all" and "Tournament" modes.
\r
306 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
307 "Teamplay" and "CTF" modes.
\r
309 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
310 Player mode (bot play mode).
\r
314 <p><strong>Notes</strong>
\r
316 <br>You need to have an origin brush as part of this entity. The
\r
317 center of that brush will be the point through which the rotation
\r
318 axis passes. Setting the origin key is simply an alternate method
\r
319 to using an origin brush. Pendulum will rotate along the X axis by
\r
320 default. Pendulum cannot rotate along Z axis. The speed of swing
\r
321 (frequency) is not adjustable, and the "dmg" key (although set in
\r
322 the Q3A maps) has no effect whatsoever. When using the model2 key,
\r
323 the origin point of the model will correspond to the origin point
\r
324 defined by either the origin brush or the origin coordinate
\r
327 <p><div class = "subheading">func_plat</div>
\r
329 <b>Map Entity Color:</b> Light blue
\r
331 <br><b>Dimensions</b>: Determined by dimensions of map
\r
334 <br><b>Game Function:</b> This is a rising platform that a player
\r
335 can ride to reach higher places. Plats must always be drawn in the
\r
336 raised position, so they will operate and be lighted correctly but
\r
337 they spawn in the lowered position. The plat will stay in the
\r
338 raised position until the player steps off. There are no proper
\r
339 sounds for this entity, only beep noises, so sound call paths must
\r
340 be adjusted (see Notes).
\r
344 <p><strong>Keys</strong>
\r
346 <br><b>speed:</b> determines how fast the plat moves (default 150)
\r
347 in game units per second.
\r
349 <br><b>lip:</b> lip remaining at end of move (default 16). Has no
\r
350 effect if "height" is set.
\r
352 <br><b>height:</b> if set, this will determine the total amount of
\r
353 vertical travel of the plat (see Design Notes).
\r
355 <br><b>dmg:</b> damage to inflict on a player when he blocks
\r
356 operation of plat (default 4). Plat will reverse direction when
\r
359 <br><b>targetname:</b> if set, the trigger that points to this will
\r
360 raise the plat each time it fires. The plat raises and comes back
\r
361 down a second later if no player is on it.
\r
363 <br><b>light:</b> constantLight radius of .md3 model included with
\r
364 entity. Has no effect on the entity's brushes (default 0).
\r
366 <br><b>color:</b> constantLight color of .md3 model included with
\r
367 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
369 <br><b>model2:</b> path/name of model to include (eg:
\r
370 models/mapobjects/pipe/pipe02.md3).
\r
372 <br><b>origin:</b> alternate method of setting XYZ origin of .md3
\r
373 model included with entity (See Notes).
\r
375 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
376 for all" and "Tournament" modes.
\r
378 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
379 "Teamplay" and "CTF" modes.
\r
381 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
382 Player mode (bot play mode).
\r
386 <p><strong>Notes</strong>
\r
388 <br>By default, the total amount of vertical travel of a platform is
\r
389 implicitly determined by the overall vertical size of the brushes
\r
390 of which it's made minus the lip value. But if the "height" key is
\r
391 used, then the total amount of vertical travel of the plat will be
\r
392 exactly that value regardless of the shape and size of the plat and
\r
393 regardless of the value of the "lip" key. Using the "height" key is
\r
394 the best method for any kind of platforms and the only possible one
\r
395 for thin plats which need to travel vertical distances many times
\r
396 their own thickness. Setting the origin key is simply an alternate
\r
397 method to using an origin brush. When using the model2 key, the
\r
398 origin point of the model will correspond to the origin point
\r
399 defined by either the origin brush or the origin coordinate
\r
404 <p><div class = "tip"><strong>Design Notes:</strong>
\r
406 <br> Clip brushes can be used to create the
\r
407 additional size for "thin" plats. Func_plats were pulled from all
\r
408 maps in the final build of Quake 3 Arena due to some problems in
\r
409 their operation, particularly as it related to bot function.
\r
410 The id designers recommend using plats with care and that plats be
\r
411 built as "solid" pillar-like lifts (more like those in Doom).
\r
413 <br> There is a way to make plats play
\r
414 proper sounds. Just create a sound\movers\plats folder under baseq3
\r
415 and put 2 sounds named pt1_start.wav and pt1_end.wav in it. Those
\r
416 can be the renamed sounds from the Q2 plats or renamed copies of
\r
417 the sound\movers\doors sounds you can extract from your pak0.pk3
\r
418 file or new custom sounds if you're up to it. Thanks to Fragzilla
\r
423 <p><div class = "subheading">func_rotating</div>
\r
425 <b>Map Entity Color:</b> Light blue
\r
427 <br><b>Dimensions</b>: Determined by dimensions of map
\r
430 <br><b>Game Function:</b> Solid entity that rotates continuously.
\r
431 Rotates on the Z axis by default and requires an origin brush. It
\r
432 will always start on in the game and is not targetable.
\r
436 <p><strong>Keys</strong>
\r
438 <br><b>speed:</b> determines how fast entity rotates (default
\r
441 <br><b>noise:</b> path/name of .wav file to play. Use looping sounds
\r
442 only (eg. sound/world/drone6.wav).
\r
444 <br><b>model2:</b> path/name of model to include (eg:
\r
445 models/mapobjects/bitch/fembotbig.md3).
\r
447 <br><b>origin:</b> alternate method of setting XYZ origin of
\r
448 entity's rotation axis and .md3 model included with entity (default
\r
449 "0 0 0" - See Notes).
\r
451 <br><b>light:</b> constantLight radius of .md3 model included with
\r
452 entity. Has no effect on the entity's brushes (default 0).
\r
454 <br><b>color:</b> constantLight color of .md3 model included with
\r
455 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
457 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
458 for all" and "Tournament" modes.
\r
460 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
461 "Teamplay" and "CTF" modes.
\r
463 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
464 Player mode (bot play mode).
\r
468 <p><strong>Check Boxes/Spawnflags</strong>
\r
470 <br><b>X_AXIS:</b> entity will rotate along the X axis.
\r
472 <br>Y<b>_AXIS:</b> entity will rotate along the Y axis.
\r
476 <p><strong>Notes</strong>
\r
478 <br>You need to have an origin brush as part of this entity. The
\r
479 center of that brush will be the point through which the rotation
\r
480 axis passes. Setting the origin key is simply an alternate method
\r
481 to using an origin brush. It will rotate along the Z axis by
\r
482 default. You can check either the X_AXIS or Y_AXIS box to change
\r
487 <p><div class = "subheading">func_static</div>
\r
489 <b>Map Entity Color:</b> N/A
\r
491 <br><b>Dimensions:</b> Determined by components
\r
493 <br><b>Game Function:</b> Static solid bspmodel. Can be used for
\r
494 conditional walls and models for different game types.
\r
498 <p><strong>Keys</strong>
\r
500 <br><b>model2:</b> path/name of model to include (eg:
\r
501 models/mapobjects/bitch/fembotbig.md3).
\r
503 <br><b>light:</b> constantLight radius of .md3 model included with
\r
504 entity. Has no effect on the entity's brushes (default 0).
\r
506 <br><b>color:</b> constantLight color of .md3 model included with
\r
507 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
509 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
510 for all" and "Tournament" modes.
\r
512 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
513 "Teamplay" and "CTF" modes.
\r
515 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
516 Player mode (bot play mode).
\r
520 <p><strong>Notes</strong>
\r
522 <br>When using the model2 key, the origin point of the model will
\r
523 correspond to the origin point defined by either the origin brush
\r
524 or the origin coordinate value. Because the map has only a single
\r
525 bot navigation file, Func_Statics cannot be used to make
\r
526 significant changes in game play flow between differing game
\r
531 <br><div class = "subheading">func_timer</div>
\r
533 <b>Map Entity Color:</b> Dark blue (0.3 0.1 0.6)
\r
535 <br><b>Dimensions:</b> (-8 -8 -8) (8 8
\r
538 <br><b>Game Function:</b> Time delay trigger that will continuously
\r
539 fire its targets after a preset time delay. The time delay can also
\r
540 be randomized. When triggered, the timer will toggle on/off.
\r
544 <p><strong>Keys</strong>
\r
546 <br><b>wait:</b> delay in seconds between each triggering of its
\r
547 targets (default 1).
\r
549 <br><b>random:</b> random time variance in seconds added or
\r
550 subtracted from "wait" delay (default 0 - see Notes).
\r
552 <br><b>target:</b> this points to the entities to trigger.
\r
554 <br><b>targetname:</b> a func_button or trigger that points to this
\r
555 will toggle the timer on/off when activated.
\r
557 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
558 for all" and "Tournament" modes.
\r
560 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
561 "Teamplay" and "CTF" modes.
\r
563 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
564 Player mode (bot play mode).
\r
568 <p><strong>Check Boxes/Spawnflags</strong>
\r
570 <br><b>START_ON:</b> timer will start on in the game and
\r
571 continuously fire its targets.
\r
575 <p><strong>Notes</strong>
\r
577 <br>When the random key is set, its value is used to calculate a
\r
578 minimum and a maximum delay. The final time delay will be a random
\r
579 value anywhere between the minimum and maximum values: (min delay =
\r
580 wait - random) (max delay = wait + random).
\r
584 <p><div class = "subheading">func_train</div>
\r
586 <b>Map Entity Color:</b> (0 .5 .8)
\r
588 <br><b>Dimensions:</b> Determined by
\r
589 components<b><o:p><b></b></o:p></b>
\r
591 <br><b>Game Function:</b> Trains are moving solids that follow a
\r
592 string of path_corner entities. Trains in Q3A are very basic, they
\r
593 also require an origin brush (see Notes).
\r
597 <p><strong>Keys</strong>
\r
599 <br><b>speed:</b> speed of displacement of train (default 100 or
\r
600 overridden by speed value of path).
\r
602 <br><b>target:</b> this points to the first path_corner of the path
\r
603 which is also the spawn location of the train's origin.
\r
605 <br><b>model2:</b> path/name of model to include (eg:
\r
606 models/mapobjects/pipe/pipe02.md3).
\r
608 <br><b>origin:</b> alternate method of setting XYZ origin of the
\r
609 train's brush(es) and .md3 model included with entity (See
\r
612 <br><b>light:</b> constantLight radius of .md3 model included with
\r
613 entity. Has no effect on the entity's brushes (default 0).
\r
615 <br><b>color:</b> constantLight color of .md3 model included with
\r
616 entity. Has no effect on the entity's brushes (default 1 1 1).
\r
618 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free
\r
619 for all" and "Tournament" modes.
\r
621 <br><b>notteam:</b> when set to 1, entity will not spawn in
\r
622 "Teamplay" and "CTF" modes.
\r
624 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single
\r
625 Player mode (bot play mode).
\r
629 <p><strong>Notes</strong>
\r
631 <br>1. Trains always start on in the game.
\r
633 <br>2. Trains do not damage the player when blocked.
\r
635 <br>3. Trains cannot emit sound.
\r
637 <br>4. Trains are not triggerable or toggle-able.
\r
639 <br>5. Trains cannot be block-stopped just by getting in their way,
\r
640 the player must be wedged between the train and another obstacle to
\r
645 <p>Setting the origin key is simply an alternate method to using an
\r
646 origin brush. When using the model2 key, the origin point of the
\r
647 model will correspond to the origin point defined by either the
\r
648 origin brush or the origin coordinate value.
\r
649 <p align = "center"><a href = "appn_b_1.htm">Back</a> | <a href = "../index.htm">Home</a> | <a href = "appn_b_3.htm">Next</a>
\r
projects / xonotic / netradiant.git / blob