Skip to content

Commit 8be5d0b

Browse files
Gama11Gama11
committed
Update /api
1 parent f7b5742 commit 8be5d0b

File tree

493 files changed

+105373
-13646
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

493 files changed

+105373
-13646
lines changed

‎api/Any.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><!-- use theme color or fallback -->
3+
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
4+
<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 type="text/javascript">var dox = {rootPath: "./",platforms: ["types"]};</script><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><title>Any - HaxeFlixel API</title><meta name="description" content="&lt;code&gt;&lt;a href=&quot;./Any.html&quot;&gt;Any&lt;/a&gt;&lt;/code&gt; is a type that is compatible with any other in both ways."/></head><body><nav class="nav"><div class="navbar navbar-inverse navbar-fixed-top"><div class="container"><div class="navbar-header"><button data-target=".navbar-collapse" data-toggle="collapse" class="navbar-toggle" type="button"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button><a href="http://www.haxeflixel.com/" class="navbar-brand"><img src="http://www.haxeflixel.com/images/haxeflixel-header.png" alt="HaxeFlixel"/></a></div><div class="navbar-collapse collapse"><ul class="nav navbar-nav"><li><a href="http://www.haxeflixel.com/demos">Demos</a></li><li><a href="http://www.haxeflixel.com/showcase">Showcase</a></li><li><a href="http://www.haxeflixel.com/blog">Blog</a></li><li><a href="http://www.haxeflixel.com/documentation">Docs</a></li><li class="active"><a href=".">API</a></li><li><a href="http://forum.haxeflixel.com/">Forum</a></li></ul></div></div></div></nav><div class="container main-content navbar-offset"><div class="row-fluid container-main"><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" autocomplete="off"/></div></form></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/HaxeFoundation/haxe/tree/master/std/Any.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>abstract</small> Any(<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a>)</h1><h4><small><a href="./">no package</a></small></h4><h4></h4></div><div class="body"><div class="doc doc-main"><div class="indent"><p><code><a href="./Any.html">Any</a></code> is a type that is compatible with any other in both ways.</p>
5+
<p>This means that a value of any type can be assigned to <code><a href="./Any.html">Any</a></code>, and
6+
vice-versa, a value of <code><a href="./Any.html">Any</a></code> type can be assigned to any other type.</p>
7+
<p>It's a more type-safe alternative to <code><a href="./Dynamic.html">Dynamic</a></code>, because it doesn't
8+
support field access or operators and it's bound to monomorphs. So,
9+
to work with the actual value, it needs to be explicitly promoted
10+
to another type.</p></div></div></div></div></div></div><footer><div class="footer-main"><div class=" container"><div class="footer-social"><iframe width="120px" scrolling="0" height="20px" frameborder="0" allowtransparency="true" src="http://ghbtns.com/github-btn.html?user=HaxeFlixel&amp;repo=flixel&amp;type=watch&amp;count=true&amp;size=small"></iframe><a href="https://twitter.com/haxeflixel" class="twitter-follow-button" data-show-count="true" data-lang="en" data-size="small">Follow @haxeflixel</a><script>!function (d, s, id){var js, fjs = d.getElementsByTagName (s)[0];if (!d.getElementById (id)){js = d.createElement (s);js.id = id;js.src = "//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore (js, fjs);}} (document, "script", "twitter-wjs");</script></div><div class="footer-powered-by"><p>HaxeFlixel is powered by</p><a href="http://haxe.org"><img src="http://www.haxeflixel.com/images/haxe.svg" alt="Haxe" title="Haxe"/></a>+<a href="http://openfl.org"><img class="openfl-footer-logo" src="http://www.haxeflixel.com//images/openfl.svg" alt="OpenFL" title="OpenFL"/></a>+<a href="http://flixel.org"><img class="flixel-footer-logo" src="http://www.haxeflixel.com//images/flixel.svg" alt="Flixel" title="Flixel"/></a></div></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>

‎api/Dynamic.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
44
<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 type="text/javascript">var dox = {rootPath: "./",platforms: ["types"]};</script><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><title>Dynamic - HaxeFlixel API</title><meta name="description" content="&lt;code&gt;&lt;a href=&quot;./Dynamic.html&quot;&gt;Dynamic&lt;/a&gt;&lt;/code&gt; is a special type which is compatible with all other types."/></head><body><nav class="nav"><div class="navbar navbar-inverse navbar-fixed-top"><div class="container"><div class="navbar-header"><button data-target=".navbar-collapse" data-toggle="collapse" class="navbar-toggle" type="button"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></button><a href="http://www.haxeflixel.com/" class="navbar-brand"><img src="http://www.haxeflixel.com/images/haxeflixel-header.png" alt="HaxeFlixel"/></a></div><div class="navbar-collapse collapse"><ul class="nav navbar-nav"><li><a href="http://www.haxeflixel.com/demos">Demos</a></li><li><a href="http://www.haxeflixel.com/showcase">Showcase</a></li><li><a href="http://www.haxeflixel.com/blog">Blog</a></li><li><a href="http://www.haxeflixel.com/documentation">Docs</a></li><li class="active"><a href=".">API</a></li><li><a href="http://forum.haxeflixel.com/">Forum</a></li></ul></div></div></div></nav><div class="container main-content navbar-offset"><div class="row-fluid container-main"><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" autocomplete="off"/></div></form></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><span class="viewsource"><a href="https://github.com/HaxeFoundation/haxe/tree/master/std/StdTypes.hx" class="btn btn-medium"><i class="fa fa-eye"></i> View source</a></span><h1><small>abstract</small> Dynamic&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4><h4></h4></div><div class="body"><div class="doc doc-main"><div class="indent"><p><code><a href="./Dynamic.html">Dynamic</a></code> is a special type which is compatible with all other types.</p>
55
<p>Use of <code><a href="./Dynamic.html">Dynamic</a></code> should be minimized as it prevents several compiler
6-
checks and optimizations. See <code>Any</code> type for a safer alternative for
6+
checks and optimizations. See <code><a href="./Any.html">Any</a></code> type for a safer alternative for
77
representing values of any type.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://haxe.org/manual/types-dynamic.html">https://haxe.org/manual/types-dynamic.html</a></p></div></div></div></div></div></div></div><footer><div class="footer-main"><div class=" container"><div class="footer-social"><iframe width="120px" scrolling="0" height="20px" frameborder="0" allowtransparency="true" src="http://ghbtns.com/github-btn.html?user=HaxeFlixel&amp;repo=flixel&amp;type=watch&amp;count=true&amp;size=small"></iframe><a href="https://twitter.com/haxeflixel" class="twitter-follow-button" data-show-count="true" data-lang="en" data-size="small">Follow @haxeflixel</a><script>!function (d, s, id){var js, fjs = d.getElementsByTagName (s)[0];if (!d.getElementById (id)){js = d.createElement (s);js.id = id;js.src = "//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore (js, fjs);}} (document, "script", "twitter-wjs");</script></div><div class="footer-powered-by"><p>HaxeFlixel is powered by</p><a href="http://haxe.org"><img src="http://www.haxeflixel.com/images/haxe.svg" alt="Haxe" title="Haxe"/></a>+<a href="http://openfl.org"><img class="openfl-footer-logo" src="http://www.haxeflixel.com//images/openfl.svg" alt="OpenFL" title="OpenFL"/></a>+<a href="http://flixel.org"><img class="flixel-footer-logo" src="http://www.haxeflixel.com//images/flixel.svg" alt="Flixel" title="Flixel"/></a></div></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>

‎api/EReg.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@
1919
<code>this.<a href="#matchSub">matchSub</a></code>, and then operates on the String of that operation.</p>
2020
<p>The index <code>n</code> corresponds to the n-th set of parentheses in the pattern
2121
of <code>this</code> EReg. If no such sub-group exists, an exception is thrown.</p>
22-
<p>If <code>n</code> equals 0, the whole matched substring is returned.</p></div></div><div class="field "><a name="matchedPos"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><a href="#matchedPos"><span class="identifier">matchedPos</span></a>():{pos:<a class="type" title="The standard Int type." href="./Int.html">Int</a>, len:<a class="type" title="The standard Int type." href="./Int.html">Int</a>}</code></p></h3><div class="doc"><p>Returns the position and length of the last matched substring, within
22+
<p>If <code>n</code> equals 0, the whole matched substring is returned.</p></div></div><div class="field "><a name="matchedRight"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><a href="#matchedRight"><span class="identifier">matchedRight</span></a>():<a class="type" title="The basic String class." href="./String.html">String</a></code></p></h3><div class="doc"><p>Returns the part to the right of the last matched substring.</p>
23+
<p>If the most recent call to <code>this.<a href="#match">match</a></code> or <code>this.<a href="#matchSub">matchSub</a></code> did not
24+
match anything, the result is unspecified.</p>
25+
<p>If the global g modifier was in place for the matching, only the
26+
substring to the right of the leftmost match is returned.</p>
27+
<p>The result does not include the matched part.</p></div></div><div class="field "><a name="matchedPos"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><a href="#matchedPos"><span class="identifier">matchedPos</span></a>():{pos:<a class="type" title="The standard Int type." href="./Int.html">Int</a>, len:<a class="type" title="The standard Int type." href="./Int.html">Int</a>}</code></p></h3><div class="doc"><p>Returns the position and length of the last matched substring, within
2328
the String which was last used as argument to <code>this.<a href="#match">match</a></code> or
2429
<code>this.<a href="#matchSub">matchSub</a></code>.</p>
2530
<p>If the most recent call to <code>this.<a href="#match">match</a></code> or <code>this.<a href="#matchSub">matchSub</a></code> did not

‎api/IntIterator.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
<p>While it is possible to assign an instance of IntIterator to a variable or
88
field, it is worth noting that IntIterator does not reset after being used
99
in a for-loop. Subsequent uses of the same instance will then have no
10-
effect.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://haxe.org/manual/lf-iterators.html">https://haxe.org/manual/lf-iterators.html</a></p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-inline">inline</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">min:<a class="type" title="The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">max:<a class="type" title="The standard Int type." href="./Int.html">Int</a></span>)</code></p></h3><div class="doc"><p>Iterates from <code>min</code> (inclusive) to <code>max</code> (exclusive).</p>
11-
<p>If <code>max &lt;= min</code>, the iterator will not act as a countdown.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="hasNext"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-inline">inline</span><a href="#hasNext"><span class="identifier">hasNext</span></a>():<a class="type" title="The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></p></h3><div class="doc"><p>Returns true if the iterator has other items, false otherwise.</p></div></div><div class="field "><a name="next"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-inline">inline</span><a href="#next"><span class="identifier">next</span></a>():<a class="type" title="The standard Int type." href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Moves to the next item of the iterator.</p>
10+
effect.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://haxe.org/manual/lf-iterators.html">https://haxe.org/manual/lf-iterators.html</a></p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-inline">inline</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">min:<a class="type" title="The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">max:<a class="type" title="The standard Int type." href="./Int.html">Int</a></span>)</code></p></h3><div class="doc"><p>Iterates from <code>min</code> (inclusive) to <code>max</code> (exclusive).</p>
11+
<p>If <code>max &lt;= min</code>, the iterator will not act as a countdown.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="hasNext"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-inline">inline</span><a href="#hasNext"><span class="identifier">hasNext</span></a>():<a class="type" title="The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></p></h3><div class="doc"><p>Returns true if the iterator has other items, false otherwise.</p></div></div><div class="field "><a name="next"></a><h3><p class="anchor"><code><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-inline">inline</span><a href="#next"><span class="identifier">next</span></a>():<a class="type" title="The standard Int type." href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Moves to the next item of the iterator.</p>
1212
<p>If this is called while hasNext() is false, the result is unspecified.</p></div></div></div></div></div></div></div><footer><div class="footer-main"><div class=" container"><div class="footer-social"><iframe width="120px" scrolling="0" height="20px" frameborder="0" allowtransparency="true" src="http://ghbtns.com/github-btn.html?user=HaxeFlixel&amp;repo=flixel&amp;type=watch&amp;count=true&amp;size=small"></iframe><a href="https://twitter.com/haxeflixel" class="twitter-follow-button" data-show-count="true" data-lang="en" data-size="small">Follow @haxeflixel</a><script>!function (d, s, id){var js, fjs = d.getElementsByTagName (s)[0];if (!d.getElementById (id)){js = d.createElement (s);js.id = id;js.src = "//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore (js, fjs);}} (document, "script", "twitter-wjs");</script></div><div class="footer-powered-by"><p>HaxeFlixel is powered by</p><a href="http://haxe.org"><img src="http://www.haxeflixel.com/images/haxe.svg" alt="Haxe" title="Haxe"/></a>+<a href="http://openfl.org"><img class="openfl-footer-logo" src="http://www.haxeflixel.com//images/openfl.svg" alt="OpenFL" title="OpenFL"/></a>+<a href="http://flixel.org"><img class="flixel-footer-logo" src="http://www.haxeflixel.com//images/flixel.svg" alt="Flixel" title="Flixel"/></a></div></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>

0 commit comments

Comments
 (0)