Class ssq::Function
Class List > ssq > Function
Squirrel function.
#include <function.hpp>
Inherits the following classes: ssq::Object
Public Functions
| Type | Name |
|---|---|
| Function (HSQUIRRELVM vm) Constructs empty function object. | |
| Function (const Object & object) Converts Object toFunction . | |
| Function (const Function & other) Copy constructor. | |
| Function (Function && other) Move constructor. | |
| unsigned int | getNumOfParams () const Returns the number of parameters needed by the function. |
| Function & | operator= (const Function & other) Copy assingment operator. |
| Function & | operator= (Function && other) Move assingment operator. |
| virtual | ~Function () = default Destructor. |
Public Functions inherited from ssq::Object
| Type | Name |
|---|---|
| Object () Creates an empty object with null VM . | |
| Object (HSQUIRRELVM vm) Creates an empty object. | |
| Object (const Object & other) Copy constructor to copy the object reference. | |
| Object (Object && other) Move constructor. | |
| Object | find (const char * name) const Finds object within this object. |
| const HSQUIRRELVM & | getHandle () const Returns the Squirrel virtual machine handle associated with this instance. |
| const HSQOBJECT & | getRaw () const Returns raw Squirrel object reference. |
| HSQOBJECT & | getRaw () Returns raw Squirrel object reference. |
| Type | getType () const Returns the type of the object. |
| const char * | getTypeStr () const Returns the type of the object in string format. |
| size_t | getTypeTag () const Returns the typetag associated with this object. |
| bool | isEmpty () const Checks if the object is empty. |
| bool | isNull () const Returns true if the object is nullptr. |
| Object & | operator= (const Object & other) Copy assingment operator. |
| Object & | operator= (Object && other) Move assingment operator. |
| void | reset () Releases the object and resets it to empty. |
| void | swap (Object & other) Swaps two objects. |
| T | to () const Returns an arbitary value of this object. |
| Array | toArray () const Returns the Array value of this object. |
| bool | toBool () const Returns the boolean value of this object. |
| Class | toClass () const Returns the Class value of this object. |
| float | toFloat () const Returns the float value of this object. |
| Function | toFunction () const Returns the Function value of this object. |
| Instance | toInstance () const Returns the Instance value of this object. |
| int32_t | toInt () const Returns the integer value of this object. |
| T | toPtrUnsafe () const Unsafe cast this object into any pointer of type T. |
| std::string | toString () const Returns the string value of this object. |
| Table | toTable () const Returns the Table value of this object. |
| virtual | ~Object () |
Protected Attributes inherited from ssq::Object
| Type | Name |
|---|---|
| HSQOBJECT | obj |
| HSQUIRRELVM | vm |
| bool | weak |
Public Functions Documentation
function Function [1/4]
explicit ssq::Function::Function (
HSQUIRRELVM vm
)
function Function [2/4]
explicit ssq::Function::Function (
const Object & object
)
Exception:
- TypeException if the Object is not type of a function
function Function [3/4]
ssq::Function::Function (
const Function & other
)
function Function [4/4]
ssq::Function::Function (
Function && other
)
function getNumOfParams
unsigned int ssq::Function::getNumOfParams () const
Note:
This ignores the "this" pointer
function operator=
Function & ssq::Function::operator= (
const Function & other
)
function operator=
Function & ssq::Function::operator= (
Function && other
)
function ~Function
virtual ssq::Function::~Function () = default
The documentation for this class was generated from the following file include/simplesquirrel/function.hpp