update docs for changevein

develop
myk002 2022-07-20 13:24:27 -07:00
parent fae5f0635a
commit d3dd12c38f
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
2 changed files with 20 additions and 8 deletions

@ -1,10 +1,23 @@
changevein
==========
Changes material of the vein under cursor to the specified inorganic RAW
material. Only affects tiles within the current 16x16 block - for veins and
large clusters, you will need to use this command multiple times.
Example:
Tags:
:dfhack-keybind:
``changevein NATIVE_PLATINUM``
Convert vein at cursor position into platinum ore.
Changes the material of a mineral inclusion. You can change it to any incorganic
material RAW id. Note that this command only affects tiles within the current
16x16 block - for large veins and clusters, you will need to use this command
multiple times.
You can use the `probe` command to discover the material RAW ids for existing
veins that you want to duplicate.
Usage::
changevein <material RAW id>
Example
-------
- ``changevein NATIVE_PLATINUM``
Convert vein at cursor position into platinum ore.

@ -86,8 +86,7 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector <Plug
{
commands.push_back(PluginCommand("changevein",
"Changes the material of a mineral inclusion.",
df_changevein, false,
"Syntax: changevein <inorganic material ID>\n"));
df_changevein));
return CR_OK;
}