docs/manual/Q3Rad_Manual/appndx/appn_b_1.htm

   1 <html>\r
   2 <head>\r
   3 <title>Q3Radiant Editor Manual: Appendix B1</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 This Section owes much of the background and testing research to three dedicated Quake Engine editing supporters, <i>Suicide20</i>, <i>inolen</i>, and <i>EuteTic</i>. It is based on version 1.1 (12/22/99) of a document that they created and gave us permission to include with the official id editor documents.\r
  11 \r
  12 <p>"Keys" are keywords that represent the in-game properties of an\r
  13 entity. Some are flags that determine whether an entity will\r
  14 appear in a particular game play mode. Others define extents or\r
  15 rates for entity movement. Others establish how much of some game\r
  16 effect will occur (example: damage) or how long to wait until an\r
  17 event occurs or can reoccur.\r
  18 \r
  19 \r
  20 \r
  21 <p>With the exception of properties that can be set by checkboxes,\r
  22 the map maker will need to type in keys (names for game function\r
  23 properties) and their values (numbers or strings) into fields\r
  24 within the entities window.\r
  25 \r
  26 \r
  27 \r
  28 <p>Keys that are set by checkboxes in the editor are called\r
  29 "Spawnflags" and will be shown in All Caps. The rest are shown in\r
  30 lowercase, as they should be typed into the editor field.\r
  31 \r
  32 \r
  33 \r
  34 <h2><a name = "basinfo">Basic Key information</a></h2>\r
  35 <b>Angle:</b> This is the direction of facing or direction of\r
  36 movement for an entity. Set this value with the Angle buttons on\r
  37 the entity window. The angle value can be typed in as any positive\r
  38 value between 1 and 360.\r
  39 \r
  40 \r
  41 \r
  42 <p><b>Color:</b> This key only affects md3 models that are built\r
  43 into func_entities. The color is the color of light used to\r
  44 illuminate the model. It is expressed as a normalized three\r
  45 digit RGB formula.\r
  46 \r
  47 \r
  48 \r
  49 <p><b>Entity Dimensions:</b> The minimum and maximum coordinate\r
  50 dimensions of the entity box.\r
  51 \r
  52 \r
  53 \r
  54 <p><b>Light:</b> This key only affects md3 models that are built\r
  55 into func_entities.\r
  56 \r
  57 \r
  58 \r
  59 <p><b>Map Entity Color:</b> This is the color of the generic entity\r
  60 box used to represent the entity in the map editor.\r
  61 \r
  62 \r
  63 \r
  64 <h2><a name = "ammo">Ammo_* Entities</a></h2>\r
  65 The properties for ammo entities are all very similar.\r
  66 \r
  67 <p><b>Map Entity Color:</b> Blue\r
  68 <br><b>Entity Dimensions:</b> (-16 -16 -16) (16 16 16)\r
  69 \r
  70 <p>These are ammunition boxes for weapons in the game. They can be\r
  71 represented by either a blue entity box, or the ammo box model\r
  72 itself. With the exception of the type and amount of ammo given to\r
  73 the player upon pick up, all ammo entities have the same\r
  74 properties.\r
  75 \r
  76 <p><div class = "subheading">ammo_bfg</div>\r
  77 <b>Game Function</b>: BFG ammo. Gives the player 15 shots by\r
  78 default.\r
  79 \r
  80 \r
  81 \r
  82 <p><strong>Custom Keys</strong>\r
  83 \r
  84 <br><b>count:</b> sets the amount of ammo given to the player when\r
  85 picked up (default 15).\r
  86 \r
  87 <p><div class = "subheading">ammo_bullets</div>\r
  88 \r
  89 <b>Game Function:</b> Machine Gun ammo. Gives the player 50\r
  90 shots by default.\r
  91 \r
  92 <p><strong>Custom Keys</strong>\r
  93 \r
  94 <br><b>count:</b> sets the amount of ammo given to the player when\r
  95 picked up (default 50).\r
  96 \r
  97 <p><div class = "subheading">ammo_cells</div>\r
  98 \r
  99 <b>Game Functions:</b> Plasma Gun ammo. Gives the player 30\r
 100 shots by default.\r
 101 \r
 102 \r
 103 \r
 104 <p><strong>Custom Keys</strong>\r
 105 \r
 106 <br><b>count:</b> sets the amount of ammo given to the player when\r
 107 picked up (default 30).\r
 108 \r
 109 <p><div class = "subheading">ammo_grenades</div>\r
 110 \r
 111 <b>Game Function:</b> Grenade Launcher ammo. Gives the player 5\r
 112 shots by default.\r
 113 \r
 114 \r
 115 \r
 116 <p><strong>Custom Keys</strong>\r
 117 \r
 118 <br><b>count:</b> sets the amount of ammo given to the player when\r
 119 picked up (default 5).\r
 120 \r
 121 <p><div class = "subheading">ammo_lightning</div>\r
 122 \r
 123 <b>Game Function:</b> Lightning Gun ammo. Gives the player 60\r
 124 shots by default.\r
 125 \r
 126 <p><strong>Custom Keys</strong>\r
 127 \r
 128 <br><b>count:</b> sets the amount of ammo given to the player when\r
 129 picked up (default 60).\r
 130 \r
 131 <p><div class = "subheading">ammo_rockets</div>\r
 132 <b>Game Function:</b> Rocket Launcher ammo. Gives the player 5\r
 133 shots by default.\r
 134 \r
 135 \r
 136 \r
 137 <p><strong>Custom Keys</strong>\r
 138 <br><b>count:</b> sets the amount of ammo given to the player when\r
 139 picked up (default 5).\r
 140 \r
 141 <p><div class = "subheading">ammo_shells</div>\r
 142 \r
 143 <b>Game Function:</b> Shotgun ammo. Gives the player 10 shots by\r
 144 default.\r
 145 \r
 146 \r
 147 \r
 148 <p><strong>Custom Keys</strong>\r
 149 <br><b>count:</b> sets the amount of ammo given to the player when\r
 150 picked up (default 10).\r
 151 \r
 152 <p><div class = "subheading">ammo_slugs </div>\r
 153 <b>Game Function:</b> Railgun ammo. Gives the player 10 shots by\r
 154 default.\r
 155 \r
 156 \r
 157 \r
 158 <p><strong>Custom Keys</strong>\r
 159 <br><b>count:</b> sets the amount of ammo given to the player when\r
 160 picked up (default 10).\r
 161 \r
 162 \r
 163 \r
 164 <p><strong>Common Keys</strong>\r
 165 <br><b>wait:</b> time in seconds before the item respawns after\r
 166 being picked up (default 40, -1 = never respawn).\r
 167 \r
 168 <br><b>random:</b> random time variance in seconds added or\r
 169 subtracted from "wait" delay (default 0 - see Notes).\r
 170 \r
 171 <br><b>team:</b> set this to team items. Teamed items will respawn\r
 172 randomly after team master is picked up (see Notes).\r
 173 \r
 174 <br><b>target:</b> picking up the item will trigger the entity this\r
 175 points to.\r
 176 \r
 177 <br><b>targetname:</b> a target_give entity can point to this for\r
 178 respawn freebies.\r
 179 \r
 180 <br><b>notbot:</b> when set to 1, a bot will never seek out this\r
 181 item\r
 182 \r
 183 <br><b>notfree:</b> when set to 1, entity will not spawn in "Free\r
 184 for all" and "Tournament" modes.\r
 185 \r
 186 <br><b>notteam:</b> when set to 1, entity will not spawn in\r
 187 "Teamplay" and "CTF" modes.\r
 188 \r
 189 <br><b>notsingle:</b> when set to 1, entity will not spawn in Single\r
 190 Player mode (bot play mode).\r
 191 \r
 192 \r
 193 \r
 194 <p><strong>Check Boxes/Spawnflags</strong>\r
 195 <br>SUSPENDED: item will spawn where it was placed in map and won't\r
 196 drop to the floor. Set by Checkbox. Bots will only be attracted to\r
 197 suspended entities if they are reachable by way of a jump pad or\r
 198 launch pad (trigger_push).\r
 199 \r
 200 \r
 201 \r
 202 <p><strong>Notes</strong>\r
 203 \r
 204 <br>The amount of time it takes for an item in the team to respawn\r
 205 is determined by the "wait" value of the item that was picked up\r
 206 previously. So if one of the items in the team has it's "wait" key\r
 207 set to -1 (never respawn), the random respawning cycle of the\r
 208 teamed items will stop after that item is picked up.\r
 209 \r
 210 \r
 211 \r
 212 <p>When the random key is set, its value is used to calculate a\r
 213 minimum and a maximum delay. The final time delay will be a random\r
 214 value anywhere between the minimum and maximum values: (min delay =\r
 215 wait - random) (max delay = wait + random).\r
 216 \r
 217 \r
 218 \r
 219 <p><div class = "tip"><strong>Design Notes</strong>\r
 220 \r
 221 <br>An ammo item can be given a negative "count" value. Taking away\r
 222 ammo in combat would be a bad idea but in combination with a\r
 223 target_give entity, it can be used to set up games mods like Rocket\r
 224 Arena by removing the machinegun ammunition from a player when he\r
 225 spawns into the map.</div>\r
 226 <p align = "center"><a href = "appn_a.htm">Back</a> | <a href = "../index.htm">Home</a> | <a href = "appn_b_2.htm">Next</a>\r
 227 </body>\r
 228 </html>\r