MetzNet
/
dfhack
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Corrects a regression in skeleton.cpp documentation

develop
Josh Cooper 2021-07-24 20:48:30 -07:00 committed by Myk
parent 051e891680
commit 79e2188a5f
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
plugins/skeleton/skeleton.cpp
Unescape Escape View File

@ -19,13 +19,14 @@
using namespace DFHack; using namespace DFHack;
using namespace df::enums; using namespace df::enums;
// A plugin must be able to return its name and version. // Expose the plugin name to the DFHack core, as well as metadata like the DFHack version.
// The name string provided must correspond to the filename - // The name string provided must correspond to the filename -
// skeleton.plug.so, skeleton.plug.dylib, or skeleton.plug.dll in this case // skeleton.plug.so, skeleton.plug.dylib, or skeleton.plug.dll in this case
DFHACK_PLUGIN("skeleton"); DFHACK_PLUGIN("skeleton");
// A plugin can have a state which can be used to manage how the plugin operates. // The identifier declared with this macro (ie. enabled) can be specified by the user
// The state is referred to by this the identifier provided to the macro. eg. `enabled` // and subsequently used to manage the plugin's operations.
// This will also be tracked by `plug`; when true the plugin will be shown as enabled.
DFHACK_PLUGIN_IS_ENABLED(enabled); DFHACK_PLUGIN_IS_ENABLED(enabled);
// Any globals a plugin requires (e.g. world) should be listed here. // Any globals a plugin requires (e.g. world) should be listed here.