SimpleSquirrel

Class ssq::Enum

Class List > ssq > Enum

Squirrel table object.

  • #include <enum.hpp>

Inherits the following classes: ssq::Object

Public Functions

Type Name
Enum ()
Creates empty table with null VM .
Enum (const Object & other)
Converts Object toEnum .
Enum (HSQUIRRELVM vm)
Creates empty enum.
Enum (const Enum & other)
Copy constructor.
Enum (Enum && other)
Move constructor.
void addSlot (const char * name, const T & value)
Adds a new key-value pair to this table.
Enum & operator= (const Enum & other)
Copy assingment operator.
Enum & operator= (Enum && other)
Move assingment operator.
virtual ~Enum () = 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 Enum [1/5]

ssq::Enum::Enum ()

Note:

This object will be unusable

function Enum [2/5]

explicit ssq::Enum::Enum (
    const Object & other
)

Exception:

function Enum [3/5]

explicit ssq::Enum::Enum (
    HSQUIRRELVM vm
)

function Enum [4/5]

ssq::Enum::Enum (
    const Enum & other
)

function Enum [5/5]

ssq::Enum::Enum (
    Enum && other
)

function addSlot

template<typename T typename T>
inline void ssq::Enum::addSlot (
    const char * name,
    const T & value
)

function operator=

Enum & ssq::Enum::operator= (
    const Enum & other
)

function operator=

Enum & ssq::Enum::operator= (
    Enum && other
)

function ~Enum

virtual ssq::Enum::~Enum () = default

The documentation for this class was generated from the following file include/simplesquirrel/enum.hpp