Wizt::VScriptFunctor Struct Reference

Implementation of a function that may be called through a script interface. More...

#include </home/werner/origo/vish/ocean/plankton/VScript.hpp>

List of all members.

Public Member Functions

• virtual RefPtr< VScriptValue > call (const RefPtr< VScriptParameters > &V, const RefPtr< ValuePool > &VP)=0

  Call a functor relative to a Context.
  

• virtual RefPtr< VScriptParameters > describe () const =0

  Retrieve parameter description of a functor.
  

---

Detailed Description

Implementation of a function that may be called through a script interface.

The function is invoked via the call() member function. The functor also allows to retrieve information about how to call the function via the member function describe() which returns the desired parameter list.

A function may be polymorphic and behave differently depending on the provided argument types. Each argument comes with a list of possible types in the argument description. Upon function call, only one type is set.

Each argument is specified via a name. Instead of providing this full name, also aliases and shortcuts can be specified.

The return value of the function may be of different type, depending on the function's behaviour.

In any case all values are transported in the form of textual encodings within a string.

---

The documentation for this struct was generated from the following files:

• ocean/plankton/VScript.hpp
• ocean/plankton/VScript.cpp