Half-Life Entity Guide - Style Guide Last edited 3 months ago2024-09-03 13:13:51 UTC

To help keep the style of the entity guide pages consistent and clear, here is a template layout you can use when editing and updating these pages. (This is modeled after the style I have been using when updating these pages, so many pages are already using this style.)

[cat:Entity Guides]
[cat:Half-Life Entity Guide]

== entity_name - [[Point Entity]] or [[Brush Entity]]

A concise description of the entity goes here. Keep this section down to simple overview of what the entity does. Use wiki links wherever seems appropriate, sticking to the Wikipedia style of linking with the first mention of a thing.

=== Attributes

* *Attribute Name (/keyname/)* - A description of the attribute. Try to keep the order of the attributes accurate to how they appear in Hammer, and make sure the name and keyname are spelled correctly.
* *Attribute 2 (/keyname2/)* - If the attribute has appears in a similar capacity on another already updated page, consider copying it from there to keep the wording and formatting consistent. If you need to write an example, do it as so. (/Example: This is an example./)
* *Attribute 3 (/keyname3/)* - When an attribute has a drop-down list of options, detail them as so.
** /Option 1 (keyvalue)/ - Brief description of option.
** /Option 2 (keyvalue2)/ - If an option or attribute seems to have no effect, write: /Seemingly unused./
** /(keyvalue3)/ - If such a list has a functional value that does not have a corresponding option in the list, you should include it.

=== Flags

* *Flag 1 (1)* - Brief description of what the flag does if turned on (and if turned off, if relevant).
* *Flag 2 (2)* - I'm not super sure what the numbers on the flags are, but if the wiki page already has them, better include them just in case.

=== Notes

* Include any other relevant information here. Use this to detail information that does not particularly belong in any other section, or to detail quirks of the entity that aren't always relevant but may be of interest or importance.
* If an entity is made redundant by another entity (or another entity does a very similar job), be sure to direct readers to the entity they should be using here. Links to other entity guide pages should be done in a form like this: [[env_sound]].
* Be sure to consult the Formatting Help link if you need it at any time.

=== Example Maps

If there are example maps that are particularly relevant to the entity at hand — and you feel they are worth including — place links to them in this section. For example:

%%columns=6:6
[vault:5708]
%%
[vault:5723]
%%

Here's how the above looks with formatting.

---

entity_name - Point Entity or Brush Entity

A concise description of the entity goes here. Keep this section down to simple overview of what the entity does. Use wiki links wherever seems appropriate, sticking to the Wikipedia style of linking with the first mention of a thing.

Attributes

• Attribute Name (keyname) - A description of the attribute. Try to keep the order of the attributes accurate to how they appear in Hammer, and make sure the name and keyname are spelled correctly.
• Attribute 2 (keyname2) - If the attribute has appears in a similar capacity on another already updated page, consider copying it from there to keep the wording and formatting consistent. If you need to write an example, do it as so. (Example: This is an example.)
• Attribute 3 (keyname3) - When an attribute has a drop-down list of options, detail them as so.
  • Option 1 (keyvalue) - Brief description of option.
  • Option 2 (keyvalue2) - If an option or attribute seems to have no effect, write: Seemingly unused.
  • (keyvalue3) - If such a list has a functional value that does not have a corresponding option in the list, you should include it.

Flags

• Flag 1 (1) - Brief description of what the flag does if turned on (and if turned off, if relevant).
• Flag 2 (2) - I'm not super sure what the numbers on the flags are, but if the wiki page already has them, better include them just in case.

Notes

• Include any other relevant information here. Use this to detail information that does not particularly belong in any other section, or to detail quirks of the entity that aren't always relevant but may be of interest or importance.
• If an entity is made redundant by another entity (or another entity does a very similar job), be sure to direct readers to the entity they should be using here. Links to other entity guide pages should be done in a form like this: env_sound.
• Be sure to consult the Formatting Help link if you need it at any time.

Example Maps

If there are example maps that are particularly relevant to the entity at hand — and you feel they are worth including — place links to them in this section. For example:

---

To see a couple of live examples, see aiscripted_sequence, ambient_generic, and env_message.