Types/Order: Difference between revisions
m (grammar) |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
== Basic == | == Basic == | ||
The order property is a '''simple''' [[Types/string|string]]. When the game needs to sort prototypes, it looks at their order properties and sorts those alphabetically. | The order property is a '''simple''' [[Types/string|string]]. When the game needs to sort prototypes, it looks at their order properties and sorts those alphabetically. A prototype with an order string of "a" will be listed before other prototypes with order string "b" or "c". The "-" or "[]" structures that can be found in vanilla order strings ''do not'' have any special meaning. | ||
== Advanced == | == Advanced == |
Revision as of 19:24, 6 September 2018
Basic
The order property is a simple string. When the game needs to sort prototypes, it looks at their order properties and sorts those alphabetically. A prototype with an order string of "a" will be listed before other prototypes with order string "b" or "c". The "-" or "[]" structures that can be found in vanilla order strings do not have any special meaning.
Advanced
When the game compares 2 prototypes (of the same type) if the order strings aren't equal they're lexicographically compared to determine if a given prototype is shown before or after another. When the order strings are equal the game then falls back to comparing the prototype names to determine order.
Examples
Two item prototypes
The second item is shown before the first one (in the crafting grid/inventory etc)
{
type = "item",
name = "item-1",
order = "ad",
},
{
type = "item",
name = "item-2",
order = "ab",
},
Some sorted strings
Using a UTF-8 character list, the sort order of special characters can identified, here the sort order for common characters:
- "-"
- "0"
- "9"
- "A"
- "Z"
- "["
- "]"
- "a"
- "z"
Example using the above ordering:
- "a"
- "ab"
- "azaaa" (
b
is sorted beforez
, so "ab" comes before "az", regardless of the rest of the letters after "az") - "b"
- "b-zzzz"
- "b[aaaa]" (
[
is sorted after-
in UTF-8) - "bb" (
b
is sorted after[
in UTF-8)