Changeset 11673 for code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/luatb.h

Timestamp:

Dec 14, 2017, 4:04:14 PM (7 years ago)

Author:

kohlia

Message:

The ScriptableController should work now. A demo level called scriptableControllerTest exists as well.

File:

• code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/luatb.h (modified) (2 diffs)

code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/luatb.h

@@ -6 +6 @@
 struct lua_State;
 
-// Makes certain functions visible to lua while staying type-safe on the
-// C++ side.
+/**
+ * @brief Makes certain functions visible to lua while staying type-safe
+ * on the C++ side.
+ */
 template<typename ThisType, typename FunctionType>
 class LuaTB
 {
 public:
-    // Make a function visible to lua. If you want to make a function 'foo'
-    // visible, you should call it like this:
-    //
-    // LuaTB<decltype(foo)>::registerFunction<foo>( ... );
+    /**
+     * @brief Make a function visible to lua
+     * @param _this Pointer to the object that owns the function
+     * @param lua Pointer to the lua state
+     * @param name Name that will be visible to lua for this function
+     *
+     * Only class functions are supported, because that's  all we need at
+     * the moment. Extending it to support normal functions as well should
+     * be fairly easy, though.
+     *
+     * If you want to make a function 'Foo::bar' visible, you should call
+     * it like this (assuming no C++17 support):
+     *
+     * LuaTB<Foo, decltype(&Foo::bar)>::registerFunction<&Foo::bar>( ... );
+     */
     template<FunctionType func>
     static void registerFunction(ThisType *_this, lua_State *lua, std::string name);
@@ -21 +34 @@
 
 // We need to include all type-dependant template implementations, because the
-// compiler needs to know for which types it has to instantiate those
+// compiler needs to know for which types it has to instantiate those.
 #include "luatb.ipp"