DefSQClass< CL, ST > Class Template Reference

The template to define classes in Squirrel. More...

#include <squirrel_class.hpp>

Public Member Functions
	DefSQClass (const char *_classname)
template<typename Func >
void	DefSQMethod (Squirrel *engine, Func function_proc, const char *function_name)
	This defines a method inside a class for Squirrel.
template<typename Func >
void	DefSQAdvancedMethod (Squirrel *engine, Func function_proc, const char *function_name)
	This defines a method inside a class for Squirrel, which has access to the 'engine' (experts only!).
template<typename Func >
void	DefSQMethod (Squirrel *engine, Func function_proc, const char *function_name, int nparam, const char *params)
	This defines a method inside a class for Squirrel with defined params. More...
template<typename Func >
void	DefSQStaticMethod (Squirrel *engine, Func function_proc, const char *function_name)
	This defines a static method inside a class for Squirrel.
template<typename Func >
void	DefSQAdvancedStaticMethod (Squirrel *engine, Func function_proc, const char *function_name)
	This defines a static method inside a class for Squirrel, which has access to the 'engine' (experts only!).
template<typename Func >
void	DefSQStaticMethod (Squirrel *engine, Func function_proc, const char *function_name, int nparam, const char *params)
	This defines a static method inside a class for Squirrel with defined params. More...
template<typename Var >
void	DefSQConst (Squirrel *engine, Var value, const char *var_name)
void	PreRegister (Squirrel *engine)
void	PreRegister (Squirrel *engine, const char *parent_class)
template<typename Func , int Tnparam>
void	AddConstructor (Squirrel *engine, const char *params)
void	AddSQAdvancedConstructor (Squirrel *engine)
void	PostRegister (Squirrel *engine)

Private Attributes
const char *	classname

Detailed Description

template<class CL, ScriptType ST>
class DefSQClass< CL, ST >

The template to define classes in Squirrel.

It takes care of the creation and calling of such classes, to minimize the API layer.

Definition at line 20 of file squirrel_class.hpp.

Member Function Documentation

DefSQMethod()

template<class CL , ScriptType ST>

template<typename Func >

void DefSQClass< CL, ST >::DefSQMethod ( Squirrel *  engine, Func  function_proc, const char *  function_name, int  nparam, const char *  params  )

inline

This defines a method inside a class for Squirrel with defined params.

Note

If you define nparam, make sure that the first param is always 'x', which is the 'this' inside the function. This is hidden from the rest of the code, but without it calling your function will fail!

Definition at line 56 of file squirrel_class.hpp.

References Squirrel::AddMethod().

DefSQStaticMethod()

template<class CL , ScriptType ST>

template<typename Func >

void DefSQClass< CL, ST >::DefSQStaticMethod ( Squirrel *  engine, Func  function_proc, const char *  function_name, int  nparam, const char *  params  )

inline

This defines a static method inside a class for Squirrel with defined params.

Note

If you define nparam, make sure that the first param is always 'x', which is the 'this' inside the function. This is hidden from the rest of the code, but without it calling your function will fail!

Definition at line 89 of file squirrel_class.hpp.

References Squirrel::AddMethod().

---

The documentation for this class was generated from the following file:

• src/script/squirrel_class.hpp