W3cubDocs

/Haxe

Haxe API documentation

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
flash
haxe
hl
java
js
lua
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.

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

A linked-list of elements. The list is composed of element container objects that are chained together. It is optimized so that adding or removing an element does not imply copying the whole list content every time.

Map

Map allows key to value mapping for arbitrary value types, and many key types.

Math

This class defines mathematical functions and constants.

Null

Null can be useful in two cases. In order to document some methods that accept or can return a null value, or for the Flash compiler and AS3 generator to distinguish between base values that can be null and others that can't.

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 gives you access to many base functionalities of system platforms. Looks in sys sub packages 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.

ValueType
Void

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

Xml

Crossplatform Xml API.

XmlType

Xml node types.

© 2005–2016 Haxe Foundation
Licensed under a MIT license.
http://api.haxe.org/