Neo  0.5.0
Developer Documentation
Neo::ScriptContext Class Referenceabstract

Class used to manage script functions virtually. More...

#include <ScriptContext.h>

Public Member Functions

virtual ~ScriptContext (void)
 Destructor. More...
 
virtual void init ()=0
 
virtual bool runScript (const char *filename)=0
 
virtual bool startCallFunction (const char *name)=0
 
virtual bool endCallFunction (int numArgs=0)=0
 
virtual void callFunction (const char *name)=0
 
virtual void addFunction (const char *name, int(*function)(void))=0
 
virtual bool runString (const char *str)=0
 
virtual unsigned int getArgsNumber (void)=0
 
virtual void getIntArray (unsigned int arg, int *values, unsigned int valuesNumber)=0
 
virtual void getFloatArray (unsigned int arg, float *values, unsigned int valuesNumber)=0
 
virtual const char * getString (unsigned int arg)=0
 
virtual int getInteger (unsigned int arg)=0
 
virtual float getFloat (unsigned int arg)=0
 
virtual void * getPointer (unsigned int arg)=0
 
virtual bool getBoolean (unsigned int arg)=0
 
virtual void pushIntArray (const int *values, unsigned int valuesNumber)=0
 
virtual void pushFloatArray (const float *values, unsigned int valuesNumber)=0
 
virtual void pushString (const char *string)=0
 
virtual void pushBoolean (bool value)=0
 
virtual void pushInteger (int value)=0
 
virtual void pushFloat (float value)=0
 
virtual void pushPointer (void *value)=0
 
virtual bool isNumber (unsigned int arg)=0
 
virtual bool isFunctionOk (const char *name, unsigned int args)=0
 
bool isRunning ()
 

Protected Attributes

bool m_isRunning
 

Detailed Description

Class used to manage script functions virtually.

Constructor & Destructor Documentation

virtual Neo::ScriptContext::~ScriptContext ( void  )
inlinevirtual

Destructor.

Member Function Documentation

virtual void Neo::ScriptContext::addFunction ( const char *  name,
int(*)(void)  function 
)
pure virtual

Add script function.

Parameters
nameFunction name
functionFunction callback
virtual void Neo::ScriptContext::callFunction ( const char *  name)
pure virtual

Call script function.

Parameters
nameFunction name
virtual bool Neo::ScriptContext::endCallFunction ( int  numArgs = 0)
pure virtual

End call script function.

Parameters
numArgsNumber of arguments
virtual unsigned int Neo::ScriptContext::getArgsNumber ( void  )
pure virtual
virtual bool Neo::ScriptContext::getBoolean ( unsigned int  arg)
pure virtual
virtual float Neo::ScriptContext::getFloat ( unsigned int  arg)
pure virtual
virtual void Neo::ScriptContext::getFloatArray ( unsigned int  arg,
float *  values,
unsigned int  valuesNumber 
)
pure virtual
virtual void Neo::ScriptContext::getIntArray ( unsigned int  arg,
int *  values,
unsigned int  valuesNumber 
)
pure virtual
virtual int Neo::ScriptContext::getInteger ( unsigned int  arg)
pure virtual
virtual void* Neo::ScriptContext::getPointer ( unsigned int  arg)
pure virtual
virtual const char* Neo::ScriptContext::getString ( unsigned int  arg)
pure virtual
virtual void Neo::ScriptContext::init ( )
pure virtual
virtual bool Neo::ScriptContext::isFunctionOk ( const char *  name,
unsigned int  args 
)
pure virtual
virtual bool Neo::ScriptContext::isNumber ( unsigned int  arg)
pure virtual
bool Neo::ScriptContext::isRunning ( )
inline
virtual void Neo::ScriptContext::pushBoolean ( bool  value)
pure virtual
virtual void Neo::ScriptContext::pushFloat ( float  value)
pure virtual
virtual void Neo::ScriptContext::pushFloatArray ( const float *  values,
unsigned int  valuesNumber 
)
pure virtual
virtual void Neo::ScriptContext::pushIntArray ( const int *  values,
unsigned int  valuesNumber 
)
pure virtual
virtual void Neo::ScriptContext::pushInteger ( int  value)
pure virtual
virtual void Neo::ScriptContext::pushPointer ( void *  value)
pure virtual
virtual void Neo::ScriptContext::pushString ( const char *  string)
pure virtual
virtual bool Neo::ScriptContext::runScript ( const char *  filename)
pure virtual

Run script.

Parameters
filenameScript filename
virtual bool Neo::ScriptContext::runString ( const char *  str)
pure virtual
virtual bool Neo::ScriptContext::startCallFunction ( const char *  name)
pure virtual

Start call function. All arguments to the function have to be pushed between MScriptContext::startCallFunction and MScriptContext::endCallFunction

Parameters
nameFunction name

Member Data Documentation

bool Neo::ScriptContext::m_isRunning
protected

The documentation for this class was generated from the following file: