dfhack/docs/builtins/sc-script.rst

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

.. dfhack-tool::
    :summary: Run commands when game state changes occur.
    :tags: dfhack

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.

Example
-------

``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			`=========`
move builtin docs to individual files 2022-07-18 11:58:35 -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::`
			`:summary: Run commands when game state changes occur.`
revise tag list and assignments 2022-08-12 00:34:37 -06:00			`:tags: dfhack`
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
			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
make Usage a proper header 2022-08-17 23:42:02 -06:00			`Usage`
			`-----`
move builtin docs to individual files 2022-07-18 11:58:35 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -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 all docs I've done so far to new standards 2022-07-23 17:03:40 -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 all docs I've done so far to new standards 2022-07-23 17:03:40 -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
update all docs I've done so far to new standards 2022-07-23 17:03:40 -06:00			`Example`
			`-------`
update sc-script docs based on code spelunking 2022-07-18 12:10:56 -06:00
update all docs I've done so far to new standards 2022-07-23 17:03:40 -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.`