]> git.xonotic.org Git - xonotic/netradiant.git/blob - docs/manual/Q3Rad_Manual/appndx/appn_b_6.htm
transfer from internal tree r5311 branches/1.4-gpl
[xonotic/netradiant.git] / docs / manual / Q3Rad_Manual / appndx / appn_b_6.htm
1 <html>\r
2 <head>\r
3 <title>Q3Radiant Editor Manual: Appendix B6</title>\r
4 <link rel = "stylesheet" type = "text/css" href = "../styles/q3rad.css">\r
5 </head>\r
6 <body>\r
7 <h1 class = "MsoTitle">Q3Radiant Editor Manual</h1>\r
8 <hr>\r
9 <h1>Appendix B: Entity Descriptions</h1>\r
10 <h2><a name = "misc">Misc_* Entities</a></h2>\r
11 <div class = "subheading">misc_model</div>\r
12 \r
13 <b>Map Entity Color:</b> red\r
14 \r
15 <br><b>Dimensions:</b> (-16 -16 -16) (16 16 16)\r
16 \r
17 <br><b>Game Function:</b> Generic, one-size-fits-all placeholder for\r
18 inserting .md3 models in game. Requires compilation of map geometry\r
19 to be added to level.\r
20 \r
21 <p><strong>Keys</strong>\r
22 \r
23 <br><b>angle:</b> direction in which model will be oriented.\r
24 \r
25 <br><b>model :</b> path/name of model to use (eg:\r
26 models/mapobjects/teleporter/teleporter.md3).*/\r
27 \r
28 \r
29 \r
30 <p><strong>Notes</strong>\r
31 \r
32 <br>This is a premade mesh model, created in a program like\r
33 Kinetix's 3d Studio Max. It is a static (non-animating)\r
34 model.&nbsp; Shaders can give it the appearance of motion, but no\r
35 animation.&nbsp; The models should be stored in a directory with\r
36 the pathname: models/mapobjects. The process by which models are\r
37 made is not a part of this document. Currently, models only have\r
38 rotation on the Z axis.\r
39 \r
40 <p>Models do not "clip" against players or weapon\r
41 hits. They are entirely non-solid. If clipping is important, The\r
42 user will need to build clip brushes that are roughly the size and\r
43 shape of the models.\r
44 \r
45 <p>Do not use the flip or rotate tools on models. Only use the\r
46 entity facing buttons or manually change the angle value. The\r
47 purple "3d crosshair" is the origin point of the model.\r
48 \r
49 <p><b>Make it:</b> Right mouse press on a map window to bring up\r
50 the floating entity selector.&nbsp; Select misc_model. A selection\r
51 dialogue box will open giving access to available .md3 files.&nbsp;\r
52 Select the one you want and it will load into the map.&nbsp; Now,\r
53 hit "n" to open the entity window. Click on the "model" key in the\r
54 key list box. Now edit the value field to remove part of the\r
55 line.\r
56 \r
57 <p><b>Example:</b> <span class = "type">"c://program files/quake III\r
58 arena/baseq3/models/mapobjects/storch.md3"</span>\r
59 \r
60 <p>&hellip; should be edited to read:\r
61 \r
62 <p><span class = "type">"models/mapobjects/storch.md3"</span>\r
63 \r
64 \r
65 \r
66 <p><div class = "subheading">misc_portal_camera</div>\r
67 \r
68 <b>Map Entity Color:</b> light orange\r
69 \r
70 <br><b>Dimensions:</b> (-8 -8 -8) (8 8 8)\r
71 \r
72 <br><b>Game Function:</b> Portal camera. This camera is used to\r
73 project its view onto a portal surface in the level through the\r
74 intermediary of a misc_portal_surface entity. Use the "angles" key\r
75 or target a target_position or info_notnull entity to set the\r
76 camera's pointing direction.\r
77 \r
78 \r
79 \r
80 <p><strong>Keys</strong>\r
81 \r
82 <br><b>angles:</b> this sets the pitch and yaw aiming angles of the\r
83 portal camera (default 0 0). Use "roll" key to set roll angle.\r
84 \r
85 <br><b>target:</b> point this to a target_position entity to set the\r
86 camera's pointing direction.\r
87 \r
88 <br><b>targetname:</b> a misc_portal_surface portal surface\r
89 indicator must point to this.\r
90 \r
91 <br><b>roll:</b> roll angle of camera. A value of 0 is upside down\r
92 and 180 is the same as the player's view.\r
93 \r
94 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free\r
95 for all" and "Tournament" modes.\r
96 \r
97 <br><b>notteam:</b> when set to 1, entity will not spawn in\r
98 "Teamplay" and "CTF" modes.\r
99 \r
100 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single\r
101 Player mode (bot play mode).\r
102 \r
103 \r
104 \r
105 <p><strong>Check Boxes/Spawnflags</strong>\r
106 \r
107 <br>SLOWROTATE : makes the portal camera rotate slowly along the\r
108 axis of camera to target or (selected direction).\r
109 \r
110 <br>FASTROTATE : makes the portal camera rotate faster along the\r
111 axis of camera to target or (selected direction)..\r
112 \r
113 \r
114 \r
115 <p><strong>Notes</strong>\r
116 <ul><li>Both the setting "angles" key or "targeting a target_position"\r
117 methods can be used to aim the camera. However, the target_position\r
118 method is simpler. In both cases, the "roll" key must be used to\r
119 set the roll angle. Generally, this is adjusted after compiling the\r
120 map at least once.\r
121 \r
122 <li>If either the SLOWROTATE or FASTROTATE spawnflag is set, then\r
123 the "roll" value is irrelevant.</ul>\r
124 \r
125 \r
126 \r
127 <p><div class = "subheading">misc_portal_surface</div>\r
128 \r
129 <b>Map Entity Color:</b> light orange\r
130 \r
131 <br><b>Dimensions:</b> (-8 -8 -8) (8 8 8)\r
132 \r
133 <br><b>Game Function:</b> Portal surface indicator. This will "lock\r
134 on" the brush face closest to it and identify as a portal. The view\r
135 displayed on the portal surface is the view of the\r
136 misc_portal_camera that this entity targets. Also used for mirrors\r
137 (see Notes).\r
138 \r
139 \r
140 \r
141 <p><strong>Keys</strong>\r
142 \r
143 <br><b>target:</b> point this to a misc_portal_camera that "sees"\r
144 the view you want to display on the portal.\r
145 \r
146 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free\r
147 for all" and "Tournament" modes.\r
148 \r
149 <br><b>notteam:</b> when set to 1, entity will not spawn in\r
150 "Teamplay" and "CTF" modes.\r
151 \r
152 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single\r
153 Player mode (bot play mode).\r
154 \r
155 \r
156 \r
157 <p><strong>Notes</strong>\r
158 \r
159 <ul><li>The entity must be no farther than 64 units away from the portal\r
160 surface to lock onto it.\r
161 \r
162 <li>To make a mirror, apply the common/mirror shader to the surface,\r
163 place this entity near it but don't target a\r
164 misc_portal_camera.\r
165 \r
166 <li>When used as a mirror, the mirror surface will display what the\r
167 entity can "see."</ul>\r
168 \r
169 \r
170 \r
171 <p><div class = "subheading">misc_teleporter_dest</div>\r
172 \r
173 <b>Map Entity Color:</b> red\r
174 \r
175 <br><b>Dimensions:</b> (-32 -32 -24) (32 32 -16)\r
176 \r
177 <br><b>Game Function:</b> Teleport destination location point for\r
178 trigger_teleporter entities. A "target_position" can also be used\r
179 for this.\r
180 \r
181 \r
182 \r
183 <p><strong>Keys</strong>\r
184 \r
185 <br><b>angle:</b> direction in which player will look when\r
186 teleported.\r
187 \r
188 <br><b>targetname:</b> make the trigger_teleporter point to\r
189 this.\r
190 \r
191 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free\r
192 for all" and "Tournament" modes.\r
193 \r
194 <br><b>notteam:</b> when set to 1, entity will not spawn in\r
195 "Teamplay" and "CTF" modes.\r
196 \r
197 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single\r
198 Player mode (bot play mode).\r
199 \r
200 \r
201 \r
202 <p><strong>Notes</strong>\r
203 \r
204 <br>In most cases, this is replaced by the "target_position"\r
205 entity.\r
206 \r
207 <h2><a name = "path">Path_* Entities</a></h2>\r
208 \r
209 <p><div class = "subheading">path_corner</div>\r
210 \r
211 <b>Map Entity Color:</b> brown\r
212 \r
213 <br><b>Dimensions:</b> (-8 -8 -8) (8 8 8)\r
214 \r
215 <br><b>Game Function:</b> Path corner entity that define the routes\r
216 that func_trains can be made to follow.\r
217 \r
218 \r
219 \r
220 <p><strong>Keys</strong>\r
221 \r
222 <br><b>target:</b> point to next path_corner in the path.\r
223 \r
224 <br><b>targetname:</b> the train following the path or the previous\r
225 path_corner in the path points to this.\r
226 \r
227 <br><b>speed:</b> speed of func_train (in game units per second)\r
228 while moving to the next path corner. This will override the speed\r
229 value of the train.\r
230 \r
231 <br><b>wait:</b> number of seconds func_train will pause on path\r
232 corner before moving to next path corner (default 0 - see\r
233 Notes).\r
234 \r
235 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free\r
236 for all" and "Tournament" modes.\r
237 \r
238 <br><b>notteam:</b> when set to 1, entity will not spawn in\r
239 "Teamplay" and "CTF" modes.\r
240 \r
241 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single\r
242 Player mode (bot play mode).\r
243 \r
244 \r
245 \r
246 <p><strong>Notes</strong>\r
247 \r
248 <ul><li>Setting the wait key to -1 will not make the train stop on the\r
249 path corner, it will simply default to 0.\r
250 \r
251 <li>The center of the origin brush in the func_train follows the\r
252 path.</ul>\r
253 \r
254 \r
255 \r
256 <h2><a name = "shooter">Shooter_* Entities</a></h2>\r
257 \r
258 <div class = "subheading">shooter_grenade</div>\r
259 \r
260 <b>Map Entity Color:</b> red-violet\r
261 \r
262 <br><b>Dimensions:</b> (-8 -8 -8) (8 8 8)\r
263 \r
264 <br><b>Game Function:</b> This will shoot a grenade each time it's\r
265 triggered. Aiming is done by setting the "angles" key or by\r
266 targeting an info_notnull or target_position entity.\r
267 \r
268 \r
269 \r
270 <p><div class = "subheading">shooter_plasma</div>\r
271 \r
272 <b>Map Entity Color:</b> red-violet\r
273 \r
274 <br><b>Dimensions:</b> (-8 -8 -8) (8 8 8)\r
275 \r
276 <br><b>Game Function:</b> This will shoot a plasma ball each time\r
277 it's triggered. Aiming is done by setting the "angles" key or by\r
278 targeting an info_notnull or target_position entity.\r
279 \r
280 \r
281 \r
282 <p><div class = "subheading">shooter_rocket</div>\r
283 \r
284 <b>Map Entity Color:</b> red-violet\r
285 \r
286 <br><b>Dimensions:</b> (-8 -8 -8) (8 8 8)\r
287 \r
288 <br><b>Game Function:</b> This will shoot a rocket each time it's\r
289 triggered. Aiming is done by setting the "angles" key or by\r
290 targeting an info_notnull or target_position entity.\r
291 \r
292 \r
293 \r
294 <p><strong>Keys</strong>\r
295 \r
296 <br><b>angles:</b> this sets the pitch and yaw aiming angles of\r
297 shooter (default 0 0). The roll angle does not apply.\r
298 \r
299 <br><b>targetname:</b> activating trigger points to this.\r
300 \r
301 <br><b>target:</b> this points to a target_position entity for\r
302 aiming the grenades.\r
303 \r
304 <br><b>random:</b> random aiming variance in degrees from the\r
305 straight line to the targeted entity (default 0 - see Notes).\r
306 \r
307 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free\r
308 for all" and "Tournament" modes.\r
309 \r
310 <br>notteam: when set to 1, entity will not spawn in "Teamplay" and\r
311 "CTF" modes.\r
312 \r
313 <br>notsingle: when set to 1, entity will not spawn in Single Player\r
314 mode (bot play mode).\r
315 \r
316 \r
317 \r
318 <p><strong>Notes</strong>\r
319 \r
320 <ul><li>When the random key is set, its value is used to calculate a\r
321 maximum angle deviation from the normal trajectory formed by a\r
322 straight line between the shooter and the aiming entity it targets.\r
323 The final trajectory will be a random value anywhere between no\r
324 deviation at all (0) to maximum deviation (value of the random\r
325 key).\r
326 \r
327 <li>Both the setting "angles" key or "targeting a target_position"\r
328 methods can be used to aim the shooter. However, the\r
329 target_position method is simpler.*/</ul>\r
330 <p align = "center"><a href = "appn_b_5.htm">Back</a> | <a href = "../index.htm">Home</a> | <a href = "appn_b_7.htm">Next</a>\r
331 </body>\r
332 </html>\r