Burnout Wiki:Format documentation specification: Difference between revisions
Burnout Wiki:Format documentation specification (view source)
Revision as of 05:57, 14 August 2022
, 1 year agoAdd naming conventions.
(Updated Unions section to be more verbose.) |
(Add naming conventions.) |
||
Line 16:
Formats should be documented with at least the top-level section ''Structures''. ''Unions'', ''Typedefs'' and ''Enumerations'' are optional top-level sections. Other top-level sections may be added as necessary.
Generally, individual structures, unions, typedefs, and enumerations are third-level sections while variants (such as 32 and 64 bit) are second-level or fourth-level. This is not strictly defined and all lower-level sections may be chosen at the editor's discretion.
Sections should be named the full name of the type with all namespaces included, e.g., BrnVehicle::GraphicsSpec. If the full name is unknown, use a name relevant to its purpose. Never title a section "unknown" unless the content's purpose is truly unknown.
== Page names ==
Page names should be plain English versions of the official format name, e.g., the page for GenericRwacWaveContent is titled Generic RWAC Wave Content. If the format name is unknown, use a name most relevant to its purpose.
= Structures =
Line 44 ⟶ 49:
The data type of the field. If the type is unknown, refer to [[#Choosing a data type | choosing a data type]].
If the type is known and is a structure, union, enumeration, or custom typedef, this should be a link to the relevant section. If the official documentation states it is a standard type but it is still used as an enumerated value or similar, leave the link in the Comments column in the style "See <nowiki>[[link]]</nowiki>".
This column may be left blank if the area is known to be undefined (padding).
Line 86 ⟶ 91:
The data type of the field. If the type is unknown, refer to [[#Choosing a data type | choosing a data type]].
If the type is known and is a structure, union, enumeration, or custom typedef, this should be a link to the relevant section. If the official documentation states it is a standard type but it is still used as an enumerated value or similar, leave the link in the Comments column in the style "See <nowiki>[[link]]</nowiki>".
This column may be left blank if the area is known to be undefined (padding).
| |||