sqrat  0.9
sqrat
 All Classes Functions Variables Enumerations Enumerator Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Sqrat::Var< const T & > Struct Template Reference

#include <sqratTypes.h>

Public Member Functions

 Var (HSQUIRRELVM vm, SQInteger idx)
 

Static Public Member Functions

static void push (HSQUIRRELVM vm, const T &value)
 

Public Attributes

const T & value
 The actual value of get operations.
 

Detailed Description

template<class T>
struct Sqrat::Var< const T & >

Used to get and push class instances to and from the stack as const references

Template Parameters
TType of instance (usually doesnt need to be defined explicitly)

Constructor & Destructor Documentation

template<class T >
Sqrat::Var< const T & >::Var ( HSQUIRRELVM  vm,
SQInteger  idx 
)
inline

Attempts to get the value off the stack at idx as the given type

Parameters
vmTarget VM
idxIndex trying to be read
Remarks
This function MUST have its Error handled if it occurred.

Member Function Documentation

template<class T >
static void Sqrat::Var< const T & >::push ( HSQUIRRELVM  vm,
const T &  value 
)
inlinestatic

Called by Sqrat::PushVar to put a class object on the stack

Parameters
vmTarget VM
valueValue to push on to the VM's stack
The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.6