SquirrelStd Class Reference

By default we want to give a set of standard commands to a SQ script. More...

#include <squirrel_std.hpp>

Static Public Member Functions
static SQInteger	min (HSQUIRRELVM vm)
	Get the lowest of two integers.
static SQInteger	max (HSQUIRRELVM vm)
	Get the highest of two integers.
static SQInteger	require (HSQUIRRELVM vm)
	Load another file on runtime.
static SQInteger	notifyallexceptions (HSQUIRRELVM vm)
	Enable/disable stack trace showing for handled exceptions.

Detailed Description

By default we want to give a set of standard commands to a SQ script.

Most of them are easy wrappers around internal functions. Of course we could just as easy include things like the stdmath of SQ, but of those functions we are sure they work on all our supported targets.

Definition at line 26 of file squirrel_std.hpp.

Member Function Documentation

max()

SQInteger SquirrelStd::max ( HSQUIRRELVM vm )

static

Get the highest of two integers.

Parameters

vm	The virtual machine to get the integers from, and write the result to.

Returns

The number of stack spaces to pop.

Definition at line 30 of file squirrel_std.cpp.

Referenced by squirrel_register_std().

min()

SQInteger SquirrelStd::min ( HSQUIRRELVM vm )

static

Get the lowest of two integers.

Parameters

vm	The virtual machine to get the integers from, and write the result to.

Returns

The number of stack spaces to pop.

Definition at line 20 of file squirrel_std.cpp.

Referenced by squirrel_register_std().

notifyallexceptions()

SQInteger SquirrelStd::notifyallexceptions ( HSQUIRRELVM vm )

static

Enable/disable stack trace showing for handled exceptions.

Parameters

vm	The virtual machine to change the notifications for.

Returns

0 upon success, or any other integer upon failure.

Definition at line 70 of file squirrel_std.cpp.

Referenced by squirrel_register_global_std().

require()

SQInteger SquirrelStd::require ( HSQUIRRELVM vm )

static

Load another file on runtime.

Note

This is always loaded on the root-level, no matter where you call this.

The filename is always relative from the script it is called from. Absolute calls are NOT allowed!

Parameters

vm	The virtual machine to load the file into.

Returns

0 upon success, or any other integer upon failure.

Definition at line 40 of file squirrel_std.cpp.

References Squirrel::LoadScript().

Referenced by squirrel_register_global_std().

---

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

• src/script/squirrel_std.hpp
• src/script/squirrel_std.cpp