dfhack/docs/plugins/spectate.rst

49 lines
1.4 KiB
ReStructuredText

spectate
========
2022-07-31 14:29:18 -06:00
.. dfhack-tool::
2022-09-03 12:18:46 -06:00
:summary: Automatically follow productive dwarves.
2022-08-12 00:34:37 -06:00
:tags: fort interface
2022-07-31 14:29:18 -06:00
2022-08-17 23:42:02 -06:00
Usage
-----
::
2022-07-31 14:29:18 -06:00
2022-09-03 12:18:46 -06:00
enable spectate
2022-10-23 11:40:23 -06:00
spectate set <setting> <value>
spectate enable|disable <feature>
2022-09-01 18:14:10 -06:00
2022-07-31 14:29:18 -06:00
2022-09-03 12:18:46 -06:00
When enabled, the plugin will automatically switch which dwarf is being
followed periodically, preferring dwarves on z-levels with the highest
job activity.
2022-10-12 15:40:21 -06:00
Changes to plugin settings will be saved per world. Whether the plugin itself
is enabled or not is not saved.
2022-09-01 18:14:10 -06:00
Examples
--------
``spectate``
2022-10-23 11:40:23 -06:00
The plugin reports its configured status.
2022-09-01 18:14:10 -06:00
``spectate enable auto-unpause``
2022-09-01 18:14:10 -06:00
Enable the spectate plugin to automatically dismiss pause events caused
by the game. Siege events are one example of such a game event.
2022-10-24 18:50:21 -06:00
``spectate set tick-threshold 50``
2022-09-03 12:18:46 -06:00
Set the tick interval the followed dwarf can be changed at back to its
default value.
2022-10-23 11:40:23 -06:00
Features
--------
:focus-jobs: Toggle whether the plugin should always be following a job. (default: disabled)
:auto-unpause: Toggle auto-dismissal of game pause events. (default: disabled)
:auto-disengage: Toggle auto-disengagement of plugin through player intervention while unpaused. (default: disabled)
2022-09-01 18:14:10 -06:00
2022-10-23 11:40:23 -06:00
Settings
2022-10-23 11:45:23 -06:00
--------
:tick-threshold: Set the plugin's tick interval for changing the followed dwarf.
2022-10-12 15:40:21 -06:00
Acts as a maximum follow time when used with focus-jobs enabled. (default: 50)