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< Function & > Struct Template Reference

Used to get and push Function instances to and from the stack as references (functions are always references in Squirrel) More...

#include <sqratFunction.h>

Public Member Functions

 Var (HSQUIRRELVM vm, SQInteger idx)
 

Static Public Member Functions

static void push (HSQUIRRELVM vm, Function &value)
 

Public Attributes

Function value
 The actual value of get operations.
 

Detailed Description

template<>
struct Sqrat::Var< Function & >

Used to get and push Function instances to and from the stack as references (functions are always references in Squirrel)

Constructor & Destructor Documentation

Sqrat::Var< Function & >::Var ( HSQUIRRELVM  vm,
SQInteger  idx 
)
inline

Attempts to get the value off the stack at idx as a Function

Parameters
vmTarget VM
idxIndex trying to be read
Remarks
Assumes the Function environment is at index 1.
This function MUST have its Error handled if it occurred.

Member Function Documentation

static void Sqrat::Var< Function & >::push ( HSQUIRRELVM  vm,
Function value 
)
inlinestatic

Called by Sqrat::PushVarR to put a Function 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: