Quirrel documentation
4.8.0
Introduction
Differences from Squirrel language
Quirrel 4.8.0 Reference Manual
Quirrel 4.8.0 Standard Library
Modules
Quirrel bindings
Try Quirrel online
RFCs
RFC process
Quirrel documentation
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
Y
Symbols
.$ and ?.$ Operators
Operators
3 ways compare operator
Operators
64 bits
?. and ?[] Operators
Operators
?: Operator
Operators
?? Operator
Operators
A
abs() (built-in function)
acos() (built-in function)
Arithmetic Operators
Operators
Array constructor
array() (built-in function)
array.append() (array method)
array.apply() (array method)
array.clear() (array method)
array.clone() (array method)
array.contains() (array method)
array.each() (array method)
array.extend() (array method)
array.filter() (array method)
array.findindex() (array method)
array.findvalue() (array method)
array.indexof() (array method)
array.insert() (array method)
array.is_frozen() (array method)
array.len() (array method)
array.map() (array method)
array.pop() (array method)
array.reduce() (array method)
array.remove() (array method)
array.replace() (array method)
array.resize() (array method)
array.reverse() (array method)
array.slice() (array method)
array.sort() (array method)
array.top() (array method)
array.tostring() (array method)
array.totable() (array method)
array.weakref() (array method)
Arrays
asin() (built-in function)
assert() (built-in function)
assignment(=)
atan() (built-in function)
atan2() (built-in function)
B
Binding an environment to a function
Bitwise Operators
Operators
blob() (class)
blob.as_string() (blob method)
blob.eos() (blob method)
blob.flush() (blob method)
blob.len() (blob method)
blob.readblob() (blob method)
blob.readn() (blob method)
blob.resize() (blob method)
blob.seek() (blob method)
blob.swap2() (blob method)
blob.swap4() (blob method)
blob.tell() (blob method)
blob.writeblob() (blob method)
blob.writen() (blob method)
block
statement
bool.tofloat() (bool method)
bool.tointeger() (bool method)
bool.tostring() (bool method)
bool.weakref() (bool method)
break
statement
Built-in Functions
Global Symbols
C
call_type_method() (built-in function)
callee() (built-in function)
castf2i() (built-in function)
casti2f() (built-in function)
ceil() (built-in function)
clamp() (built-in function)
Class
declaration
inheritance
instances
metamethods
static variables
Class Declaration
Class declaration
statement
Class Instances
Class metamethods
class.__merge() (class method)
class.__update() (class method)
class.getfuncinfos() (class method)
class.getmetamethod() (class method)
class.instance() (class method)
class.lock() (class method)
class.newmember() (class method)
class.rawget() (class method)
class.rawin() (class method)
class.rawset() (class method)
class.tostring() (class method)
class.weakref() (class method)
Classes
clock() (built-in function)
clone
collectgarbage() (built-in function)
comments
compilestring() (built-in function)
Complier directives
const
statement
Constants
Constants & Enumerations
continue
statement
control flow statements
cos() (built-in function)
D
date() (built-in function)
declaration
Class
delimiters
Destructuring assignment
diff_from_original
do/while
statement
dofile() (built-in function)
E
else
statement
endswith() (built-in function)
enum
statement
Enumerations
Error Conventions
error() (built-in function)
errorln() (built-in function)
escape() (built-in function)
exp() (built-in function)
Expression statement
statement
Expressions
F
fabs() (built-in function)
false
file() (class)
file.close() (file method)
file.eos() (file method)
file.flush() (file method)
file.len() (file method)
file.readblob() (file method)
file.readn() (file method)
file.resize() (file method)
file.seek() (file method)
file.tell() (file method)
file.writeblob() (file method)
file.writen() (file method)
float.tochar() (float method)
float.tofloat() (float method)
float.tointeger() (float method)
float.tostring() (float method)
float.weakref() (float method)
floor() (built-in function)
for
statement
foreach
statement
format() (built-in function)
Free Variables
freeze() (built-in function)
Function calls
Function Declaration
Function declaration
statement
Function Default Paramaters
Function with variable number of paramaters
function.acall() (function method)
function.bindenv() (function method)
function.call() (function method)
function.getfreevar() (function method)
function.getfuncinfos() (function method)
function.pacall() (function method)
function.pcall() (function method)
function.tostring() (function method)
function.weakref() (function method)
Functions
G
generator.getstatus() (generator method)
generator.tostring() (generator method)
generator.weakref() (generator method)
Generators
getbuildinfo() (built-in function)
getconsttable() (built-in function)
getenv() (built-in function)
getlocals() (built-in function)
getobjflags() (built-in function)
getroottable() (built-in function)
getstackinfos() (built-in function)
Global Symbols
Built-in Functions
I
identifiers
if
statement
if/else
statement
in operator, not in operator
Operators
Inheritance
inheritance
Class
instance.getclass() (instance method)
instance.getfuncinfos() (instance method)
instance.getmetamethod() (instance method)
instance.is_frozen() (instance method)
instance.rawget() (instance method)
instance.rawin() (instance method)
instance.rawset() (instance method)
instance.tostring() (instance method)
instance.weakref() (instance method)
instanceof operator
Operators
instances
Class
integer.tochar() (integer method)
integer.tofloat() (integer method)
integer.tointeger() (integer method)
integer.tostring() (integer method)
integer.weakref() (integer method)
introduction
K
keepref() (built-in function)
keywords
L
Lambda Expressions
lexical structure
Limitations
literals
loadfile() (built-in function)
Local variables declaration
statement
log() (built-in function)
log10() (built-in function)
Logical operators
Operators
Loops
lstrip() (built-in function)
M
max() (built-in function)
Memory Management
metamethods
Class
min() (built-in function)
more details on quirrel
N
Named bindings declaration
statement
Native API
newthread() (built-in function)
numeric literals
O
Operators
.$ and ?.$ Operators
3 ways compare operator
?. and ?[] Operators
?: Operator
?? Operator
Arithmetic Operators
Bitwise Operators
in operator, not in operator
instanceof operator
Logical operators
Operators precedence
Relational Operators
typeof operator
operators
Operators precedence
Operators
other tokens
P
persist() (built-in function)
PI (global variable or constant)
pow() (built-in function)
print() (built-in function)
printf() (built-in function)
println() (built-in function)
Q
Quirrel on 64-bit architectures
R
rand() (built-in function)
RAND_MAX (global variable or constant)
regexp() (class)
regexp.capture() (regexp method)
regexp.match() (regexp method)
regexp.search() (regexp method)
Relational Operators
Operators
remove() (built-in function)
rename() (built-in function)
require() (built-in function)
require_optional() (built-in function)
resurrectunreachable() (built-in function)
return
statement
rstrip() (built-in function)
S
Script API
setdebughook() (built-in function)
seterrorhandler() (built-in function)
sin() (built-in function)
Slot Creation(table)
Slot Deletion(table)
split_by_chars() (built-in function)
sq_addref (C function)
sq_arrayappend (C function)
sq_arrayinsert (C function)
sq_arraypop (C function)
sq_arrayremove (C function)
sq_arrayresize (C function)
sq_arrayreverse (C function)
sq_bindenv (C function)
sq_call (C function)
sq_clear (C function)
sq_clone (C function)
sq_close (C function)
sq_cmp (C function)
sq_collectgarbage (C function)
sq_compile (C function)
sq_createinstance (C function)
sq_deleteslot (C function)
sq_enabledebuginfo (C function)
sq_get (C function)
sq_getbase (C function)
sq_getbool (C function)
sq_getbyhandle (C function)
sq_getcallee (C function)
sq_getclass (C function)
sq_getclosureinfo (C function)
sq_getclosurename (C function)
sq_getclosureroot (C function)
sq_getdelegate (C function)
sq_geterrorfunc (C function)
sq_getfloat (C function)
sq_getforeignptr (C function)
sq_getfreevariable (C function)
sq_getfunctioninfo (C function)
sq_gethash (C function)
sq_getinstanceup (C function)
sq_getinteger (C function)
sq_getlasterror (C function)
sq_getlocal (C function)
sq_getmemberhandle (C function)
sq_getobjtypetag (C function)
sq_getprintfunc (C function)
sq_getrefcount (C function)
sq_getreleasehook (C function)
sq_getscratchpad (C function)
sq_getsharedforeignptr (C function)
sq_getsharedreleasehook (C function)
sq_getsize (C function)
sq_getstackobj (C function)
sq_getstring (C function)
sq_getstringandsize (C function)
sq_getthread (C function)
sq_gettop (C function)
sq_gettype (C function)
sq_gettypetag (C function)
sq_getuserdata (C function)
sq_getuserpointer (C function)
sq_getvmreleasehook (C function)
sq_getvmstate (C function)
sq_getweakrefval (C function)
sq_instanceof (C function)
sq_move (C function)
sq_newarray (C function)
sq_newclass (C function)
sq_newclosure (C function)
sq_newmember (C function)
sq_newslot (C function)
sq_newtable (C function)
sq_newtableex (C function)
sq_newthread (C function)
sq_newuserdata (C function)
sq_next (C function)
sq_notifyallexceptions (C function)
sq_objtobool (C function)
sq_objtofloat (C function)
sq_objtointeger (C function)
sq_objtostring (C function)
sq_objtouserpointer (C function)
sq_open (C function)
sq_pop (C function)
sq_poptop (C function)
sq_push (C function)
sq_pushbool (C function)
sq_pushconsttable (C function)
sq_pushfloat (C function)
sq_pushinteger (C function)
sq_pushnull (C function)
sq_pushobject (C function)
sq_pushregistrytable (C function)
sq_pushroottable (C function)
sq_pushstring (C function)
sq_pushuserpointer (C function)
sq_rawdeleteslot (C function)
sq_rawget (C function)
sq_rawset (C function)
sq_readclosure (C function)
sq_release (C function)
sq_remove (C function)
sq_reservestack (C function)
sq_reseterror (C function)
sq_resetobject (C function)
sq_resume (C function)
sq_resurrectunreachable (C function)
sq_set (C function)
sq_setbyhandle (C function)
sq_setclassudsize (C function)
sq_setclosureroot (C function)
sq_setcompilererrorhandler (C function)
sq_setconsttable (C function)
sq_setdebughook (C function)
sq_setdelegate (C function)
sq_seterrorhandler (C function)
sq_setforeignptr (C function)
sq_setfreevariable (C function)
sq_setinstanceup (C function)
sq_setnativeclosurename (C function)
sq_setnativedebughook (C function)
sq_setparamscheck (C function)
sq_setprintfunc (C function)
sq_setreleasehook (C function)
sq_setroottable (C function)
sq_setsharedforeignptr (C function)
sq_setsharedreleasehook (C function)
sq_settop (C function)
sq_settypetag (C function)
sq_setvmreleasehook (C function)
sq_stackinfos (C function)
sq_suspendvm (C function)
sq_tailcall (C function)
sq_throwerror (C function)
sq_throwobject (C function)
sq_tobool (C function)
sq_tostring (C function)
sq_typeof (C function)
sq_wakeupvm (C function)
sq_weakref (C function)
sq_writeclosure (C function)
SqModules::addNativeModule (C++ function)
SqModules::getVM (C++ function)
SqModules::registerBaseLibs (C++ function)
SqModules::registerIoLib (C++ function)
SqModules::registerSystemLib (C++ function)
SqModules::reloadModule (C++ function)
SqModules::requireModule (C++ function)
SqModules::SqModules (C++ function)
sqrt() (built-in function)
sqstd_createblob (C function)
sqstd_createfile (C function)
sqstd_dofile (C function)
sqstd_format (C function)
sqstd_formatcallstackstring (C function)
sqstd_getblob (C function)
sqstd_getblobsize (C function)
sqstd_getfile (C function)
sqstd_loadfile (C function)
sqstd_printcallstack (C function)
sqstd_register_bloblib (C function)
sqstd_register_datetimelib (C function)
sqstd_register_iolib (C function)
sqstd_register_mathlib (C function)
sqstd_register_stringlib (C function)
sqstd_register_systemlib (C function)
sqstd_rex_compile (C function)
sqstd_rex_free (C function)
sqstd_rex_getsubexp (C function)
sqstd_rex_getsubexpcount (C function)
sqstd_rex_match (C function)
sqstd_rex_search (C function)
sqstd_rex_searchrange (C function)
sqstd_seterrorhandlers (C function)
sqstd_writeclosuretofile (C function)
srand() (built-in function)
Stand-alone VM without compiler
startswith() (built-in function)
statement
block
break
Class declaration
const
continue
do/while
else
enum
Expression statement
for
foreach
Function declaration
if
if/else
Local variables declaration
Named bindings declaration
return
switch
throw
try/catch
while
yield
statements
Static variables
static variables
Class
stderr (global variable or constant)
stdin (global variable or constant)
stdout (global variable or constant)
String interpolation
string literals
string.concat() (string method)
string.contains() (string method)
string.hash() (string method)
string.indexof() (string method)
string.join() (string method)
string.len() (string method)
string.lstrip() (string method)
string.replace() (string method)
string.rstrip() (string method)
string.slice() (string method)
string.split() (string method)
string.split_by_chars() (string method)
string.startswith() (string method)
string.strip() (string method)
string.subst() (string method)
string.tofloat() (string method)
string.tointeger() (string method)
string.tolower() (string method)
string.tostring() (string method)
string.toupper() (string method)
string.weakref() (string method)
strip() (built-in function)
swap2() (built-in function)
swap4() (built-in function)
swapfloat() (built-in function)
switch
statement
system() (built-in function)
T
Table Contructor
Table with JSON syntax
table.__merge() (table method)
table.__update() (table method)
table.clear() (table method)
table.clone() (table method)
table.each() (table method)
table.filter() (table method)
table.findindex() (table method)
table.findvalue() (table method)
table.getfuncinfos() (table method)
table.is_frozen() (table method)
table.keys() (table method)
table.len() (table method)
table.map() (table method)
table.rawdelete() (table method)
table.rawget() (table method)
table.rawin() (table method)
table.rawset() (table method)
table.reduce() (table method)
table.topairs() (table method)
table.tostring() (table method)
table.values() (table method)
table.weakref() (table method)
Table::SquirrelFunc (C++ function)
Tables
Tail Recursion
tan() (built-in function)
thread.call() (thread method)
thread.getstackinfos() (thread method)
thread.getstatus() (thread method)
thread.tostring() (thread method)
thread.wakeup() (thread method)
thread.wakeupthrow() (thread method)
thread.weakref() (thread method)
Threads
throw
statement
time() (built-in function)
true
true and false
try/catch
statement
type() (built-in function)
typeof operator
Operators
U
Userdata Alignment
userdata.getfuncinfos() (userdata method)
Using Threads
W
Weak References
weakreference.ref() (weakreference method)
weakreference.tostring() (weakreference method)
weakreference.weakref() (weakreference method)
while
statement
writeclosuretofile() (built-in function)
Y
yield
statement