Changes between Version 2 and Version 3 of ScriptSystem

Timestamp:

09/27/07 21:09:00 (17 years ago)

Author:

art

Comment:

--

ScriptSystem

@@ -7 +7 @@
 A plugin does register itself by the engine and specify which kind of scripts it can handle. It can also register functions and methods with the engine, so that a call of any registered function will lead to call of the implementation of that function. Moreover due to the glue functionality of the engine's scripting system a globaly registered function can be accessed in different scripting languages by its proper name. For this a plugin, providing new scripting language, has to connect functions from the engine's script function database with the language interface it provides.
 
+To register any new global function in the engine one can use following code sample:
+{{{
 
+#include <nrEngine/nrEngine.h>
+
+using namespace nrEngine;
+
+
+class SomeClass
+{
+        // here we initialize our class
+        void init();
+
+        // We want to register this method in the engine
+        ScriptFunctionDef(someScriptFunction);
+};
+
+
+// Implementation of the registered function
+ScriptFunctionDec(SomeClass, someScriptFunction)
+{
+        // The function macro does provide us with a user defined parameters
+        SomeClass* class = ScriptEngine::parameter_cast<SomeClass* >(param[0]);
+
+        // return if a wrong number of arguments were passed
+        if (args.size() <= 1){
+                return ScriptResult(std::string("someClass.scriptFunc(arg1) : wrong parameter count"));
+        }
+
+        // do your stuff
+        ....
+       
+
+        // return empty result
+        return ScriptResult();
+}
+
+
+// Register new methods in the engine
+void SomeClass::init()
+{
+    // specify user defined parameters, in our case this is the pointer to our class
+    std::vector<ScriptParam> param;
+    param.push_back(this);
+
+    // register new functions
+    Engine::sScriptEngine()->add("someClass.scriptFunc", someScriptFunction, param);
+}
+
+
+// Release all registered functions
+SomeClass::~SomeClass()
+{
+    Engine::sScriptEngine()->del("someClass.scriptFunc");
+}
+
+}}}