Editor Entity Naming Conventions – Arma Reforger
Lou Montana (talk | contribs) (Page creation) |
Lou Montana (talk | contribs) m (Fix Wikipedia link) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{TOC|side}} | |||
== Localisation String Naming == | |||
The string naming conventions in {{armaR}} regarding Editor Entities goes as follows: | |||
'''{{Color|grey|AR-}}EditableEntity_{{Color|grey|Beehive_}}01_{{Color|grey|Small_}}Blue_{{Color|grey|Name}}''' | '''{{Color|grey|AR-}}EditableEntity_{{Color|grey|Beehive_}}01_{{Color|grey|Small_}}Blue_{{Color|grey|Name}}''' | ||
Line 22: | Line 24: | ||
| style="text-align: center" | {{hl|_}} | | style="text-align: center" | {{hl|_}} | ||
| style="text-align: center" | {{Icon|checked}} | | style="text-align: center" | {{Icon|checked}} | ||
| Noun, pertaining to the entity. If the noun is two words, such as | | 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_ | ! 01_ | ||
Line 46: | Line 48: | ||
== | == Localisation Content Naming == | ||
The string naming conventions in {{armaR}} regarding Editor Entities goes as follows: | |||
'''{{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" | |||
! Part | |||
! Mandatory | |||
! Description | |||
|- | |||
! Small | |||
| style="text-align: center" | {{Icon|unchecked}} | |||
| Size. The first component in the name relates to the asset's size, which may be either: | |||
* Miniature | * Miniature | ||
* Small | * Small | ||
Line 63: | Line 70: | ||
* Large | * Large | ||
* Massive | * Massive | ||
{{Feature|informative|"Miniature" should only be used when the asset is far smaller than it should be; as in a replica or model (e.g "Miniature Belfry").<br>Similarly, "Massive" should only be used for assets that are extraordinarily larger than normal.}} | |||
|- | |||
! Cyan | |||
= | | style="text-align: center" | {{Icon|unchecked}} | ||
| Colour This component relates to the asset's colour. It can be one of: | |||
{| class="wikitable" | {| class="wikitable" | ||
Line 118: | Line 122: | ||
| style="background-color: beige" | | | style="background-color: beige" | | ||
| style="background-color: tan" | | | style="background-color: tan" | | ||
| style="background-color: | | style="background-color: peachpuff" | | ||
| style="background-color: lime" | | | style="background-color: lime" | | ||
| style="background-color: olive" | | | style="background-color: olive" | | ||
Line 128: | Line 132: | ||
|} | |} | ||
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'). | 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').<br> | ||
When a colour combination is involved, it is acceptable to use the conjunction 'and' (e.g., Blue and Red). Precedence in such pairings should be alphabetical (e.g., Beige and Black, Tan and Teal, etc.). | When a colour combination is involved, it is acceptable to use the conjunction 'and' (e.g., Blue and Red). Precedence in such pairings should be alphabetical (e.g., Beige and Black, Tan and Teal, etc.). | ||
|- | |||
! Table | |||
= | | style="text-align: center" | {{Icon|checked}} | ||
| 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). | |||
This | |||
{| class="wikitable" | {| class="wikitable" | ||
Line 156: | Line 157: | ||
|} | |} | ||
|- | |||
! Broken | |||
| style="text-align: center" | {{Icon|unchecked}} | |||
| Adjectives. Finally, certain adjectives may be tacked to the end of the name ''via'' a hyphen. | |||
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'). | 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. | Common hyphenated adjectives can be taken from the list below. | ||
Line 168: | Line 168: | ||
{| class="wikitable" | {| class="wikitable" | ||
! Correct (permanent states) | ! Correct (permanent states) | ||
! Incorrect | ! Incorrect (temporary states) | ||
|- | |- | ||
| | | | ||
Line 185: | Line 185: | ||
* Closed | * Closed | ||
|} | |} | ||
|} | |||
== See Also == | |||
* Localisation plugin, accessible in [[Arma Reforger:Resource Manager|Resource Manager]] with {{Controls|Ctrl|Alt|L}} | |||
{{GameCategory|armaR|Modding|Guidelines|Assets}} | {{GameCategory|armaR|Modding|Guidelines|Assets}} |
Latest revision as of 01: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