Source Entities:Entity pages/BB

From Source Entities
Jump to navigation Jump to search
Source Entities:Entity pages/B

This is everything that should end up on entity pages. See worldspawn for a reference.

Title[edit source]

The title of the page should obviously match the entity classname, as close as the wiki software allows. The first letter of the page will always be changed into a capital, and underscores will get turned into spaces. Template:Entity will do the job of lowercasing and adding underscores back, for the title at the top.

If an entity is in two games but are significantly different, add /<game> at the end. For example:

  • weapon_pistol/Left 4 Dead
  • weapon_pistol/Half-Life 2

The /game part won't appear once Template:Entity is added. This applies to all entities, for game engines. Do not ever have a page that covers both Source and GoldSrc.

Top area[edit source]

Use Template:Entity or Template:Entitygs to add the "entity is a brush or point entity in games" message. If the template does not make it immediately clear which games have the entity, add Template:Gamelistbox or Template:Gamelistboxgs to clear it up.

The next part should be a general description of the entity. If the description is quite long, put it in an Entity Description header.

List the code classes that apply to this entity with Template:Classbox. See that page for more info on using it. If you don't know the code class, put Class unknown in this spot. On this subject, the code class should redirect to the classname page!

ConVars/Commands[edit source]

List console variables and console commands with Template:Varcom. The easiest way to find these is to search for the macros (ConVar, ConCommand, rarely CON_COMMAND) in the cpp file. The find console command is also very helpful. Be aware that the default values for convars in a cpp may be overridden in one of the game's many config files, so definitely check the console directly if a default value seems odd.

Keyvalues, inputs, outputs, flags[edit source]

Add keyvalues, inputs, and outputs with Template:KIO. Add flags with Template:Fl. They should all be in this order:

  1. Flags
  2. Keyvalues
  3. Inputs
  4. Outputs