From d3dd12c38f8f7302a288c26c052415f2556c588f Mon Sep 17 00:00:00 2001 From: myk002 Date: Wed, 20 Jul 2022 13:24:27 -0700 Subject: [PATCH] update docs for changevein --- docs/plugins/changevein.rst | 25 +++++++++++++++++++------ plugins/changevein.cpp | 3 +-- 2 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/plugins/changevein.rst b/docs/plugins/changevein.rst index ad7ab3d54..f4871772e 100644 --- a/docs/plugins/changevein.rst +++ b/docs/plugins/changevein.rst @@ -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 + +Example +------- + +- ``changevein NATIVE_PLATINUM`` + Convert vein at cursor position into platinum ore. diff --git a/plugins/changevein.cpp b/plugins/changevein.cpp index 8612603fc..48a1e7325 100644 --- a/plugins/changevein.cpp +++ b/plugins/changevein.cpp @@ -86,8 +86,7 @@ DFhackCExport command_result plugin_init ( color_ostream &out, std::vector \n")); + df_changevein)); return CR_OK; }