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: | ||
| − | + | '''Note from Spirit: 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''' | |
| − | + | ||
| − | |The Entity | + | ---- |
| − | + | ||
| + | In [[Mapping|Quake map making]], an entity is any object defined in the [[map_file_format|.map file]] of a level, and can be divided into two types, point entities and solid entities. | ||
| + | |||
| + | A point entity is an entity that can be thought of as being at a specific point in the level, and its geometry (if any) is predefined. For example, a monster is a point entity. A level author might place many [[monster_ogre|ogres]] in their level, but each ogre will be the same shape and behave the same way because they are defined by the game already. | ||
| + | |||
| + | Solid entities, on the other hand, are entities which are made by the level author out of [[brush|brushes]] and can take any shape the author wishes. A [[func_door|door]], for example, is something that the level author needs to be able to make out of brushes in order to fit into different themes, different sized holes etc. | ||
| + | |||
| + | The static level geometry itself is also defined as a [[worldspawn]] entity, but it is a special entity that is treated differently by the [[Map_compiling|compilers]], and depending on the [[Mapping_tools#Level_Editors|level editor]] being used, its settings might be accessed from a different place to that of other entities. The worldspawn is always the first entity defined in a .map file. | ||
| + | |||
| + | ==Entity Settings== | ||
| + | In order to change their behaviour, appearance etc. all entities have settings that can be modfied by the level author. The following section contains general information about these settings. For specific entity setting information, see [[Entity_guide#Entities|Entities]]. | ||
| + | |||
| + | ===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 [[unit|units]] per second. | ||
| + | |||
| + | 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. | ||
| − | + | ===Origin and Angle=== | |
| − | + | Origin and angle are keys supported by every single entity with the exception of the [[worldspawn]], since it does not ever move and does not need them. Origin is used to define the position of an entity in the level, and angle is a value between 0 and 360 that sets its rotation. Both of these keys are usually hidden from direct editing by level editors; origin is almost always set only by moving the object around in the editor, and some editors (such as [[TrenchBroom]]) allow direct rotation of the entity to set the angle, wheras others (such as [[Worldcraft]]) have some kind of visual representation in their entity property editing tool as well as the ability to manually set the angle numerically. | |
| − | + | ===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. | ||
| − | + | 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. | ||
| − | + | Most [[Mapping_tools#Level_Editors|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]] | ||
| − | |||
* [[info_player_start]] | * [[info_player_start]] | ||
| − | |||
* [[info_player_deathmatch]] | * [[info_player_deathmatch]] | ||
* [[info_player_coop]] | * [[info_player_coop]] | ||
| − | * [[ | + | * [[info_player_start2]] |
| + | * [[info_teleport destination]] | ||
| + | * [[info_null]] | ||
| + | * [[info_notnull]] | ||
* [[info_intermission]] | * [[info_intermission]] | ||
| − | |||
| − | |||
| − | |||
* [[item_cells]] | * [[item_cells]] | ||
* [[item_rockets]] | * [[item_rockets]] | ||
| Line 41: | Line 67: | ||
* [[item_key2]] | * [[item_key2]] | ||
* [[item_sigil]] | * [[item_sigil]] | ||
| − | |||
* [[weapon_supershotgun]] | * [[weapon_supershotgun]] | ||
* [[weapon_nailgun]] | * [[weapon_nailgun]] | ||
| Line 48: | Line 73: | ||
* [[weapon_rocketlauncher]] | * [[weapon_rocketlauncher]] | ||
* [[weapon_lightning]] | * [[weapon_lightning]] | ||
| − | |||
* [[monster_army]] | * [[monster_army]] | ||
* [[monster_dog]] | * [[monster_dog]] | ||
| Line 61: | Line 85: | ||
* [[monster_enforcer]] | * [[monster_enforcer]] | ||
* [[monster_shalrath]] | * [[monster_shalrath]] | ||
| − | * [[ | + | * [[monster_tarbaby]] |
* [[monster_fish]] | * [[monster_fish]] | ||
* [[monster_oldone]] | * [[monster_oldone]] | ||
* [[monster_zombie]] | * [[monster_zombie]] | ||
| − | |||
* [[light]] | * [[light]] | ||
* [[light_fluoro]] | * [[light_fluoro]] | ||
| Line 74: | Line 97: | ||
* [[light_flame_small_white]] | * [[light_flame_small_white]] | ||
* [[light_torch_small_walltorch]] | * [[light_torch_small_walltorch]] | ||
| − | + | * [[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 113: | ||
* [[ambient_swamp2]] | * [[ambient_swamp2]] | ||
* [[ambient_thunder]] | * [[ambient_thunder]] | ||
| − | |||
* [[func_door]] | * [[func_door]] | ||
* [[func_door_secret]] | * [[func_door_secret]] | ||
| Line 90: | Line 118: | ||
* [[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]] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
* [[trigger_changelevel]] | * [[trigger_changelevel]] | ||
* [[trigger_once]] | * [[trigger_once]] | ||