Types/Order: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (Protected "Types/Order": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
(Removed old prototype docs)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/Order.html https://lua-api.factorio.com/latest/types/Order.html]
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/Order.html https://lua-api.factorio.com/latest/types/Order.html]


This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
 
 
__NOTOC__
== 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. 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 two prototypes (of the same type) if the order strings aren't equal they're [[:Wikipedia:Lexicographical_order|lexicographically compared]] to determine if a given prototype is shown before or after another. If the order strings are equal then the game 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)
 
<syntaxhighlight lang="lua">{
    type = "item",
    name = "item-1",
    order = "ad",
  },
 
  {
    type = "item",
    name = "item-2",
    order = "ab",
  },</syntaxhighlight>
 
=== Some sorted strings ===
Using an UTF-8 character list, the sort order of special characters can be identified. This is the sort order for common characters:
* "-"
* "0"
* "9"
* "A"
* "Z"
* "["
* "]"
* "a"
* "z"
 
Example using the above ordering:
* "a"
* "ab"
* "azaaa" (<code>b</code> is sorted before <code>z</code>, so "ab" comes before "az", regardless of the rest of the letters after "az")
* "b"
* "b-zzzz"
* "b[aaaa]" (<code>[</code> is sorted after <code>-</code> in UTF-8)
* "bb" (<code>b</code> is sorted after <code>[</code> in UTF-8)

Latest revision as of 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/Order.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Types/Order&oldid=202598"