update docs for mode

develop
myk002 2022-07-28 02:50:37 -07:00
parent b6f20ee61a
commit bcab483b57
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 29 additions and 14 deletions

@ -1,5 +1,8 @@
mode mode
==== ====
Tags:
:dfhack-keybind:`mode`
This command lets you see and change the game mode directly. This command lets you see and change the game mode directly.
.. warning:: .. warning::
@ -9,13 +12,27 @@ This command lets you see and change the game mode directly.
Not all combinations are good for every situation and most of them will Not all combinations are good for every situation and most of them will
produce undesirable results. There are a few good ones though. produce undesirable results. There are a few good ones though.
Examples: Usage:
``mode``
Print the current game mode.
``mode set``
Enter an interactive commandline menu where you can set the game mode.
Examples
--------
Scenario 1:
* You are in fort game mode, managing your fortress and paused.
* You switch to the arena game mode, *assume control of a creature* and then
* switch to adventure game mode.
You just lost a fortress and gained an adventurer.
Scenario 2:
* You are in fort game mode, managing your fortress and paused. * You are in fort game mode, managing your fortress and paused at the Esc menu.
* You switch to the arena game mode, *assume control of a creature* and then * You switch to the adventure game mode, assume control of a creature, then save or retire.
* switch to adventure game mode(1).
You just lost a fortress and gained an adventurer. Alternatively:
* You are in fort game mode, managing your fortress and paused at the esc menu. You just created a returnable mountain home and gained an adventurer.
* You switch to the adventure game mode, assume control of a creature, then save or retire.
* You just created a returnable mountain home and gained an adventurer.

@ -19,12 +19,10 @@ DFHACK_PLUGIN("mode");
DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands) DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <PluginCommand> &commands)
{ {
commands.push_back(PluginCommand( commands.push_back(PluginCommand(
"mode","View, change and track game mode.", "mode",
mode, true, "View, change and track game mode.",
" Without any parameters, this command prints the current game mode\n" mode,
" You can interactively set the game mode with 'mode set'.\n" true));
"!!Setting the game modes can be dangerous and break your game!!\n"
));
return CR_OK; return CR_OK;
} }