dfhack/docs/plugins/sort.rst

52 lines
1.0 KiB
ReStructuredText

2022-07-31 14:29:08 -06:00
sort
====
Tags:
:dfhack-keybind:`sort-items`
:dfhack-keybind:`sort-units`
2022-07-31 14:29:08 -06:00
Sort the visible item or unit list.
2022-07-31 14:29:08 -06:00
Usage::
2022-07-31 14:29:08 -06:00
sort-items <property> [<property> ...]
sort-units <property> [<property> ...]
2022-07-31 14:29:08 -06:00
Both commands sort the visible list using the given sequence of comparisons.
Each property can be prefixed with a ``<`` or ``>`` character to indicate
whether elements that don't have the given property defined go first or last
(respectively) in the sorted list.
2022-07-31 14:29:08 -06:00
Examples
--------
2022-07-31 14:29:08 -06:00
``sort-items material type quality``
Sort a list of items by material, then by type, then by quality
``sort-units profession name``
Sort a list of units by profession, then by name
2022-07-31 14:29:08 -06:00
Properties
----------
2022-07-31 14:29:08 -06:00
Items can be sorted by the following properties:
2022-07-31 14:29:08 -06:00
- ``type``
- ``description``
- ``base_quality``
- ``quality``
- ``improvement``
- ``wear``
- ``material``
2022-07-31 14:29:08 -06:00
Units can be sorted by the following properties:
2022-07-31 14:29:08 -06:00
- ``name``
- ``age``
- ``arrival``
- ``noble``
- ``profession``
- ``profession_class``
- ``race``
- ``squad``
- ``squad_position``
- ``happiness``