Haxe API documentation version 4.3.4

Haxe is an open source toolkit based on a modern, high level, strictly typed programming language, a cross-compiler, a complete cross-platform standard library and ways to access each platform's native capabilities.

Getting Started With Haxe


Top Level

cpp
cs
eval
flash
haxe
hl
java
js
lua
mbedtls
neko
php
python
sys
Any

Any is a type that is compatible with any other in both ways.

Array

An Array is a storage for values. You can access it using indexes or with its API.

ArrayAccess

ArrayAccess is used to indicate a class that can be accessed using brackets. The type parameter represents the type of the elements stored.

Bool

The standard Boolean type, which can either be true or false.

Class

An abstract type that represents a Class.

Date

The Date class provides a basic structure for date and time related information. Date instances can be created by

DateTools

The DateTools class contains some extra functionalities for handling Date instances and timestamps.

Dynamic

Dynamic is a special type which is compatible with all other types.

EReg

The EReg class represents regular expressions.

Enum

An abstract type that represents an Enum type.

EnumValue

An abstract type that represents any enum value. See Type for the Haxe Reflection API.

Float

The standard Float type, this is a double-precision IEEE 64bit float.

Int

The standard Int type. Its precision depends on the platform.

IntIterator

IntIterator is used for implementing interval iterations.

Iterable

An Iterable is a data structure which has an iterator() method. See Lambda for generic functions on iterable structures.

Iterator

An Iterator is a structure that permits iteration over elements of type T.

KeyValueIterable

A KeyValueIterable is a data structure which has a keyValueIterator() method to iterate over key-value-pairs.

KeyValueIterator

A KeyValueIterator is an Iterator that has a key and a value.

Lambda

The Lambda class is a collection of methods to support functional programming. It is ideally used with using Lambda and then acts as an extension to Iterable types.

List

Map

Math

This class defines mathematical functions and constants.

Null

Null<T> is a wrapper that can be used to make the basic types Int, Float and Bool nullable on static targets.

Reflect

The Reflect API is a way to manipulate values dynamically through an abstract interface in an untyped manner. Use with care.

Single

Single-precision IEEE 32bit float (4-byte).

Std

The Std class provides standard methods for manipulating basic types.

String

The basic String class.

StringBuf

A String buffer is an efficient way to build a big string by appending small elements together.

StringTools

This class provides advanced methods on Strings. It is ideally used with using StringTools and then acts as an extension to the String class.

Sys

This class provides access to various base functions of system platforms. Look in the sys package for more system APIs.

SysError

Type

The Haxe Reflection API allows retrieval of type information at runtime.

UInt

The unsigned Int type is only defined for Flash and C#. Simulate it for other platforms.

UnicodeString

This abstract provides consistent cross-target unicode support for characters of any width.

ValueType

The different possible runtime types of a value.

Void

The standard Void type. Only null values can be of the type Void.

Xml

Cross-platform Xml API.

XmlType

Xml node types.