3 <title>Q3Radiant Editor Manual: Page 8.1</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><a name = "tools5">Tools 5: Working with Entities</a></h1>
\r
11 The entities in <i>Quake III Arena</i> are limited to those
\r
12 defined by the game code. The editor can draws entity information
\r
13 from the game code, or from special definition (.def) files.
\r
14 Version 192 of the editor comes with a .def file developed from an
\r
15 original supplied by EutecTic. Mods made to Quake III Arena
\r
16 can add to and/or subtract from the entities used by a game. If you
\r
17 plan to work on mods, you should create multiple project files
\r
18 (copy and rename your project file) with the changes required for
\r
21 <p><img src = "../Q3Rad_Manual_files/image038.png" hspace = 2 vspace = 2 width = 293 height = 425 align = "left"><h2><a name = "entitywin">The Entity Window</a></h2>
\r
23 You make game design decisions about entities and modify their
\r
24 features within the Entity Window. The definition file that you
\r
25 select on the Project Settings… window determines what
\r
26 entities will be shown in the Entity List and what, if any,
\r
27 property descriptions appear in the Key Descriptions and Check box
\r
32 <p><div class = "subheading">Entity List</div>
\r
34 The Entity List is the field on the Entity Window. It
\r
35 contains the "classnames" of all the entities defined by the
\r
36 definition file in alphabetical order.
\r
40 <p>You can use the scroll bar to scroll through the entities or,
\r
41 after clicking on the field, type in the first letter of the class
\r
42 you want to use (e.g.; type in "T" to select "target", or "A" for
\r
43 ammo, "W" for weapon).
\r
47 <p>Double-click on the classname to select it and enter it on the
\r
48 first line of the Active Properties field.
\r
52 <p>The <a href = "../appndx/appn_b_1.htm">Entities appendices</a> of this document contain a complete listing of all the entities used in Quake III Arena.
\r
56 <p><div class = "subheading">Key Descriptions</div>
\r
58 The entries in the Key Description field are the "rules of use"
\r
59 for the hi-lighted classname in the Entity List field. You can use
\r
60 the scroll bar to scroll up and down through the lines, but
\r
61 the entries are not interactive. If you are using the .def file
\r
62 accompanying release version 192 of the editor (or Eutectic's
\r
63 original), all the key commands are described and their acceptable
\r
64 values (or value ranges) are listed. If you are using the
\r
65 descriptions in the .c game code file, they may be substantially
\r
70 <p><div class = "subheading">Check box Spawn Flags</div>
\r
72 Spawn flags are properties assigned to entities by use of check
\r
73 boxes. Check the box to set the feature for the selected entity.
\r
74 Many entities have only a single spawn flag property, while others
\r
75 have numerous ones. Note that the check boxes to the right are only
\r
76 relevant for Quake 2 single player games and will not work for <i>Quake III Arena</i>.
\r
78 <p><div class = "subheading">Active Properties</div>
\r
80 This field shows all the properties currently assigned to the
\r
81 selected (or newly-created) entity. Each property has two parts:
\r
82 key and value. Once created or assigned, they appear on the same
\r
83 line together. Only properties that are valid for an entity (that
\r
84 is, ones that appear in the Key Descriptions field) will function
\r
85 in game. Adding others may create error messages. You cannot
\r
86 directly affect the properties in this field.
\r
90 <p>Clicking on an active property hi-lights it and fills in the key
\r
91 and value fields below. You can edit both the key and the
\r
92 value in those fields, or use the Del Key/Pair button to delete it
\r
97 <p><div class = "subheading">Key & Value Fields</div>
\r
99 Keys (and their values) are assigned to entities by typing them
\r
100 into the fields. There is no spell check or auto-correction, so
\r
101 make sure that your typing is accurate. Start by typing in
\r
102 the name of the key. Then hit TAB or ENTER to change to the value
\r
103 field. This also clears the contents of the value field. Now type
\r
104 in the value for the key (the Key Descriptions list the acceptable
\r
105 value ranges for the keys). If you hit ENTER, the key and value
\r
106 appear in the Active Properties field. If you hit TAB, the
\r
107 cursor moves up to the key field. You can also click directly on a
\r
108 field to edit it. The cursor will appear after the last character
\r
109 in the field. Use arrow keys to position the cursor within the
\r
114 <p><div class = "subheading">Angle Buttons</div>
\r
116 The Angle Buttons (below the value field) are used to assign a
\r
117 facing direction (as is the case with player start spots or
\r
118 misc_models) or movement direction to entities (such as doors and
\r
119 buttons). Click on a button to create an Angle key with that
\r
120 button's value in the Active Properties field. Clicking on
\r
121 another key changes the angle value.
\r
125 <p>There are two clusters of angle buttons. The first cluster
\r
126 represents rotation around the Z-axis for entities like player
\r
127 start or spawn spots or misc_models. The entity will face in the
\r
128 selected direction. The buttons represent angle directions in
\r
129 45 degree increments. There is a direct correspondance between the
\r
130 angle that the entity will face (or move) and the position of the
\r
131 button in the cluster. If you select the 90-degree button at the
\r
132 top center of the cluster, the entity will face "up" on the XY 2D
\r
133 Map. If you select the 180-degree button on the left side of
\r
134 the cluster, the entity will face left on the XY 2D Map.
\r
138 <p>For entities like doors or buttons, it represents the direction
\r
139 that entity will move when activated.
\r
143 <p>The second angle button cluster assigns an up (-1) or down
\r
144 (-2) direction to the entity. Note that an entity can only have one
\r
145 facing direction. It cannot face up and 45 degrees. It can only
\r
146 affect one or the other.
\r
150 <p>It is also possible to directly edit the angle value in the
\r
151 value field. This allows for a much more precise angle
\r
156 <p><div class = "subheading">The Other Buttons</div>
\r
158 <p>A third cluster of buttons sits to the right of the Angle
\r
159 buttons. Each has a unique function.
\r
163 <p><strong>Reset</strong>
\r
165 <br>Clicking on this button will reset all properties from the entity to the default values.
\r
168 <p><strong>Del Key/Pair</strong>
\r
170 <br>If you have selected an active property, clicking on this button
\r
171 will delete the property.
\r
175 <p><strong>Sound…</strong>
\r
177 <br>This opens a Windows directory browser in the directory that
\r
178 contains the map sounds. Double clicking on a sound file name
\r
179 in the browser window creates an active property with the
\r
180 appropriate key and the value as the path/name for that sound.
\r
184 <p><strong>Model…</strong>
\r
185 <br>This opens a Windows directory browser in the models/mapobjects
\r
186 directory. Double clicking on an .md3 file name in the
\r
187 browser window creates classname misc_model active property with
\r
188 the value as the path/name for that model.
\r
192 <h2><a name = "enttools">Entity Handling Tools</a></h2>
\r
194 These tools manipulate the in game entities. The map component
\r
195 handling tools that are described in the Working with Brushes
\r
196 section also work with entities.
\r
198 <p><div class = "subheading">Escape (ESC)</div>
\r
200 This is the all-purpose deselect key. Use it to back out of
\r
201 operations you don't want to complete or to stop working on an
\r
204 <p><div class = "subheading">Connect Entities</div>
\r
206 <div class = "menu">(Menu: Selection > Connect Entities)
\r
208 <br>(Shortcut: CTRL+ K)</div>
\r
210 This targets one entity, typically an activating trigger, at
\r
211 another entity, usually a target of some kind. Some entities
\r
212 may be linked in multi-part chains, where each entity has some
\r
213 effect on the one(s) that follow it. To use, do the following:
\r
216 <li>Hi-light the acting entity (usually a trigger, or a button).
\r
218 <li>Hi-light the targeted entity (examples: target_position,
\r
219 target_relay, a door).
\r
221 <li>Select Connect Entities (or press CTRL + k).
\r
223 <li>A path is drawn between the two entities. The first entity
\r
224 selected always targets on the second.</ol>
\r
226 Troubleshooting: If the connection is not made check the
\r
229 <ul><li>Are both objects already entities? Sometimes it's easy to forget
\r
230 to make a trigger brush into a trigger.
\r
232 <li>Did you select ONLY two objects? If you accidentally click
\r
233 on something you don't intend to link, you have to start the
\r
236 <li>Did you select the objects in the correct order?
\r
238 <li>Is the second object something that can be triggered
\r
241 <p><div class = "subheading">Ungroup Entity </div>
\r
243 <div class =- "menu">(Menu: Selection > Ungroup Entity)
\r
245 <br>(Shortcut: none)</div>
\r
247 This unbinds an entity made of brushes, and/or patches, and md2
\r
248 models back into separate map components. Once ungrouped, the
\r
249 entity is no longer an entity and loses any and all key value
\r
250 properties it may have had.
\r
252 <p><div class = "tip"><b>Design Note:</b> If you intend to rebuild an entity after
\r
253 ungrouping it, write down its key properties and values first.</div>
\r
255 <p><div class = "subheading">Moving Selected Entity</div>
\r
257 These keys move the Entity around the map in discrete map grid
\r
260 <ul><strong>Move Selection Down</strong>
\r
262 <div class = "menu">(Shortcut: Keypad MINUS)</div>
\r
264 Each press moves the selected map component down along the
\r
265 Z-axis by one grid position (at current grid setting). Not affected
\r
266 by current 2D-map view.
\r
268 <p><strong>Move Selection Up</strong>
\r
270 <div class = "menu">(Shortcut: Keypad PLUS)</div>
\r
272 Each press moves the selected map component up along the Z-axis
\r
273 by one grid position (at current grid setting). Not affected by
\r
274 current 2D-map view.</ul>
\r
276 <p><div class = "subheading">Nudging the Entity</div>
\r
278 These keys move the Entity around the map in discrete map grid
\r
279 increments. The movement is in terms of the selected window, not in
\r
280 terms of XYZ coordinates.
\r
282 <ul><strong>Nudge Down</strong>
\r
284 <div class = "menu">(Shortcut: ALT + DOWN ARROW)</div>
\r
286 Each press moves the selected map component "down" the map view
\r
287 by one grid position (at the current grid setting). The movement is
\r
288 relative to the selected map view, not XYZ coordinates.
\r
292 <p><strong>Nudge Up</strong>
\r
294 <div class = "menu">(Shortcut: ALT + UP ARROW)</div>
\r
296 Each press moves the selected map component "up" the map view by
\r
297 one grid position (at the current grid setting). The movement is
\r
298 relative to the selected map view, not XYZ coordinates.
\r
300 <p><strong>Nudge Left</strong>
\r
302 <div class = "menu">(Shortcut: ALT + LEFT ARROW)</div>
\r
304 Each press moves the selected map component "left" the map view
\r
305 by one grid position (at the current grid setting). The movement is
\r
306 relative to the selected map view, not XYZ coordinates.
\r
308 <p><strong>Nudge Right</strong>
\r
310 <div class = "menu">(Shortcut: ALT + RIGHT ARROW)</div>
\r
312 Each press moves the selected map component "right" the map view
\r
313 by one grid position (at the current grid setting). The movement is
\r
314 relative to the selected map view, not XYZ coordinates.</ul>
\r
316 <p><div class = "subheading">Rotating Entities = BAD!</div>
\r
318 All the commands that rotate brushes and patches will work on
\r
319 entities. Unfortunately, what they do to some entities is BAD!
\r
320 Don't use free rotate or menu rotation commands to rotate
\r
321 Misc_models or any entity model represented by a wireframe model in
\r
322 your map. The movement will separate the model wireframe from its
\r
323 bounding box and will not actually change the facing of the
\r
326 <p><div class = "subheading">Changing Facing = GOOD!</div>
\r
328 To change the direction that a misc_model or entity with a
\r
329 facing (such as a player start or spawn spot) faces, use Angle keys
\r
330 and values. You should "rotate" (change facing) entities with
\r
331 either the Angle buttons on the Entity Window or by entering an
\r
332 Angle key and giving it a rotation value between 1 and 360
\r
335 <p><div class = "subheading">Mass Rotations</div>
\r
337 If you are building a Capture the Flag map, or other map where
\r
338 you only build one portion and rotate it to make the others,
\r
339 consider doing the following. Change the display of all
\r
340 non-misc_model entities to bounding boxes only. Select the
\r
341 entities to be moved and clone them. Then rotate them using the
\r
342 menu rotating commands. Position them in the new map
\r
343 section. Next, move misc_models individually. Change
\r
344 their facing and set them in place.
\r
345 <p align = "center"><a href = "../ch07/pg7_1.htm">Back</a> | <a href = "../index.htm">Home</a> | <a href = "../ch09/pg9_1.htm">Next</a>
\r
projects / xonotic / netradiant.git / blob