2022-07-10 00:01:46 -06:00
|
|
|
spectate
|
|
|
|
|
========
|
2022-07-31 14:29:18 -06:00
|
|
|
|
2022-08-09 23:37:24 -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
|
|
|
|
|
disable spectate
|
|
|
|
|
spectate <option> <value>
|
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.
|
|
|
|
|
|
|
|
|
|
To set features that toggle between two states, use {0,1} to specify
|
|
|
|
|
which state the feature should be in. Anything else will take any positive
|
|
|
|
|
value.
|
2022-09-01 18:14:10 -06:00
|
|
|
|
|
|
|
|
Examples
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
``spectate``
|
2022-09-03 12:18:46 -06:00
|
|
|
The plugin reports its feature status.
|
2022-09-01 18:14:10 -06:00
|
|
|
|
|
|
|
|
|
2022-09-03 12:18:46 -06:00
|
|
|
``spectate auto-unpause 1``
|
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-09-03 12:18:46 -06:00
|
|
|
``spectate tick-interval 50``
|
|
|
|
|
Set the tick interval the followed dwarf can be changed at back to its
|
|
|
|
|
default value.
|
|
|
|
|
|
2022-09-01 18:14:10 -06:00
|
|
|
Options
|
|
|
|
|
-------
|
|
|
|
|
|
2022-09-03 12:18:46 -06:00
|
|
|
:no option: Show plugin status.
|
2022-09-03 18:02:57 -06:00
|
|
|
:tick-threshold: Set the plugin's tick interval for changing the followed dwarf.
|
|
|
|
|
Acts as a maximum wait time when used with focus-jobs.
|
2022-09-03 12:18:46 -06:00
|
|
|
:focus-jobs: Toggle whether the plugin should always be following a job.
|
|
|
|
|
:auto-unpause: Toggle auto-dismissal of game pause events.
|
|
|
|
|
:auto-disengage: Toggle auto-disengagement of plugin through player intervention.
|
