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

Quake Wiki:Entity documentation project

From Quake Wiki

Revision as of 21:30, 28 March 2013 by Hectate (talk | contribs) (updated to include project template)

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 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.

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.

== 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"
|-
| ! bgcolor="#eeeeee" width="80px" | ''targetname'' || The name of the entity. 
|-
| ! bgcolor="#eeeeee" | ''target'' || The targetname of the entity that will be triggered by this entity.
|-
| ! bgcolor="#eeeeee" | ''keyvaluename'' || Additional keyvalues and descriptions can be appended in this format.
|}

===Spawnflags===
The button supports [[Entity#Spawnflags|standard spawnflags]] for difficulty and deathmatch presence.
{| class="wikitable collapsible collapsed"
|-
! Flag !! Common Name
|-
| 256 || Not on Easy
|-
| 512 || Not on Normal
|-
| 1024 || Not on Hard
|-
| 2048 || Not in Deathmatch
|}
It also has the following additional flags enabled:
{| class="wikitable"
|-
! Flag !! Common Name !! Description
|-
| flag # || Some Name ||| Description of spawnflag
|}
[[Category:Quake entities]]

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


entity_name

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.

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 name of the entity.
target The targetname of the entity that will be triggered by this entity.
keyvaluename Additional keyvalues and descriptions can be appended in this format.

Spawnflags

The button supports standard spawnflags for difficulty and deathmatch presence.

It also has the following additional flags enabled:

Flag Common Name Description
flag # Some Name Description of spawnflag