Changeset 8402 in orxonox.OLD

Timestamp:

Jun 14, 2006, 5:10:53 PM (18 years ago)

Author:

snellen

Message:

added comments

Location:

branches/script_engine/src

Files:

• lib/script_engine/script_class.h (modified) (1 diff)
• world_entities/script_trigger.cc (modified) (5 diffs)

branches/script_engine/src/lib/script_engine/script_class.h

@@ -20 +20 @@
 #define CREATE_SCRIPTABLE_CLASS(CLASS_NAME, CLASS_ID, SCRIPT_METHODS) \
     tScriptClass<CLASS_NAME> global_##CLASS_NAME##_ScriptableClass(#CLASS_NAME, CLASS_ID, (new ScriptMethod)->SCRIPT_METHODS)
-
 
 

branches/script_engine/src/world_entities/script_trigger.cc

@@ -1 +1 @@
 //for testing
 #include "luaincl.h"
+
 #include "script_trigger.h"
 #include "class_list.h"
@@ -9 +10 @@
 
 
+/**
+ * Constructs a new ScriptTrigger.
+ * @param root the xml element to load the parameters from.
+ *
+ */
 ScriptTrigger::ScriptTrigger(const TiXmlElement* root)
 {
@@ -21 +27 @@
 }
 
+/**
+ * Deletes the ScriptTrigger.
+ * 
+ */
 ScriptTrigger::~ScriptTrigger()
 {
@@ -26 +36 @@
 }
 
+/**
+ * Reads the values from the tml element and sets them.
+ * @param root the xml element to load the parameters from.
+ *
+ */
 void ScriptTrigger::loadParams(const TiXmlElement* root)
 {
@@ -64 +79 @@
 
 
+/**
+ * Sets the target(a world entity) of the ScriptTrigger. If the distance between the target and this trigger is smaller than the radius, the script gets triggered.
+ * @param target The worldentity that the script supervises.
+ */
 void ScriptTrigger::setTarget(const std::string& target)
 {