Script running in a plugin. More...
#include <ObjectScript.hpp>
Inheritance diagram for Sirikata::ObjectScript:
Collaboration diagram for Sirikata::ObjectScript:
Public Member Functions | |
| virtual | ~ObjectScript () |
| Destructor: called from the plugin itself. | |
| virtual void | start () |
| virtual void | stop () |
| virtual void | notifyProximateGone (std::tr1::shared_ptr< ProxyObject > p, const SpaceObjectReference &) |
| virtual void | notifyProximate (std::tr1::shared_ptr< ProxyObject > p, const SpaceObjectReference &) |
| virtual bool | handleScriptCommRead (const SpaceObjectReference &src, const SpaceObjectReference &dst, const std::string &payload) |
| virtual String | scriptType () const |
| virtual String | scriptOptions () const |
| virtual void | scriptTypeIs (String _scriptType) |
| virtual void | scriptOptionsIs (String _scriptOptions) |
Protected Attributes | |
| String | scriptType_ |
| String | scriptOptions_ |
Detailed Description
Script running in a plugin.
Can be in C++, or this interface can be passed on to a script.
- See also:
- ObjectScriptManager for how to instantiate one of these.
Constructor & Destructor Documentation
| virtual Sirikata::ObjectScript::~ObjectScript | ( | ) | [inline, virtual] |
Destructor: called from the plugin itself.
Member Function Documentation
| virtual bool Sirikata::ObjectScript::handleScriptCommRead | ( | const SpaceObjectReference & | src, |
| const SpaceObjectReference & | dst, | ||
| const std::string & | payload | ||
| ) | [inline, virtual] |
Reimplemented in Sirikata::JS::EmersonScript.
| virtual void Sirikata::ObjectScript::notifyProximate | ( | std::tr1::shared_ptr< ProxyObject > | p, |
| const SpaceObjectReference & | |||
| ) | [inline, virtual] |
| virtual void Sirikata::ObjectScript::notifyProximateGone | ( | std::tr1::shared_ptr< ProxyObject > | p, |
| const SpaceObjectReference & | |||
| ) | [inline, virtual] |
| virtual String Sirikata::ObjectScript::scriptOptions | ( | ) | const [inline, virtual] |
| virtual void Sirikata::ObjectScript::scriptOptionsIs | ( | String | _scriptOptions | ) | [inline, virtual] |
Referenced by Sirikata::HostedObject::initializeScript().
| virtual String Sirikata::ObjectScript::scriptType | ( | ) | const [inline, virtual] |
| virtual void Sirikata::ObjectScript::scriptTypeIs | ( | String | _scriptType | ) | [inline, virtual] |
Referenced by Sirikata::HostedObject::initializeScript().
| virtual void Sirikata::ObjectScript::start | ( | ) | [inline, virtual] |
Implements Sirikata::Service.
Reimplemented in Sirikata::JS::EmersonScript, and Sirikata::JS::JSObjectScript.
Referenced by Sirikata::HostedObject::initializeScript().
| virtual void Sirikata::ObjectScript::stop | ( | ) | [inline, virtual] |
Implements Sirikata::Service.
Reimplemented in Sirikata::JS::EmersonScript, and Sirikata::JS::JSObjectScript.
Referenced by Sirikata::HostedObject::stop().
Member Data Documentation
String Sirikata::ObjectScript::scriptOptions_ [protected] |
String Sirikata::ObjectScript::scriptType_ [protected] |
The documentation for this class was generated from the following file:
- liboh/include/sirikata/oh/ObjectScript.hpp
