![]() |
Public API Reference |
#include <script.h>
Inheritance diagram for iScriptObject:
Public Methods | |
virtual bool | IsType (const char *) const=0 |
Returns a boolean specifying whether or not the object is derived from the given type. More... | |
virtual iBase * | GetPointer () const=0 |
If the object is an interface pointer from the cspace module, this will return its value, otherwise 0. More... | |
virtual bool | SetPointer (iBase *)=0 |
If the object is an interface pointer from the cspace module, this will set its value and return true, otherwise false. More... | |
virtual bool | Call (const char *name, const char *format,...)=0 |
Call a method in the object, with no return value. More... | |
virtual bool | Call (const char *name, int &ret, const char *fmt,...)=0 |
Call a method in the object, with int return value. More... | |
virtual bool | Call (const char *name, float &ret, const char *fmt,...)=0 |
Call a method in the object, with float return value. More... | |
virtual bool | Call (const char *name, double &ret, const char *fmt,...)=0 |
Call a method in the object, with double return value. More... | |
virtual bool | Call (const char *name, char **ret, const char *fmt,...)=0 |
Call a method in the object, with string return value. More... | |
virtual bool | Call (const char *name, csRef< iScriptObject > &ret, const char *fmt,...)=0 |
Call a method in the object, with object return value. More... | |
virtual bool | Set (const char *name, int data)=0 |
Set the value of an int variable in the script interpreter. More... | |
virtual bool | Set (const char *name, float data)=0 |
Set the value of a float variable in the script interpreter. More... | |
virtual bool | Set (const char *name, double data)=0 |
Set the value of a double variable in the script interpreter. More... | |
virtual bool | Set (const char *name, char *data)=0 |
Set the value of a string variable in the script interpreter. More... | |
virtual bool | Set (const char *name, iScriptObject *data)=0 |
Set the value of an object variable in the script interpreter. More... | |
virtual bool | SetTruth (const char *name, bool isTrue)=0 |
Set the value of a bool variable in the script interpreter. More... | |
virtual bool | Get (const char *name, int &data) const=0 |
Get the value of an int variable in the script interpreter. More... | |
virtual bool | Get (const char *name, float &data) const=0 |
Get the value of a float variable in the script interpreter. More... | |
virtual bool | Get (const char *name, double &data) const=0 |
Get the value of a double variable in the script interpreter. More... | |
virtual bool | Get (const char *name, char **data) const=0 |
Get the value of a string variable in the script interpreter. More... | |
virtual bool | Get (const char *name, csRef< iScriptObject > &data) const=0 |
Get the value of an object variable in the script interpreter. More... | |
virtual bool | GetTruth (const char *name, bool &isTrue) const=0 |
Get the value of a bool variable in the script interpreter. More... |
Several functions here take a variable-length argument list with a printf-style format string supporting all the argument types supported by printf, except width and precision specifiers, as they have no meaning here. The type specifier "p" signifies an iScriptObject. Remember to explicitly cast your csRef's to plain pointers in the var arg list.
Definition at line 38 of file script.h.
|
Call a method in the object, with object return value. Returns false if the subroutine named does not exist. Format is a printf-style format string for the arguments. |
|
Call a method in the object, with string return value. Returns false if the subroutine named does not exist. Format is a printf-style format string for the arguments. |
|
Call a method in the object, with double return value. Returns false if the subroutine named does not exist. Format is a printf-style format string for the arguments. |
|
Call a method in the object, with float return value. Returns false if the subroutine named does not exist. Format is a printf-style format string for the arguments. |
|
Call a method in the object, with int return value. Returns false if the subroutine named does not exist. Format is a printf-style format string for the arguments. |
|
Call a method in the object, with no return value. Returns false if the subroutine named does not exist. Format is a printf-style format string for the arguments. |
|
Get the value of an object variable in the script interpreter. Returns false if the named variable does not exist. |
|
Get the value of a string variable in the script interpreter. Returns false if the named property does not exist. |
|
Get the value of a double variable in the script interpreter. Returns false if the named property does not exist. |
|
Get the value of a float variable in the script interpreter. Returns false if the named property does not exist. |
|
Get the value of an int variable in the script interpreter. Returns false if the named property does not exist. |
|
If the object is an interface pointer from the cspace module, this will return its value, otherwise 0.
|
|
Get the value of a bool variable in the script interpreter. Returns false if the named property does not exist. |
|
Returns a boolean specifying whether or not the object is derived from the given type.
|
|
Set the value of an object variable in the script interpreter. Returns false if the named property does not exist. |
|
Set the value of a string variable in the script interpreter. Returns false if the named property does not exist. |
|
Set the value of a double variable in the script interpreter. Returns false if the named property does not exist. |
|
Set the value of a float variable in the script interpreter. Returns false if the named property does not exist. |
|
Set the value of an int variable in the script interpreter. Returns false if the named property does not exist. |
|
If the object is an interface pointer from the cspace module, this will set its value and return true, otherwise false.
|
|
Set the value of a bool variable in the script interpreter. Returns false if the named property does not exist. |