Editor Entity Naming Conventions – Arma Reforger
Lou Montana (talk | contribs) m (Text replacement - " " to " ") |
Lou Montana (talk | contribs) m (Fix Wikipedia link) |
||
Line 53: | Line 53: | ||
'''{{Color|grey|Small}} Cyan {{Color|grey|Table}} - Broken''' | '''{{Color|grey|Small}} Cyan {{Color|grey|Table}} - Broken''' | ||
All names should be in {{ | All names should be in {{Link|https://en.wikipedia.org/wiki/Title_case}}. | ||
Also, ensure links to images are included in the String Editor so nomenclature can be checked by a native speaker. | |||
This is essential, as many assets are misnamed on our initial pass. | |||
{| class="wikitable" | {| class="wikitable" |
Latest revision as of 02:01, 24 February 2023
Localisation String Naming
The string naming conventions in Arma Reforger regarding Editor Entities goes as follows:
AR-EditableEntity_Beehive_01_Small_Blue_Name
Part | Followed by | Mandatory | Description |
---|---|---|---|
AR- | - | ![]() |
Code for the name of the project (AR = Arma Reforger, A4 = Arma 4, etc), separated from the next variable by a hyphen -. |
EditableEntity_ | _ | ![]() |
Always use EditableEntity for an in-game asset that is not a character, vehicle, weapon, or item of equipment. This variable should be followed by an underscore. |
Beehive_ | _ | ![]() |
Noun, pertaining to the entity. If the noun is two words, such as "Beer Bottle", it must be arranged in PascalCase (e.g "BeerBottle") and not be connected with underscores (e.g "Beer_Bottle"). |
01_ | _ | ![]() |
Number with a leading zero, allowing for the possibility of future variants. |
Small_ | _ | ![]() |
Defines the asset's size. |
Blue_ | _ | ![]() |
Defines the colour. |
Name | N/A | ![]() |
Finally, all names for Editor Entities end with the label 'Name', indicating their function in-game. |
Localisation Content Naming
The string naming conventions in Arma Reforger regarding Editor Entities goes as follows:
Small Cyan Table - Broken
All names should be in Title case. Also, ensure links to images are included in the String Editor so nomenclature can be checked by a native speaker. This is essential, as many assets are misnamed on our initial pass.
Part | Mandatory | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Small | ![]() |
Size. The first component in the name relates to the asset's size, which may be either:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Cyan | ![]() |
Colour This component relates to the asset's colour. It can be one of:
If the asset contains a myriad of colours, the prefix 'multi-colored' can be used. Try to avoid colours that are also materials, as this can be confusing (e.g., 'Ivory Crate' or 'Gold Container'). | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Table | ![]() |
Base Descriptor. This part is the most essential and complex. It must consist of at least a noun, but will often be preceded by an adjective. It may also be split by a preposition or conjunction, although prepositions should be avoided if grammatically possible. Note; any adjective relating to the state of the asset (e.g., 'Old', 'New', 'Rusted', 'Broken', 'Open', 'Closed') should be separated as a hyphenated adjective (see below).
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Broken | ![]() |
Adjectives. Finally, certain adjectives may be tacked to the end of the name via a hyphen.
This can be particularly useful for specification, where the noun of the base descriptor is not sufficient (e.g., 'Statue' > 'Statue - Soldier', 'Sign' > 'Sign - Slow Speed'). Common hyphenated adjectives can be taken from the list below. Assets where a pair of adjectives are needed should be divided by a comma and a space (e.g., - Old, Open), and should be ordered alphabetically except with non-permanent states, which should always be last (e.g., 'Open', 'Closed', 'Locked', 'Unlocked', 'On', 'Off', etc.).
|
See Also
- Localisation plugin, accessible in Resource Manager with Ctrl + Alt + L