MCPcopy Create free account
hub / github.com/DFHack/dfhack / help

Function help

plugins/tiletypes.cpp:109–229  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

107}
108
109void help( color_ostream & out, std::vector<std::string> &commands, int start, int end)
110{
111 std::string option = commands.size() > size_t(start) ? commands[start] : "";
112 if (option.empty())
113 {
114 out << "Commands:" << std::endl
115 << " quit / q : quit" << std::endl
116 << " filter / f [options] : change filter options" << std::endl
117 << " paint / p [options] : change paint options" << std::endl
118 << " point / p : set point brush" << std::endl
119 << " range / r [w] [h] [z] : set range brush" << std::endl
120 << " block : set block brush" << std::endl
121 << " column : set column brush" << std::endl
122 << " run / (empty) : paint!" << std::endl
123 << std::endl
124 << "Filter/paint options:" << std::endl
125 << " Any: reset to default (no filter/paint)" << std::endl
126 << " Shape / sh / s: set tile shape information" << std::endl
127 << " Material / mat / m: set tile material information" << std::endl
128 << " Special / sp: set special tile information" << std::endl
129 << " Variant / var / v: set variant tile information" << std::endl
130 << " All / a: set the four above at the same time (no ANY support)" << std::endl
131 << " Designated / d: set designated flag (Only for filters)" << std::endl
132 << " Hidden / h: set hidden flag" << std::endl
133 << " Light / l: set light flag" << std::endl
134 << " Subterranean / st: set subterranean flag" << std::endl
135 << " Skyview / sv: set skyview flag" << std::endl
136 << " Aquifer / aqua: set aquifer flag" << std::endl
137 << " Autocorrect / ac: set autocorrect flag" << std::endl
138 << " Stone: paint specific stone material" << std::endl
139 << " Veintype: use specific vein type for stone" << std::endl
140 << "See help [option] for more information" << std::endl;
141 }
142 else if (option == "shape" || option == "s" ||option == "sh")
143 {
144 out << "Available shapes:" << std::endl
145 << " ANY" << std::endl;
146 FOR_ENUM_ITEMS(tiletype_shape,i)
147 {
148 out << " " << ENUM_KEY_STR(tiletype_shape,i) << std::endl;
149 }
150 }
151 else if (option == "material"|| option == "mat" ||option == "m")
152 {
153 out << "Available materials:" << std::endl
154 << " ANY" << std::endl;
155 FOR_ENUM_ITEMS(tiletype_material,i)
156 {
157 out << " " << ENUM_KEY_STR(tiletype_material,i) << std::endl;
158 }
159 }
160 else if (option == "special" || option == "sp")
161 {
162 out << "Available specials:" << std::endl
163 << " ANY" << std::endl;
164 FOR_ENUM_ITEMS(tiletype_special,i)
165 {
166 out << " " << ENUM_KEY_STR(tiletype_special,i) << std::endl;

Callers 2

runCommandMethod · 0.85
processCommandFunction · 0.85

Calls 3

FOR_ENUM_ITEMSFunction · 0.70
sizeMethod · 0.45
emptyMethod · 0.45

Tested by

no test coverage detected