Hosting and domain costs until October 2024 have been generously sponsored by dumptruck_ds. Thank you!

Editing Entity guide

From Quake Wiki

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{DISPLAYTITLE:Entity Guide}}
+
Here is a good site to grab the info to fill these pages with: http://web.archive.org/web/20040607020324/http://www.annihilator.com/gameediting/quake/editing/editing_lvlentities.html
{| style="border-top:1px solid #FF0000; border-right:1px solid red; border-bottom:2px solid red; border-left:1px solid red; background:yellow;"
+
 
|The Entity Guide is currently the focus of a Quake Wiki project. See more information (including style guidelines) on the [[Quake Wiki:Entity documentation project|Entity Doc Project page]].
+
==Entity Settings==
|}
+
===Key/Value Pairs===
 +
A key/value pair is the name given to a single entity parameter; The key is the name of the parameter and the value is what it is set to. For example, a [[func_door]] entity has a parameter that sets how fast it moves. The key is named "speed" and it's value can be set by the user to alter the speed of the door. For the purposes of this wiki, we will use the format (key : value) as notation for key/value pairs in text passages. (speed : 100) would mean the speed parameter of the door would be set to 100 [[units]] per second.
  
'''Note from the old wiki: Here is a good site to grab the info to fill these pages with: http://web.archive.org/web/20040607020324/http://www.annihilator.com/gameediting/quake/editing/editing_lvlentities.html'''
+
Note that sometimes the naming of keys is not particularly intuitive, so some editors hide the real key name and show the user something more easily understood. The names used in the wiki are the actual key names used by Quake, and are correct.
* I did not say this, above link and test is from the original wiki. Do NOT copy and paste from non-free licensed sources. [[User:Spirit|Spirit]] ([[User talk:Spirit|talk]])
 
  
----
+
===Spawnflags===
 +
Spawnflags is the name given to a particular key that all entities support and is used to store multiple boolean parameters (flags) in a single key/value pair. The value of spawnflags is a number typically between 0 and 4096 and is calculated by adding the values given to each flag together. The value for any single flag is always a power of two. This is so that when loading a level, Quake can understand from the value of spawnflags which flags were set and which were not.
  
This is a list of all the [[Entity|entities]] in standard ([[vanilla_quake|vanilla]]) Quake. For information on entities used in specific [[mod|mods]], please see the relevant mod page.
+
One of the uses of spawnflags is to tell Quake whether or not to spawn entities into the level on level load. These flags are listed below:
 +
{| class="wikitable"
 +
|-
 +
! Flag !! Common Name
 +
|-
 +
| 256 || Not on Easy
 +
|-
 +
| 512 || Not on Normal
 +
|-
 +
| 1024 || Not on Hard
 +
|-
 +
| 2048 || Not in Deathmatch
 +
|}
 +
Other flags are only valid when used with certain entities, but these four are universal and work with every entity.
  
'''NOTE:''' When placing entities in your map, remember to account for 1 unit spacing around the entity; because the engine checks for collision in a >= way (as opposed to >). E.g. Monsters have to be at least 1 unit away from walls to avoid getting stuck and have to be on platforms at least 2 units wider to avoid falling off.  Also, narrow pathways will be very difficult for monsters to move into because the checks (for movement) are done in discreet steps.  
+
Most [[level editors]] have a simple visual representation of spawnflags with checkboxes for each flag, so that the user does not need to calculate its value manually.
  
 
==Entities==
 
==Entities==
'''Worldspawn'''
 
 
* [[worldspawn]]
 
* [[worldspawn]]
'''Info'''
 
 
* [[info_player_start]]
 
* [[info_player_start]]
* [[info_player_start2]]
 
 
* [[info_player_deathmatch]]
 
* [[info_player_deathmatch]]
 
* [[info_player_coop]]
 
* [[info_player_coop]]
* [[info_teleport_destination]]
+
* [[info_player_start2]]
 +
