Haxe/lua API documentation

To get started with the Haxe lua target:


package lua

..
lib
AnyTable

Bit

Externs for the "bit" class that is required for Haxe lua

CollectGarbageOption

Enum for describing garbage collection options

Coroutine

Externs for native Lua coroutines.

CoroutineResume

CoroutineRunning

CoroutineState

A enumerator that describes the output of Coroutine.status().

DateType

A typedef that describes the output of Os.date().

Debug

DebugInfo

A enumerator that describes the output of Debug.getinfo().

FileHandle

HaxeIterator

An implementation of the Haxe iterator datastructure needed for identical lua iterator behavior.

Io

Input and Output Facilities

IoType

A enumerator that describes the output of Io.type().

Lib

Platform-specific Lua Library. Provides some platform-specific functions for the Lua target, such as conversion from Haxe types to native types and vice-versa.

LoadResult

LocaleCategory

Lua

These are all global static methods within Lua.

Map

Math

NativeIterator

This abstract enables easy conversion from basic lua iterators (i.e., a function that is called until it returns null), and Haxe iterators, which provide a next/hasNext interface.

NativeStringTools

These are all externs for the base Lua "string" class, which functions as an additional set of string tools.

NextResult

Os

Operating System Facilities.

OsExecute

OsSuccess

PCallResult

Package

Externs for lua package handling

PairTools

A set of utility methods for working with the Lua table extern.

PairsResult

Result

StringFind

StringSub

Table

This library provides generic functions for table manipulation.

TableTools

This library provides generic functions for table manipulation.

Thread

The sole purpose of this extern is to provide a concrete type for basic reflection purposes.

Time

TimeParam

A typedef that matches the date parameter Os.time() will accept.

UserData