Changeset 7186 for code/branches/consolecommands3/src/libraries/core/ConsoleCommand.cc

Timestamp:

Aug 19, 2010, 2:14:54 AM (14 years ago)

Author:

landauf

Message:

Moved ability to possess descriptions from Executor to ConsoleCommand, since no other executors use this feature. Also simplified this code a little by introducing a new shortcut in Language.h. XMLPort has to use a temporary solution for descriptions without Language support atm.

File:

• code/branches/consolecommands3/src/libraries/core/ConsoleCommand.cc (modified) (2 diffs)

code/branches/consolecommands3/src/libraries/core/ConsoleCommand.cc

@@ -29 +29 @@
 #include "ConsoleCommand.h"
 #include <cassert>
+
+#include "Language.h"
 
 namespace orxonox
@@ -71 +73 @@
             this->argumentList_.clear();
     }
+
+    ConsoleCommand& ConsoleCommand::description(const std::string& description)
+    {
+        this->description_ = std::string("ConsoleCommandDescription::" + this->name_ + "::function");
+        AddLanguageEntry(this->description_, description);
+        return (*this);
+    }
+
+    const std::string& ConsoleCommand::getDescription() const
+    {
+        return GetLocalisation_noerror(this->description_);
+    }
+
+    ConsoleCommand& ConsoleCommand::descriptionParam(unsigned int param, const std::string& description)
+    {
+        if (param < MAX_FUNCTOR_ARGUMENTS)
+        {
+            this->descriptionParam_[param] = std::string("ConsoleCommandDescription::" + this->name_ + "::param" + multi_cast<std::string>(param));
+            AddLanguageEntry(this->descriptionParam_[param], description);
+        }
+        return (*this);
+    }
+
+    const std::string& ConsoleCommand::getDescriptionParam(unsigned int param) const
+    {
+        if (param < MAX_FUNCTOR_ARGUMENTS)
+            return GetLocalisation_noerror(this->descriptionParam_[param]);
+
+        return this->descriptionParam_[0];
+    }
+
+    ConsoleCommand& ConsoleCommand::descriptionReturnvalue(const std::string& description)
+    {
+        this->descriptionReturnvalue_ = std::string("ConsoleCommandDescription::" + this->name_ + "::returnvalue");
+        AddLanguageEntry(this->descriptionReturnvalue_, description);
+        return (*this);
+    }
+
+    const std::string& ConsoleCommand::getDescriptionReturnvalue(int param) const
+    {
+        return GetLocalisation_noerror(this->descriptionReturnvalue_);
+    }
 }