CINXE.COM

<!DOCTYPE html> <html lang="en">  <head><meta charset="utf-8"/><link href="./bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="./bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="./jquery-1.9.1.min.js"></script><script src="./bootstrap/js/bootstrap.min.js"></script><script src="./bootstrap/js/bootstrap-select.min.js"></script><link href="./styles.css" rel="stylesheet"/><link href="./extra-styles.css" rel="stylesheet"/><link href="./haxe-nav.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["cs","js","java","lua","python","hl","cpp","neko","macro","flash","php"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>top level - Haxe 4.3.5 API</title><link rel="canonical" href="https://api.haxe.org/index.html"/><style> .main-content { margin-top:65px; } .nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus { background:#F48821; color:#fff; text-shadow:0 0 0 transparent; } </style></head><body><nav class="section nav dark"><div class="navbar navbar-fixed-top navbar-inverse"><div class="navbar-inner"><button class="btn btn-navbar" data-target=".nav-collapse" data-toggle="collapse" type="button"><span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span></button><a class="brand haxe-logo" href="https://haxe.org/"><img alt="Haxe" height="21" onerror="this.src='https://haxe.org/img/haxe-logo-horizontal-on-dark.png'" src="https://haxe.org/img/haxe-logo-horizontal-on-dark.svg" width="107"/></a><a class="brand sub lib" href="./">API</a><div class="nav-collapse collapse"><ul class="nav"><li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="/">Version 4.3.5 <b class="caret"></b></a><ul class="dropdown-menu"> <li class=""><a href="/v/3.4.7/">3.4.7</a></li><li class=""><a href="/v/4.0.5/">4.0.5</a></li><li class=""><a href="/v/4.1.3/">4.1.3</a></li><li class=""><a href="/v/4.2.5/">4.2.5</a></li><li class="active"><a href="/">4.3.5</a></li><li><a href="/v/development" class="">Development</a></li></ul></li><li class="divider"></li><li class="dropdown"><a href="https://haxe.org/download/" rel="external">Download Haxe</a></li><li class="divider"></li><li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="https://haxe.org/documentation/">Learn Haxe <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="https://haxe.org/documentation/introduction/" rel="external">Introduction</a></li><li><a href="https://haxe.org/manual/" rel="external">Manual</a></li><li><a href="https://code.haxe.org" rel="external">Code Cookbook</a></li><li class="active"><a href="https://api.haxe.org" rel="external">API Documentation</a></li><li class="divider"></li><li><a href="https://haxe.org/videos/" rel="external">Videos</a></li><li class="divider"></li><li><a href="https://try.haxe.org" rel="external">Try Haxe online</a></li><li><a href="https://lib.haxe.org" rel="external">Haxelib</a></li></ul></li><li class=" dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">Connect <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="https://github.com/HaxeFoundation" rel="external"><i class="fa fa-github"></i> Github</a></li><li><a href="https://github.com/HaxeFoundation/haxe/issues" rel="external"><i class="fa fa-github"></i> Bug reports</a></li><li><a href="https://stackoverflow.com/questions/tagged/haxe" rel="external"><i class="fa fa-stack-overflow"></i> Stack Overflow</a></li><li><a href="http://community.haxe.org/" rel="external"><i class="fa fa-envelope-o"></i> Forums</a></li><li><a href="https://discordapp.com/invite/0uEuWH3spjck73Lo" rel="external nofollow"><i class="fa fa-comments-o"></i> Discord</a></li><li><a href="https://gitter.im/HaxeFoundation/haxe" rel="external nofollow"><i class="fa fa-comments-o"></i> Gitter</a></li><li><a href="https://haxe.org/blog"><i class="fa fa-rss"></i> Blog</a></li><li class="divider"></li><li><a href="https://www.facebook.com/haxe.org/" rel="external"><i class="fa fa-facebook"></i> Facebook</a></li><li><a href="https://twitter.com/search?q=%23haxe" rel="external"><i class="fa fa-twitter"></i> #haxe</a></li><li><a href="https://twitter.com/haxelang" rel="external"><i class="fa fa-twitter"></i> @haxelang</a></li><li><a href="https://twitter.com/haxe_org" rel="external"><i class="fa fa-twitter"></i> @haxe_org</a></li><li class="divider"></li><li><a href="https://haxe.org/foundation/contact.html">Contact</a></li></ul></li></ul></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="selected">All Platforms</option><option>cs</option><option>js</option><option>java</option><option>lua</option><option>python</option><option>hl</option><option>cpp</option><option>neko</option><option>macro</option><option>flash</option><option>php</option></select></div></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><h1>Haxe API documentation <small>version 4.3.5</small></h1><p>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.</p> <h3>Getting Started With Haxe</h3><ul><li>Take a look at our <a href="https://haxe.org/documentation/introduction/">introduction</a></li><li>Read through the <a href="https://haxe.org/manual/">Haxe Manual</a></li><li>Look at these <a href="https://haxe.org/use-cases/">use cases for Haxe</a></li><li>Find and install <a href="https://lib.haxe.org/t/all/">popular Haxe libraries</a></li><li>Learn by example with the <a href="http://code.haxe.org">Haxe Code Cookbook</a></li></ul><hr/><h3>Top Level</h3> <table class="table table-condensed"><tbody><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./cpp/index.html" title=".cpp">cpp</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./cs/index.html" title=".cs">cs</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./eval/index.html" title=".eval">eval</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./flash/index.html" title=".flash">flash</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./haxe/index.html" title=".haxe">haxe</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./hl/index.html" title=".hl">hl</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./java/index.html" title=".java">java</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./js/index.html" title=".js">js</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./lua/index.html" title=".lua">lua</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./mbedtls/index.html" title=".mbedtls">mbedtls</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./neko/index.html" title=".neko">neko</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./php/index.html" title=".php">php</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./python/index.html" title=".python">python</a></td></tr><tr class="package"><td colspan="2"><i class="fa fa-folder-o"></i><a href="./sys/index.html" title=".sys">sys</a></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Any.html" title=".Any">Any</a></td><td><p><code><a href="./Any.html">Any</a></code> is a type that is compatible with any other in both ways.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Array.html" title=".Array">Array</a></td><td><p>An Array is a storage for values. You can access it using indexes or with its API.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./ArrayAccess.html" title=".ArrayAccess">ArrayAccess</a></td><td><p><code><a href="./ArrayAccess.html">ArrayAccess</a></code> is used to indicate a class that can be accessed using brackets. The type parameter represents the type of the elements stored.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Bool.html" title=".Bool">Bool</a></td><td><p>The standard Boolean type, which can either be <code><a href="./Bool.html">true</a></code> or <code><a href="./Bool.html">false</a></code>.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Class.html" title=".Class">Class</a></td><td><p>An abstract type that represents a Class.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Date.html" title=".Date">Date</a></td><td><p>The Date class provides a basic structure for date and time related information. Date instances can be created by</p></td></tr><tr class="class"><td style="width:200px;"><a href="./DateTools.html" title=".DateTools">DateTools</a></td><td><p>The DateTools class contains some extra functionalities for handling <code><a href="./Date.html">Date</a></code> instances and timestamps.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Dynamic.html" title=".Dynamic">Dynamic</a></td><td><p><code><a href="./Dynamic.html">Dynamic</a></code> is a special type which is compatible with all other types.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./EReg.html" title=".EReg">EReg</a></td><td><p>The EReg class represents regular expressions.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Enum.html" title=".Enum">Enum</a></td><td><p>An abstract type that represents an Enum type.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./EnumValue.html" title=".EnumValue">EnumValue</a></td><td><p>An abstract type that represents any enum value. See <code><a href="./Type.html">Type</a></code> for the Haxe Reflection API.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Float.html" title=".Float">Float</a></td><td><p>The standard <code><a href="./Float.html">Float</a></code> type, this is a double-precision IEEE 64bit float.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Int.html" title=".Int">Int</a></td><td><p>The standard <code><a href="./Int.html">Int</a></code> type. Its precision depends on the platform.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./IntIterator.html" title=".IntIterator">IntIterator</a></td><td><p>IntIterator is used for implementing interval iterations.</p></td></tr><tr class="type"><td style="width:200px;"><a href="./Iterable.html" title=".Iterable">Iterable</a></td><td><p>An <code><a href="./Iterable.html">Iterable</a></code> is a data structure which has an <code>iterator()</code> method. See <code><a href="./Lambda.html">Lambda</a></code> for generic functions on iterable structures.</p></td></tr><tr class="type"><td style="width:200px;"><a href="./Iterator.html" title=".Iterator">Iterator</a></td><td><p>An <code><a href="./Iterator.html">Iterator</a></code> is a structure that permits iteration over elements of type <code>T</code>.</p></td></tr><tr class="type"><td style="width:200px;"><a href="./KeyValueIterable.html" title=".KeyValueIterable">KeyValueIterable</a></td><td><p>A <code><a href="./KeyValueIterable.html">KeyValueIterable</a></code> is a data structure which has a <code>keyValueIterator()</code> method to iterate over key-value-pairs.</p></td></tr><tr class="type"><td style="width:200px;"><a href="./KeyValueIterator.html" title=".KeyValueIterator">KeyValueIterator</a></td><td><p>A <code><a href="./KeyValueIterator.html">KeyValueIterator</a></code> is an <code><a href="./Iterator.html">Iterator</a></code> that has a key and a value.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Lambda.html" title=".Lambda">Lambda</a></td><td><p>The <code><a href="./Lambda.html">Lambda</a></code> class is a collection of methods to support functional programming. It is ideally used with <code>using <a href="./Lambda.html">Lambda</a></code> and then acts as an extension to Iterable types.</p></td></tr><tr class="type"><td style="width:200px;"><a href="./List.html" title=".List">List</a></td><td><p></p></td></tr><tr class="type"><td style="width:200px;"><a href="./Map.html" title=".Map">Map</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="./Math.html" title=".Math">Math</a></td><td><p>This class defines mathematical functions and constants.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Null.html" title=".Null">Null</a></td><td><p><code><a href="./Null.html">Null</a><T></code> is a wrapper that can be used to make the basic types <code><a href="./Int.html">Int</a></code>, <code><a href="./Float.html">Float</a></code> and <code><a href="./Bool.html">Bool</a></code> nullable on static targets.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Reflect.html" title=".Reflect">Reflect</a></td><td><p>The Reflect API is a way to manipulate values dynamically through an abstract interface in an untyped manner. Use with care.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Single.html" title=".Single">Single</a></td><td><p>Single-precision IEEE 32bit float (4-byte).</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Std.html" title=".Std">Std</a></td><td><p>The Std class provides standard methods for manipulating basic types.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./String.html" title=".String">String</a></td><td><p>The basic String class.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./StringBuf.html" title=".StringBuf">StringBuf</a></td><td><p>A String buffer is an efficient way to build a big string by appending small elements together.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./StringTools.html" title=".StringTools">StringTools</a></td><td><p>This class provides advanced methods on Strings. It is ideally used with <code>using <a href="./StringTools.html">StringTools</a></code> and then acts as an <a href="https://haxe.org/manual/lf-static-extension.html">extension</a> to the <code><a href="./String.html">String</a></code> class.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Sys.html" title=".Sys">Sys</a></td><td><p>This class provides access to various base functions of system platforms. Look in the <code>sys</code> package for more system APIs.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./SysError.html" title=".SysError">SysError</a></td><td><p></p></td></tr><tr class="class"><td style="width:200px;"><a href="./Type.html" title=".Type">Type</a></td><td><p>The Haxe Reflection API allows retrieval of type information at runtime.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./UInt.html" title=".UInt">UInt</a></td><td><p>The unsigned <code><a href="./Int.html">Int</a></code> type is only defined for Flash and C#. Simulate it for other platforms.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./UnicodeString.html" title=".UnicodeString">UnicodeString</a></td><td><p>This abstract provides consistent cross-target unicode support for characters of any width.</p></td></tr><tr class="enum"><td style="width:200px;"><a href="./ValueType.html" title=".ValueType">ValueType</a></td><td><p>The different possible runtime types of a value.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./Void.html" title=".Void">Void</a></td><td><p>The standard <code><a href="./Void.html">Void</a></code> type. Only <code>null</code> values can be of the type <code><a href="./Void.html">Void</a></code>.</p></td></tr><tr class="class"><td style="width:200px;"><a href="./Xml.html" title=".Xml">Xml</a></td><td><p>Cross-platform Xml API.</p></td></tr><tr class="abstract"><td style="width:200px;"><a href="./XmlType.html" title=".XmlType">XmlType</a></td><td><p>Xml node types.</p></td></tr></tbody></table></div></div></div><footer class="section dark site-footer"><div class="container"><div class="copyright"><p>This documentation is generated for version 4.3.5</p><p>© 2024  <a href="https://haxe.org/foundation/" title="Haxe Foundation Website" rel="external" class="hf-link">Haxe Foundation</a> | <a href="https://github.com/HaxeFoundation/haxe" rel="external" title="Haxe on Github">Contribute to Haxe</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/><script async="async" src="https://www.googletagmanager.com/gtag/js?id=UA-30943311-8"></script><script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);} gtag('js', new Date());gtag('config', 'UA-30943311-8');</script></body></html>