Revision as of 17:25, 29 March 2013

The Entity Documentation Project is a joint project to complete all the documentation linked through the Entity guide in a cohesive fashion.

Known Participants

Currently the following users are participating in this project:

Article Layout

If you're comfortable with wiki editing just follow the style of the articles that exist, the monster_shalrath, func_button and func_door articles are excellent examples. If you're not, you could copy the below article template and insert the necessary information where it is needed. Alternatively, simply adding the relevant data for someone else to format later is still helpful. Also, even if you don't have ALL the data, some data is better than no data, so feel free to fill in bits of a page, or make modifications to the existing data if you know that it is incorrect.

A bit about the Infobox_entity code near the start:

Delete the commonname field if the entity does not have a common name. An example of a common name is Vore, which is the common name of monster_shalrath. Vore also has a wiki page, so in this case, it would be linked. An entity with no common name would be info_null, or ambient_drone.

Also delete the precache field if the entity does not precache any models or sounds. You can find out if anything is precached by looking in the entity's qc file (usually near the bottom).

{{DISPLAYTITLE:entity_name}}

{{Infobox_entity
| classname = entity_name
| commonname = Entity
| type = point
| class = [[Entity (entity class)|entity]]
| dimensions = X x Y x Z
| quakec = [[entity.qc]]
| precaches =
* list precached
* models and sounds
* here. Otherwise
* leave empty
}}

The '''entity_name''' is a blah blah blah; basic entity information goes here.

== Usage ==
The [[Entity name tutorial]] article has some examples of the creation and use of this entity.

You might want to add a link to a more detailed article or tutorial, but for some entities the information can be added right here.

== Attributes ==
Some basic information about the entity's use of attributes goes here, such as how it uses an angle given to it.

=== Keys ===
{| class="wikitable" width="100%"
|-
| ! bgcolor="#eeeeee" width="100px" | ''targetname'' |
| The targetname of the Entity.
|-
| ! bgcolor="#eeeeee" | ''target''
| The entity to be triggered when the entity is activated / killed / insert whatever is appropriate.
|-
| ! bgcolor="#eeeeee" | ''example_key'' 
| You can keep adding more keeps like this
|}

===Spawnflags===
The entity_name entity supports the following [[Entity#Spawnflags|spawnflags]]:
{| class="wikitable" width="100%"
! width="50" | Flag
! width="150" | Common Name
! Description
|-
| flag #
| flag name in editor (TrenchBroom is ideal)
| Description of flag effects
|}

It also supports the standard spawnflags for difficulty and deathmatch presence.
{{Template:Mode_spawnflags
| entity = The Entity
}}

==Definitions==

===FGD Definition===
This is the format used by [[TrenchBroom]] and [[Worldcraft]]. Note that the model(...) parameter is not supported by Worldcraft. This does not include the base class definition, which may also be required.
<pre>
[ code from entity entry in an .fgd file goes in here ]
</pre>
===DEF Definition===
This is the definition format used for most old Quake editors, including the original [[QuakeEd]].
<pre>
[ code from entity entry in a .def file goes in here ]
</pre>

[[Category:Quake entities]]

If copied to a new page, the above markup should look like the below for you to begin editing.

entity_name

entity_name
(Entity)

Entity type	point
Entity class	entity
Dimensions	X x Y x Z
Quake-C	entity.qc
Precaches	* list precached models and sounds here. Otherwise leave empty

The entity_name is a blah blah blah; basic entity information goes here.

Usage

The Entity name tutorial article has some examples of the creation and use of this entity.

You might want to add a link to a more detailed article or tutorial, but for some entities the information can be added right here.

Attributes

Some basic information about the entity's use of attributes goes here, such as how it uses an angle given to it.

Keys

targetname \|	The targetname of the Entity.
target	The entity to be triggered when the entity is activated / killed / insert whatever is appropriate.
example_key	You can keep adding more keeps like this

Spawnflags

The entity_name entity supports the following spawnflags:

Flag	Common Name	Description
flag #	flag name in editor (TrenchBroom is ideal)	Description of flag effects

It also supports the standard spawnflags for difficulty and deathmatch presence.

Flag	Common Name	Description
256	Not on Easy	The Entity will not spawn on Easy difficulty.
512	Not on Normal	The Entity will not spawn on Normal difficulty.
1024	Not on Hard	The Entity will not spawn on Hard difficulty.
2048	Not in Deathmatch	The Entity will not spawn in Deathmatch mode.

Definitions

FGD Definition

This is the format used by TrenchBroom and Worldcraft. Note that the model(...) parameter is not supported by Worldcraft. This does not include the base class definition, which may also be required.

[ code from entity entry in an .fgd file goes in here ]

DEF Definition

This is the definition format used for most old Quake editors, including the original QuakeEd.

[ code from entity entry in a .def file goes in here ]

Difference between revisions of "Quake Wiki:Entity documentation project"

From Quake Wiki