dfhack/docs/plugins/sort.rst

sort
====

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

The ``sort`` tool provides overlays that sorting and searching options for
lists displayed in the DF interface.

Searching and sorting functionality is provided by `overlay` widgets, and widgets for individual lists can be moved via `gui/overlay` or turned on or off via `gui/control-panel`.

Squad assignment overlay
------------------------

The squad assignment screen can be sorted by name, by migrant wave, by stress,
by various military-related skills or by long-term military potential.

If sorted by "any melee", then the citizen is sorted according to the highest
skill they have in axes, short swords, maces, warhammers, spears, or general
fighting.

If sorted by "any ranged", then the citizen is sorted according to the highest
skill they have in crossbows or general ranged combat.

If sorted by "leadership", then the citizen is sorted according to the highest
skill they have in leader, teacher, or military tactics.

If sorting is done by "mental stability" citizens are arranged based on their
mental stability rating. This rating is a measure that takes into account
facets and values of an individual and correlates to better stress values.
It is designed to be higher for more stress-resistant citizens.

If sorting is done by "solo combat potential" citizens are arranged based on their
solo combat potential rating. This rating is a measure that takes into
account genetic predispositions in physical and mental attributes, as
well as body size. Dwarves (and other humanoid creatures) with bigger rating
are expected to be more effective in melee combat against strong opponents.

If sorting is done by "group combat potential" citizens are arranged based on their
group combat potential rating. Similar with solo combat rating except this rating
taking into account efficiency in a fight against multiple opponents. This rating
is valid only for dwarves because it considers martial trance which only dwarves
are capable of.

If sorting is done by "ranged potential" citizens are arranged based on their
ranged potential rating. This rating is a statistical measure that takes into
account genetic predispositions in physical and mental attributes.
Dwarves (and other humanoid creatures) with bigger rating are expected to be
more effective in ranged combat.

You can search for a dwarf by name by typing in the Search field. You can also
type in the name of any job skill (military-related or not) and dwarves with
any experience in that skill will be shown. For example, to only see citizens
with military tactics skill, type in "tactics".

You can see all the job skill names that you can search for by running::

    :lua @df.job_skill

in `gui/launcher`.
update docs for sort 2022-07-31 14:29:08 -06:00			`sort`
			`====`
align remaining plugin docs to plugin names 2022-07-25 07:08:59 -06:00
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00			`.. dfhack-tool::`
update docs for sort 2023-08-14 18:28:32 -06:00			`:summary: Search and sort lists shown in the DF interface.`
			`:tags: fort productivity interface`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00			`:no-command:`

update docs for sort 2023-08-14 18:28:32 -06:00			The ``sort`` tool provides overlays that sorting and searching options for
			`lists displayed in the DF interface.`
migrate all docs to the new directives add a summary option for tools and commands so we can output them with their tags and keybindings at the top of the file. 2022-08-09 23:37:24 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			Searching and sorting functionality is provided by `overlay` widgets, and widgets for individual lists can be moved via `gui/overlay` or turned on or off via `gui/control-panel`.
align remaining plugin docs to plugin names 2022-07-25 07:08:59 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			`Squad assignment overlay`
			`------------------------`
make Usage a proper header 2022-08-17 23:42:02 -06:00
Update docs/plugins/sort.rst Co-authored-by: Myk <myk.taylor@gmail.com> 2023-08-29 01:59:28 -06:00			`The squad assignment screen can be sorted by name, by migrant wave, by stress,`
			`by various military-related skills or by long-term military potential.`
align remaining plugin docs to plugin names 2022-07-25 07:08:59 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			`If sorted by "any melee", then the citizen is sorted according to the highest`
			`skill they have in axes, short swords, maces, warhammers, spears, or general`
			`fighting.`
align remaining plugin docs to plugin names 2022-07-25 07:08:59 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			`If sorted by "any ranged", then the citizen is sorted according to the highest`
			`skill they have in crossbows or general ranged combat.`
align remaining plugin docs to plugin names 2022-07-25 07:08:59 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			`If sorted by "leadership", then the citizen is sorted according to the highest`
			`skill they have in leader, teacher, or military tactics.`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
Reworked fallback from rating sortings. Renamed melee potential to solo combat potential. Added group combat potential. 2023-08-27 08:52:09 -06:00			`If sorting is done by "mental stability" citizens are arranged based on their`
			`mental stability rating. This rating is a measure that takes into account`
			`facets and values of an individual and correlates to better stress values.`
			`It is designed to be higher for more stress-resistant citizens.`

			`If sorting is done by "solo combat potential" citizens are arranged based on their`
			`solo combat potential rating. This rating is a measure that takes into`
Changed melee and ranged ratings to statistically proven linear formulas. 2023-08-25 07:18:20 -06:00			`account genetic predispositions in physical and mental attributes, as`
			`well as body size. Dwarves (and other humanoid creatures) with bigger rating`
Reworked fallback from rating sortings. Renamed melee potential to solo combat potential. Added group combat potential. 2023-08-27 08:52:09 -06:00			`are expected to be more effective in melee combat against strong opponents.`

			`If sorting is done by "group combat potential" citizens are arranged based on their`
			`group combat potential rating. Similar with solo combat rating except this rating`
			`taking into account efficiency in a fight against multiple opponents. This rating`
			`is valid only for dwarves because it considers martial trance which only dwarves`
			`are capable of.`
Changed melee and ranged ratings to statistically proven linear formulas. 2023-08-25 07:18:20 -06:00
			`If sorting is done by "ranged potential" citizens are arranged based on their`
			`ranged potential rating. This rating is a statistical measure that takes into`
			`account genetic predispositions in physical and mental attributes.`
			`Dwarves (and other humanoid creatures) with bigger rating are expected to be`
			`more effective in ranged combat.`

update docs for sort 2023-08-14 18:28:32 -06:00			`You can search for a dwarf by name by typing in the Search field. You can also`
			`type in the name of any job skill (military-related or not) and dwarves with`
			`any experience in that skill will be shown. For example, to only see citizens`
			`with military tactics skill, type in "tactics".`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			`You can see all the job skill names that you can search for by running::`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			`:lua @df.job_skill`
split the plugin docs into individual files 2022-07-10 00:01:46 -06:00
update docs for sort 2023-08-14 18:28:32 -06:00			in `gui/launcher`.