* [[info_teleport destination]]
 +
* [[info_null]]
 +
* [[info_notnull]]
 
* [[info_intermission]]
 
* [[info_intermission]]
* [[info_notnull]]
 
* [[info_null]]
 
'''Items'''
 
 
* [[item_cells]]
 
* [[item_cells]]
 
* [[item_rockets]]
 
* [[item_rockets]]
Line 41: Line 52:
 
* [[item_key2]]
 
* [[item_key2]]
 
* [[item_sigil]]
 
* [[item_sigil]]
'''Weapons'''
 
 
* [[weapon_supershotgun]]
 
* [[weapon_supershotgun]]
 
* [[weapon_nailgun]]
 
* [[weapon_nailgun]]
Line 48: Line 58:
 
* [[weapon_rocketlauncher]]
 
* [[weapon_rocketlauncher]]
 
* [[weapon_lightning]]
 
* [[weapon_lightning]]
'''Monsters'''
 
 
* [[monster_army]]
 
* [[monster_army]]
 
* [[monster_dog]]
 
* [[monster_dog]]
Line 61: Line 70:
 
* [[monster_enforcer]]
 
* [[monster_enforcer]]
 
* [[monster_shalrath]]
 
* [[monster_shalrath]]
* [[Spawn#Entity_information|monster_tarbaby]]
+
* [[monster_tarbaby]]
 
* [[monster_fish]]
 
* [[monster_fish]]
 
* [[monster_oldone]]
 
* [[monster_oldone]]
 
* [[monster_zombie]]
 
* [[monster_zombie]]
'''Lights'''
 
 
* [[light]]
 
* [[light]]
 
* [[light_fluoro]]
 
* [[light_fluoro]]
Line 74: Line 82:
 
* [[light_flame_small_white]]
 
* [[light_flame_small_white]]
 
* [[light_torch_small_walltorch]]
 
* [[light_torch_small_walltorch]]
'''Sounds'''
+
* [[air_bubbles]]
 +
* [[event_lightning]]
 +
* [[misc_fireball]]
 +
* [[misc_explobox]]
 +
* [[misc_explobox2]]
 +
* [[trap_spikeshooter]]
 +
* [[trap_shooter]]
 
* [[ambient_drip]]
 
* [[ambient_drip]]
 
* [[ambient_drone]]
 
* [[ambient_drone]]
Line 84: Line 98:
 
* [[ambient_swamp2]]
 
* [[ambient_swamp2]]
 
* [[ambient_thunder]]
 
* [[ambient_thunder]]
'''Funcs'''
 
 
* [[func_door]]
 
* [[func_door]]
 
* [[func_door_secret]]
 
* [[func_door_secret]]
Line 90: Line 103:
 
* [[func_button]]
 
* [[func_button]]
 
* [[func_train]]
 
* [[func_train]]
 +
* [[path_corner]]
 
* [[func_plat]]
 
* [[func_plat]]
 +
* [[func_dm_only]]
 
* [[func_illusionary]]
 
* [[func_illusionary]]
 
* [[func_episodegate]]
 
* [[func_episodegate]]
 
* [[func_bossgate]]
 
* [[func_bossgate]]
'''Misc'''
 
* [[air_bubbles]]
 
* [[event_lightning]]
 
* [[misc_explobox]]
 
* [[misc_explobox2]]
 
* [[misc_fireball]]
 
* [[misc_noisemaker]]
 
* [[path_corner]]
 
* [[testplayerstart]]
 
* [[trap_shooter]]
 
* [[trap_spikeshooter]]
 
* [[viewthing]]
 
'''Triggers'''
 
 
* [[trigger_changelevel]]
 
* [[trigger_changelevel]]
 
* [[trigger_once]]
 
* [[trigger_once]]

Please note that all contributions to Quake Wiki are considered to be released under the GNU Free Documentation License 1.3 or later (see Quake Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)