STARK: Updated descriptions of some debug commands

* Removed full stops from the last setence in `debugPrintf`s to unifty the style
* `dump` folder for `dumpArchive` must exist in location ResidualVM is launched from (e.g. $HOMEDIR)
* `dumpArchive` require not only name of the archive but (relative) path to it, e.g. `4f/04/04.xarc` instead of simply `04.xarc`
* Indicated to use `listInventory`  to get ids for `enableInventoryItem`
* `enableInventoryItem` incorrectly had description from `changeLocation`
* Indicated to use `listLocations`  to get ids for `changeLocation`
This commit is contained in:
Faalagorn 2018-06-03 13:46:46 +02:00 committed by GitHub
parent 4b0a4364d1
commit a08bb8d495
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -72,10 +72,10 @@ Console::~Console() {
bool Console::Cmd_DumpArchive(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Extract all the files from a game archive.\n");
debugPrintf("The destination folder, named 'dump', must exist.\n");
debugPrintf("Extract all the files from a game archive\n");
debugPrintf("The destination folder, named 'dump', must exist in location ResidualVM was launched from\n");
debugPrintf("Usage :\n");
debugPrintf("dumpArchive [archive name]\n");
debugPrintf("dumpArchive [path to archive]\n");
return true;
}
@ -415,9 +415,9 @@ bool Console::Cmd_ListInventory(int argc, const char **argv) {
bool Console::Cmd_EnableInventoryItem(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Enable a specific inventory item.\n");
debugPrintf("Enable a specific inventory item. Use listInventory to get an id\n");
debugPrintf("Usage :\n");
debugPrintf("changeLocation [level] [location]\n");
debugPrintf("enableInventoryItem [id]\n");
return true;
}
StarkGlobal->enableInventoryItem(atoi(argv[1]));
@ -472,7 +472,7 @@ bool Console::Cmd_ListLocations(int argc, const char **argv) {
bool Console::Cmd_ChangeLocation(int argc, const char **argv) {
if (argc != 3) {
debugPrintf("Change the current location.\n");
debugPrintf("Change the current location. Use listLocations to get ids\n");
debugPrintf("Usage :\n");
debugPrintf("changeLocation [level] [location]\n");
return true;
@ -488,7 +488,7 @@ bool Console::Cmd_ChangeLocation(int argc, const char **argv) {
bool Console::Cmd_ChangeChapter(int argc, const char **argv) {
if (argc != 2) {
debugPrintf("Change the current chapter.\n");
debugPrintf("Change the current chapter\n");
debugPrintf("Usage :\n");
debugPrintf("changeChapter [value]\n");
return true;
@ -503,7 +503,7 @@ bool Console::Cmd_ChangeChapter(int argc, const char **argv) {
bool Console::Cmd_Location(int argc, const char **argv) {
if (argc != 1) {
debugPrintf("Display the current location.\n");
debugPrintf("Display the current location\n");
debugPrintf("Usage :\n");
debugPrintf("location\n");
return true;
@ -518,7 +518,7 @@ bool Console::Cmd_Location(int argc, const char **argv) {
bool Console::Cmd_Chapter(int argc, const char **argv) {
if (argc != 1) {
debugPrintf("Display the current chapter.\n");
debugPrintf("Display the current chapter\n");
debugPrintf("Usage :\n");
debugPrintf("chapter\n");
return true;