Classes are implemented using Lua meta-tables. It provides properties (get/set functions that acts as a member variable), enumerations (small and read-only classes to list constant values) and functions.

Classes: To create a class you must use the class constructor. Eg.: classInstance = ClassName(); All classes that doesn't describe the constructor method can't be created by the user.

Properties: accessed using '.'. Eg.: variable = Class.propery; Class.property = variable;

Functions: accessed using ':'. Eg.: variable = Class:function(parameter);

Enumerations: accessed using '.'. Eg.: variable = Class.enumValue1;

Types: Lua is dynamic typed, then the type of vars isn't specified in the code. We will use the notation "{type}" to show the type. All properties are suposed to be read-only, otherwise will be marked as read-write.


Functions

Classes

TextDocument

Enumerations

MoveOperation: {integer}

MoveMode: {integer}

SelectionType: {integer}

Properties

Functions

SpritePalette

Enumerations

ShareMode: {integer}

Properties

Functions

Sprite

Enumerations

Flag: {integer}

ImagePalette: {integer}

PaletteMode: {integer}

ShareMode: {integer}

Properties

Functions

Sprites

Enumerations

Version: {integer}

Properties

Functions

HitBox

Properties

HitBoxes

Enumerations

Type: {integer}

Properties

Functions

AnimationFrame

Enumerations

InterFrame: {integer}

Flip: {integer}

Blend: {integer}

Properties

Functions

Animation

Properties

Functions

Animations

Properties

Functions

Project

Enumerations

Type: {integer}

Properties

Functions