dfhack/docs/plugins/sort.rst

sort
====

.. dfhack-tool::
    :summary: Sort lists shown in the DF interface.
    :tags: fort productivity interface
    :no-command:

.. dfhack-command:: sort-items
   :summary: Sort the visible item list.

.. dfhack-command:: sort-units
   :summary: Sort the visible unit list.

Usage::

    sort-items <property> [<property> ...]
    sort-units <property> [<property> ...]

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.

Examples
--------

``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

Properties
----------

Items can be sorted by the following properties:

- ``type``
- ``description``
- ``base_quality``
- ``quality``
- ``improvement``
- ``wear``
- ``material``

Units can be sorted by the following properties:

- ``name``
- ``age``
- ``arrival``
- ``noble``
- ``profession``
- ``profession_class``
- ``race``
- ``squad``
- ``squad_position``
- ``happiness``