Haxe/haxe API documentation

To get started with the Haxe haxe target:


package haxe

..
crypto
ds
extern
format
io
macro
remoting
rtti
unit
web
xml
zip
CallStack

Get informations about the call stack.

Constructible

This type unifies with any instance of classes that have a constructor which

DynamicAccess

DynamicAccess is an abstract type for working with anonymous structures that are intended to hold collections of objects by the string key.

EntryPoint

If haxe.MainLoop is kept from DCE, then we will insert an haxe.EntryPoint.run() call just at then end of main(). This class can be redefined by custom frameworks so they can handle their own main loop logic.

EnumFlags

A typed interface for bit flags. This is not a real object, only a typed interface for an actual Int. Each flag can be tested/set with the corresponding enum instance. Up to 32 flags can be stored that way.

EnumTools

This class provides advanced methods on enums. It is ideally used with using EnumTools and then acts as an extension to the enum types.

EnumValueTools

This class provides advanced methods on enum values. It is ideally used with using EnumValueTools and then acts as an extension to the EnumValue types.

FlatEnum

This type unifies with an enum instance if all constructors of the enum require no arguments.

Function

This type unifies with any function type.

Http

This class can be used to handle Http requests consistently across platforms. There are two intended usages:

IMap

Int32

Int32 provides a 32-bit integer with consistent overflow behavior across all platforms.

Int64

A cross-platform signed 64-bit integer. Int64 instances can be created from two 32-bit words using Int64.make().

Int64Helper

Helper for parsing to Int64 instances.

Json

Crossplatform JSON API: it will automatically use the optimized native API if available. Use -D haxeJSON to force usage of the Haxe implementation even if a native API is found: This will provide extra encoding features such as enums (replaced by their index) and StringMaps.

Log

Log primarily provides the trace() method, which is invoked upon a call to trace() in Haxe code.

MainEvent

MainLoop

PosInfos

PosInfos is a magic type which can be used to generate position information into the output for debugging use.

Resource

Resource can be used to access resources that were added through the -resource file@name command line parameter.

Serializer

The Serializer class can be used to encode values and objects into a String, from which the Unserializer class can recreate the original representation.

StackItem

Elements return by CallStack methods.

Template

Template provides a basic templating mechanism to replace values in a source String, and to have some basic logic.

Timer

The Timer class allows you to create asynchronous timers on platforms that support events.

Ucs2

Cross platform UCS2 string API.

Unserializer

The Unserializer class is the complement to the Serializer class. It parses a serialization String and creates objects from the contained data.

Utf8

Since not all platforms guarantee that String always uses UTF-8 encoding, you can use this crossplatform API to perform operations on such strings.