dfhack/docs/builtins/sc-script.rst

sc-script
=========

Tags: `tag/system`
:dfhack-keybind:`sc-script`

:index:`Run commands when game state changes occur.
<sc-script; Run commands when game state changes occur.>` This is similar to
the static `init-files` but is slightly more flexible since it can be set
dynamically.

Usage:

- ``sc-script [help]``
    Show the list of valid event names.
- ``sc-script list [<event>]``
    List the currently registered files for all events or the specified event.
- ``sc-script add|remove <event> <file> [<file> ...]``
    Register or unregister a file to be run for the specified event.

Examples
--------

- ``sc-script add SC_MAP_LOADED spawn_extra_monsters.init``
    Registers the ``spawn_extra_monsters.init`` file to be run whenever a new
    map is loaded.
move builtin docs to individual files 2022-07-18 11:58:35 -06:00			`sc-script`
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			`=========`

use a label instead of a custom role since I can't seem to figure out how to inject a link to a label via the role processing code 2022-07-22 16:16:57 -06:00			Tags: `tag/system`
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			:dfhack-keybind:`sc-script`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
enable index building and update builtin docs 2022-07-22 00:21:56 -06:00			:index:`Run commands when game state changes occur.
			<sc-script; Run commands when game state changes occur.>` This is similar to
			the static `init-files` but is slightly more flexible since it can be set
			`dynamically.`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00			`Usage:`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00			- ``sc-script [help]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`Show the list of valid event names.`
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00			- ``sc-script list [<event>]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`List the currently registered files for all events or the specified event.`
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00			- ``sc-script add\|remove <event> <file> [<file> ...]``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			`Register or unregister a file to be run for the specified event.`
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00
reformat builtins and properly read tags 2022-07-20 00:01:25 -06:00			`Examples`
			`--------`
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00
			- ``sc-script add SC_MAP_LOADED spawn_extra_monsters.init``
spacing is important otherwise the usage and examples lists don't put the explanations on the next line 2022-07-18 12:16:05 -06:00			Registers the ``spawn_extra_monsters.init`` file to be run whenever a new
			`map is loaded.`