Class ssq::SqWeakRef
Class List > ssq > SqWeakRef
Weak reference class that does not extend the life of the instance.
- #include <instance.hpp>
Inherits the following classes: ssq::Instance
Public Functions
| Type | Name | 
|---|---|
| SqWeakRef () | |
| SqWeakRef (HSQUIRRELVM vm) | |
| SqWeakRef (const SqWeakRef & other) | |
| SqWeakRef (SqWeakRef && other) | |
| SqWeakRef (const Instance & instance) | |
| SqWeakRef & | operator= (const SqWeakRef & other) | 
| SqWeakRef & | operator= (SqWeakRef && other) | 
| void | swap (SqWeakRef & other) | 
Public Functions inherited from ssq::Instance
| Type | Name | 
|---|---|
| Instance () Constructs empty invalid instance. | |
| Instance (HSQUIRRELVM vm) Constructs empty instance. | |
| Instance (const Object & object) Converts Object toInstance . | |
| Instance (const Instance & other) Copy constructor. | |
| Instance (Instance && other) Move constructor. | |
| Class | getClass () Returns the class associated with this instance. | 
| Instance & | operator= (const Instance & other) Copy assingment operator. | 
| Instance & | operator= (Instance && other) Move assingment operator. | 
| virtual | ~Instance () = 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 SqWeakRef [1/5]
ssq::SqWeakRef::SqWeakRef () 
function SqWeakRef [2/5]
ssq::SqWeakRef::SqWeakRef (
    HSQUIRRELVM vm
) 
function SqWeakRef [3/5]
ssq::SqWeakRef::SqWeakRef (
    const SqWeakRef & other
) 
function SqWeakRef [4/5]
ssq::SqWeakRef::SqWeakRef (
    SqWeakRef && other
) 
function SqWeakRef [5/5]
explicit ssq::SqWeakRef::SqWeakRef (
    const Instance & instance
) 
function operator=
SqWeakRef & ssq::SqWeakRef::operator= (
    const SqWeakRef & other
) 
function operator=
SqWeakRef & ssq::SqWeakRef::operator= (
    SqWeakRef && other
) 
function swap
void ssq::SqWeakRef::swap (
    SqWeakRef & other
) 
The documentation for this class was generated from the following file include/simplesquirrel/instance.hpp