Skip to content
This repository has been archived by the owner on Dec 2, 2024. It is now read-only.

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ 81ee89d 🚀
Browse files Browse the repository at this point in the history
luboslenco committed Feb 4, 2024
0 parents commit d5ca385
Showing 1,751 changed files with 35,950 additions and 0 deletions.
1 change: 1 addition & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html><html lang="en"><!-- use theme color or fallback --><!--use textcolor from settings, otherwise create a contrasting color to theme color--><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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>File not found - Armory 3D Engine</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>.navbar .brand {display: inline-block;float: none;text-shadow: 0 0 0 transparent;}</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><script type="text/javascript">$(document).ready(errorSearch);</script><h1><small>404</small> Page not found</h1><p>Page not found, sorry.</p></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
16 changes: 16 additions & 0 deletions Any.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Any - Armory 3D Engine</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><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Any(<a class="type" title="Dynamic - 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><span class="label label-meta label-meta-forward.variance" title="">@:forward.variance</span></div><div class="body"><div class="doc doc-main"><p><code><a href="./Any.html">Any</a></code> is a type that is compatible with any other in both ways.</p>
<p>This means that a value of any type can be assigned to <code><a href="./Any.html">Any</a></code>, and
vice-versa, a value of <code><a href="./Any.html">Any</a></code> type can be assigned to any other type.</p>
<p>It's a more type-safe alternative to <code><a href="./Dynamic.html">Dynamic</a></code>, because it doesn't
support field access or operators and it's bound to monomorphs. So,
to work with the actual value, it needs to be explicitly promoted
to another type.</p></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
115 changes: 115 additions & 0 deletions Array.html

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions ArrayAccess.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>ArrayAccess - Armory 3D Engine</title><meta name="description" content="&lt;code&gt;&lt;a href=&quot;./ArrayAccess.html&quot;&gt;ArrayAccess&lt;/a&gt;&lt;/code&gt; is used to indicate a class that can be accessed using brackets.
The type parameter represents the type of the elements stored."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>interface</small> ArrayAccess&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4> </div><div class="body"><div class="doc doc-main"><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>
<p>This interface should be used for externs only. Haxe does not support custom
array access on classes. However, array access can be implemented for
abstract types.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-abstract-array-access.html">https://haxe.org/manual/types-abstract-array-access.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
12 changes: 12 additions & 0 deletions Bool.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Bool - Armory 3D Engine</title><meta name="description" content="The standard Boolean type, which can either be &lt;code&gt;&lt;a href=&quot;./Bool.html&quot;&gt;true&lt;/a&gt;&lt;/code&gt; or &lt;code&gt;&lt;a href=&quot;./Bool.html&quot;&gt;false&lt;/a&gt;&lt;/code&gt;."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Bool</h1><h4><small><a href="./">no package</a></small></h4><h4></h4><span class="label label-meta label-meta-valueUsed" title="Internally used by DCE to mark an abstract value as used.">@:valueUsed</span><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span><span class="label label-meta label-meta-notNull" title="Declares an abstract type as not accepting null values.">@:notNull</span><span class="label label-meta label-meta-runtimeValue" title="Marks an abstract as being a runtime value.">@:runtimeValue</span></div><div class="body"><div class="doc doc-main"><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>
<p>On static targets, <code>null</code> cannot be assigned to <code><a href="./Bool.html">Bool</a></code>. If this is necessary,
<code><a href="./Null.html">Null</a>&lt;<a href="./Bool.html">Bool</a>&gt;</code> can be used instead.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-bool.html">https://haxe.org/manual/types-bool.html</a></p></div></li><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-nullability.html">https://haxe.org/manual/types-nullability.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
api.armory3d.org
11 changes: 11 additions & 0 deletions Class.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Class - Armory 3D Engine</title><meta name="description" content="An abstract type that represents a Class."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Class&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4><h4></h4><span class="label label-meta label-meta-valueUsed" title="Internally used by DCE to mark an abstract value as used.">@:valueUsed</span><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span><span class="label label-meta label-meta-runtimeValue" title="Marks an abstract as being a runtime value.">@:runtimeValue</span></div><div class="body"><div class="doc doc-main"><p>An abstract type that represents a Class.</p>
<p>See <code><a href="./Type.html">Type</a></code> for the Haxe Reflection API.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-class-instance.html">https://haxe.org/manual/types-class-instance.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
40 changes: 40 additions & 0 deletions Date.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Date - Armory 3D Engine</title><meta name="description" content="The Date class provides a basic structure for date and time related
information. Date instances can be created by"/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Date</h1><h4><small><a href="./">no package</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-coreApi" title="Identifies this class as a core API class (forces API check).">@:coreApi</span></div><div class="body"><div class="doc doc-main"><p>The Date class provides a basic structure for date and time related
information. Date instances can be created by</p><ul><li><code>new <a href="./Date.html">Date</a>()</code> for a specific date,</li><li><code><a href="./Date.html#now">Date.now</a>()</code> to obtain information about the current time,</li><li><code><a href="./Date.html#fromTime">Date.fromTime</a>()</code> with a given timestamp or</li><li><code><a href="./Date.html#fromString">Date.fromString</a>()</code> by parsing from a String.</li></ul>
<p>There are some extra functions available in the <code><a href="./DateTools.html">DateTools</a></code> class.</p>
<p>In the context of Haxe dates, a timestamp is defined as the number of
milliseconds elapsed since 1st January 1970 UTC.</p>
<h2>Supported range</h2>
<p>Due to platform limitations, only dates in the range 1970 through 2038 are
supported consistently. Some targets may support dates outside this range,
depending on the OS at runtime. The <code><a href="./Date.html#fromTime">Date.fromTime</a></code> method will not work with
timestamps outside the range on any target.</p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="fromString"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#fromString"><span class="identifier">fromString</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a></code></h3><div class="doc"><p>Creates a Date from the formatted string <code>s</code>. The following formats are
accepted by the function:</p><ul><li><code>"YYYY-MM-DD hh:mm:ss"</code></li><li><code>"YYYY-MM-DD"</code></li><li><code>"hh:mm:ss"</code></li></ul>
<p>The first two formats expressed a date in local time. The third is a time
relative to the UTC epoch.</p></div></div><div class="field "><a name="fromTime"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#fromTime"><span class="identifier">fromTime</span></a>(<span style="white-space:nowrap">t:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a></code></h3><div class="doc"><p>Creates a Date from the timestamp (in milliseconds) <code>t</code>.</p></div></div><div class="field "><a name="now"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#now"><span class="identifier">now</span></a>():<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a></code></h3><div class="doc"><p>Returns a Date representing the current local time.</p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">year:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">month:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">day:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">hour:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">min:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">sec:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></span>)</code></h3><div class="doc"><p>Creates a new date object from the given arguments.</p>
<p>The behaviour of a Date instance is only consistent across platforms if
the the arguments describe a valid date.</p><ul><li>month: 0 to 11 (note that this is zero-based)</li><li>day: 1 to 31</li><li>hour: 0 to 23</li><li>min: 0 to 59</li><li>sec: 0 to 59</li></ul></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="getDate"></a><h3 class="anchor"><code><a href="#getDate"><span class="identifier">getDate</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the day of <code>this</code> Date (1-31 range) in the local timezone.</p></div></div><div class="field "><a name="getDay"></a><h3 class="anchor"><code><a href="#getDay"><span class="identifier">getDay</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the day of the week of <code>this</code> Date (0-6 range, where <code>0</code> is Sunday)
in the local timezone.</p></div></div><div class="field "><a name="getFullYear"></a><h3 class="anchor"><code><a href="#getFullYear"><span class="identifier">getFullYear</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the full year of <code>this</code> Date (4 digits) in the local timezone.</p></div></div><div class="field "><a name="getHours"></a><h3 class="anchor"><code><a href="#getHours"><span class="identifier">getHours</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the hours of <code>this</code> Date (0-23 range) in the local timezone.</p></div></div><div class="field "><a name="getMinutes"></a><h3 class="anchor"><code><a href="#getMinutes"><span class="identifier">getMinutes</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the minutes of <code>this</code> Date (0-59 range) in the local timezone.</p></div></div><div class="field "><a name="getMonth"></a><h3 class="anchor"><code><a href="#getMonth"><span class="identifier">getMonth</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the month of <code>this</code> Date (0-11 range) in the local timezone.
Note that the month number is zero-based.</p></div></div><div class="field "><a name="getSeconds"></a><h3 class="anchor"><code><a href="#getSeconds"><span class="identifier">getSeconds</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the seconds of <code>this</code> Date (0-59 range) in the local timezone.</p></div></div><div class="field "><a name="getTime"></a><h3 class="anchor"><code><a href="#getTime"><span class="identifier">getTime</span></a>():<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Returns the timestamp (in milliseconds) of <code>this</code> date.
On cpp and neko, this function only has a second resolution, so the
result will always be a multiple of <code>1000.0</code>, e.g. <code>1454698271000.0</code>.
To obtain the current timestamp with better precision on cpp and neko,
see the <code>Sys.time</code> API.</p>
<p>For measuring time differences with millisecond accuracy on
all platforms, see <code>haxe.Timer.stamp</code>.</p></div></div><div class="field "><a name="getTimezoneOffset"></a><h3 class="anchor"><code><a href="#getTimezoneOffset"><span class="identifier">getTimezoneOffset</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the time zone difference of <code>this</code> Date in the current locale
to UTC, in minutes.</p>
<p>Assuming the function is executed on a machine in a UTC+2 timezone,
<code><a href="./Date.html#now">Date.now</a>().getTimezoneOffset()</code> will return <code>-120</code>.</p></div></div><div class="field "><a name="getUTCDate"></a><h3 class="anchor"><code><a href="#getUTCDate"><span class="identifier">getUTCDate</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the day of <code>this</code> Date (1-31 range) in UTC.</p></div></div><div class="field "><a name="getUTCDay"></a><h3 class="anchor"><code><a href="#getUTCDay"><span class="identifier">getUTCDay</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the day of the week of <code>this</code> Date (0-6 range, where <code>0</code> is Sunday)
in UTC.</p></div></div><div class="field "><a name="getUTCFullYear"></a><h3 class="anchor"><code><a href="#getUTCFullYear"><span class="identifier">getUTCFullYear</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the full year of <code>this</code> Date (4 digits) in UTC.</p></div></div><div class="field "><a name="getUTCHours"></a><h3 class="anchor"><code><a href="#getUTCHours"><span class="identifier">getUTCHours</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the hours of <code>this</code> Date (0-23 range) in UTC.</p></div></div><div class="field "><a name="getUTCMinutes"></a><h3 class="anchor"><code><a href="#getUTCMinutes"><span class="identifier">getUTCMinutes</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the minutes of <code>this</code> Date (0-59 range) in UTC.</p></div></div><div class="field "><a name="getUTCMonth"></a><h3 class="anchor"><code><a href="#getUTCMonth"><span class="identifier">getUTCMonth</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the month of <code>this</code> Date (0-11 range) in UTC.
Note that the month number is zero-based.</p></div></div><div class="field "><a name="getUTCSeconds"></a><h3 class="anchor"><code><a href="#getUTCSeconds"><span class="identifier">getUTCSeconds</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the seconds of <code>this</code> Date (0-59 range) in UTC.</p></div></div><div class="field "><a name="toString"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#toString"><span class="identifier">toString</span></a>():<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Returns a string representation of <code>this</code> Date in the local timezone
using the standard format <code>YYYY-MM-DD HH:MM:SS</code>. See <code><a href="./DateTools.html#format">DateTools.format</a></code> for
other formatting rules.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
32 changes: 32 additions & 0 deletions DateTools.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>DateTools - Armory 3D Engine</title><meta name="description" content="The DateTools class contains some extra functionalities for handling &lt;code&gt;&lt;a href=&quot;./Date.html&quot;&gt;Date&lt;/a&gt;&lt;/code&gt;
instances and timestamps."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> DateTools</h1><h4><small><a href="./">no package</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span></div><div class="body"><div class="doc doc-main"><p>The DateTools class contains some extra functionalities for handling <code><a href="./Date.html">Date</a></code>
instances and timestamps.</p>
<p>In the context of Haxe dates, a timestamp is defined as the number of
milliseconds elapsed since 1st January 1970.</p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="days"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#days"><span class="identifier">days</span></a>(<span style="white-space:nowrap">n:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Converts a number of days to a timestamp.</p></div></div><div class="field "><a name="delta"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#delta"><span class="identifier">delta</span></a>(<span style="white-space:nowrap">d:<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a>,</span> <span style="white-space:nowrap">t:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a></code></h3><div class="doc"><p>Returns the result of adding timestamp <code>t</code> to Date <code>d</code>.</p>
<p>This is a convenience function for calling
<code><a href="./Date.html#fromTime">Date.fromTime</a>(d.getTime() + t)</code>.</p></div></div><div class="field "><a name="format"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#format"><span class="identifier">format</span></a>(<span style="white-space:nowrap">d:<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a>,</span> <span style="white-space:nowrap">f:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Format the date <code>d</code> according to the format <code>f</code>. The format is
compatible with the <code>strftime</code> standard format, except that there is no
support in Flash and JS for day and months names (due to lack of proper
internationalization API). On Haxe/Neko/Windows, some formats are not
supported.</p>
<pre><code class="prettyprint haxe">var t = DateTools.format(Date.now(), "%Y-%m-%d_%H:%M:%S");
// 2016-07-08_14:44:05

var t = DateTools.format(Date.now(), "%r");
// 02:44:05 PM

var t = DateTools.format(Date.now(), "%T");
// 14:44:05

var t = DateTools.format(Date.now(), "%F");
// 2016-07-08</code></pre></div></div><div class="field "><a name="getMonthDays"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#getMonthDays"><span class="identifier">getMonthDays</span></a>(<span style="white-space:nowrap">d:<a class="type" title="Date - The Date class provides a basic structure for date and time related information." href="./Date.html">Date</a></span>):<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Returns the number of days in the month of Date <code>d</code>.</p>
<p>This method handles leap years.</p></div></div><div class="field "><a name="hours"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#hours"><span class="identifier">hours</span></a>(<span style="white-space:nowrap">n:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Converts a number of hours to a timestamp.</p></div></div><div class="field "><a name="make"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#make"><span class="identifier">make</span></a>(<span style="white-space:nowrap">o:{seconds:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, ms:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a>, minutes:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, hours:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, days:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>}</span>):<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Build a date-time from several components</p></div></div><div class="field "><a name="makeUtc"></a><h3 class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="Used by the typer to mark fields that have untyped expressions.">@:has_untyped</span><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#makeUtc"><span class="identifier">makeUtc</span></a>(<span style="white-space:nowrap">year:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">month:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">day:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">hour:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">min:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">sec:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></span>):<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Retrieve Unix timestamp value from Date components. Takes same argument sequence as the Date constructor.</p></div></div><div class="field "><a name="minutes"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#minutes"><span class="identifier">minutes</span></a>(<span style="white-space:nowrap">n:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Converts a number of minutes to a timestamp.</p></div></div><div class="field "><a name="parse"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#parse"><span class="identifier">parse</span></a>(<span style="white-space:nowrap">t:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):{seconds:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, ms:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a>, minutes:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, hours:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, days:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>}</code></h3><div class="doc"><p>Separate a date-time into several components</p></div></div><div class="field "><a name="seconds"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#seconds"><span class="identifier">seconds</span></a>(<span style="white-space:nowrap">n:<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></h3><div class="doc"><p>Converts a number of seconds to a timestamp.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
13 changes: 13 additions & 0 deletions Dynamic.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Dynamic - Armory 3D Engine</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><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Dynamic&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4><h4></h4><span class="label label-meta label-meta-valueUsed" title="Internally used by DCE to mark an abstract value as used.">@:valueUsed</span><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span><span class="label label-meta label-meta-runtimeValue" title="Marks an abstract as being a runtime value.">@:runtimeValue</span></div><div class="body"><div class="doc doc-main"><p><code><a href="./Dynamic.html">Dynamic</a></code> is a special type which is compatible with all other types.</p>
<p>Use of <code><a href="./Dynamic.html">Dynamic</a></code> should be minimized as it prevents several compiler
checks and optimizations. See <code><a href="./Any.html">Any</a></code> type for a safer alternative for
representing values of any type.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-dynamic.html">https://haxe.org/manual/types-dynamic.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
74 changes: 74 additions & 0 deletions EReg.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>EReg - Armory 3D Engine</title><meta name="description" content="The EReg class represents regular expressions."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> EReg</h1><h4><small><a href="./">no package</a></small></h4> <span class="label label-meta label-meta-directlyUsed" title="Marks types that are directly referenced by non-extern code.">@:directlyUsed</span><span class="label label-meta label-meta-coreApi" title="Identifies this class as a core API class (forces API check).">@:coreApi</span></div><div class="body"><div class="doc doc-main"><p>The EReg class represents regular expressions.</p>
<p>While basic usage and patterns consistently work across platforms, some more
complex operations may yield different results. This is a necessary trade-
off to retain a certain level of performance.</p>
<p>EReg instances can be created by calling the constructor, or with the
special syntax <code>~/pattern/modifier</code></p>
<p>EReg instances maintain an internal state, which is affected by several of
its methods.</p>
<p>A detailed explanation of the supported operations is available at
<a href="https://haxe.org/manual/std-regex.html">https://haxe.org/manual/std-regex.html</a></p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="escape"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#escape"><span class="identifier">escape</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Escape the string <code>s</code> for use as a part of regular expression.</p>
<p>If <code>s</code> is null, the result is unspecified.</p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#new"><span class="identifier">new</span></a>(<span style="white-space:nowrap">r:<a class="type" title="String - The basic String class." href="./String.html">String</a>,</span> <span style="white-space:nowrap">opt:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>)</code></h3><div class="doc"><p>Creates a new regular expression with pattern <code>r</code> and modifiers <code>opt</code>.</p>
<p>This is equivalent to the shorthand syntax <code>~/r/opt</code></p>
<p>If <code>r</code> or <code>opt</code> are null, the result is unspecified.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="map"></a><h3 class="anchor"><code><a href="#map"><span class="identifier">map</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a>,</span> <span style="white-space:nowrap">f:<a class="type" title="EReg - The EReg class represents regular expressions." href="./EReg.html">EReg</a>&nbsp;&#8209;&gt;&nbsp;<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Calls the function <code>f</code> for the substring of <code>s</code> which <code>this</code> EReg matches
and replaces that substring with the result of <code>f</code> call.</p>
<p>The <code>f</code> function takes <code>this</code> EReg object as its first argument and should
return a replacement string for the substring matched.</p>
<p>If <code>this</code> EReg does not match any substring, the result is <code>s</code>.</p>
<p>By default, this method replaces only the first matched substring. If
the global g modifier is in place, all matched substrings are replaced.</p>
<p>If <code>s</code> or <code>f</code> are null, the result is unspecified.</p></div></div><div class="field "><a name="match"></a><h3 class="anchor"><code><a href="#match"><span class="identifier">match</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></h3><div class="doc"><p>Tells if <code>this</code> regular expression matches String <code>s</code>.</p>
<p>This method modifies the internal state.</p>
<p>If <code>s</code> is <code>null</code>, the result is unspecified.</p></div></div><div class="field "><a name="matchSub"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ len : -1 })</span><a href="#matchSub"><span class="identifier">matchSub</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a>,</span> <span style="white-space:nowrap">pos:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">len:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a> = -1</span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></h3><div class="doc"><p>Tells if <code>this</code> regular expression matches a substring of String <code>s</code>.</p>
<p>This function expects <code>pos</code> and <code>len</code> to describe a valid substring of
<code>s</code>, or else the result is unspecified. To get more robust behavior,
<code>this.<a href="#match">match</a>(s.substr(pos,len))</code> can be used instead.</p>
<p>This method modifies the internal state.</p>
<p>If <code>s</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="matched"></a><h3 class="anchor"><code><a href="#matched"><span class="identifier">matched</span></a>(<span style="white-space:nowrap">n:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></span>):<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Returns the matched sub-group <code>n</code> of <code>this</code> EReg.</p>
<p>This method should only be called after <code>this.<a href="#match">match</a></code> or
<code>this.<a href="#matchSub">matchSub</a></code>, and then operates on the String of that operation.</p>
<p>The index <code>n</code> corresponds to the n-th set of parentheses in the pattern
of <code>this</code> EReg. If no such sub-group exists, the result is unspecified.</p>
<p>If <code>n</code> equals 0, the whole matched substring is returned.</p></div></div><div class="field "><a name="matchedLeft"></a><h3 class="anchor"><code><a href="#matchedLeft"><span class="identifier">matchedLeft</span></a>():<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Returns the part to the left of the last matched substring.</p>
<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
match anything, the result is unspecified.</p>
<p>If the global g modifier was in place for the matching, only the
substring to the left of the leftmost match is returned.</p>
<p>The result does not include the matched part.</p></div></div><div class="field "><a name="matchedPos"></a><h3 class="anchor"><code><a href="#matchedPos"><span class="identifier">matchedPos</span></a>():{pos:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>, len:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a>}</code></h3><div class="doc"><p>Returns the position and length of the last matched substring, within
the String which was last used as argument to <code>this.<a href="#match">match</a></code> or
<code>this.<a href="#matchSub">matchSub</a></code>.</p>
<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
match anything, the result is unspecified.</p>
<p>If the global g modifier was in place for the matching, the position and
length of the leftmost substring is returned.</p></div></div><div class="field "><a name="matchedRight"></a><h3 class="anchor"><code><a href="#matchedRight"><span class="identifier">matchedRight</span></a>():<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Returns the part to the right of the last matched substring.</p>
<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
match anything, the result is unspecified.</p>
<p>If the global g modifier was in place for the matching, only the
substring to the right of the leftmost match is returned.</p>
<p>The result does not include the matched part.</p></div></div><div class="field "><a name="replace"></a><h3 class="anchor"><code><span class="label label-inline">inline</span><a href="#replace"><span class="identifier">replace</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a>,</span> <span style="white-space:nowrap">by:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="String - The basic String class." href="./String.html">String</a></code></h3><div class="doc"><p>Replaces the first substring of <code>s</code> which <code>this</code> EReg matches with <code>by</code>.</p>
<p>If <code>this</code> EReg does not match any substring, the result is <code>s</code>.</p>
<p>By default, this method replaces only the first matched substring. If
the global g modifier is in place, all matched substrings are replaced.</p>
<p>If <code>by</code> contains <code>$1</code> to <code>$9</code>, the digit corresponds to number of a
matched sub-group and its value is used instead. If no such sub-group
exists, the replacement is unspecified. The string <code>$$</code> becomes <code>$</code>.</p>
<p>If <code>s</code> or <code>by</code> are null, the result is unspecified.</p></div></div><div class="field "><a name="split"></a><h3 class="anchor"><code><a href="#split"><span class="identifier">split</span></a>(<span style="white-space:nowrap">s:<a class="type" title="String - The basic String class." href="./String.html">String</a></span>):<a class="type" title="Array" href="./Array.html">Array</a>&lt;<a class="type" title="String - The basic String class." href="./String.html">String</a>&gt;</code></h3><div class="doc"><p>Splits String <code>s</code> at all substrings <code>this</code> EReg matches.</p>
<p>If a match is found at the start of <code>s</code>, the result contains a leading
empty String "" entry.</p>
<p>If a match is found at the end of <code>s</code>, the result contains a trailing
empty String "" entry.</p>
<p>If two matching substrings appear next to each other, the result
contains the empty String <code>""</code> between them.</p>
<p>By default, this method splits <code>s</code> into two parts at the first matched
substring. If the global g modifier is in place, <code>s</code> is split at each
matched substring.</p>
<p>If <code>s</code> is null, the result is unspecified.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
12 changes: 12 additions & 0 deletions Enum.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Enum - Armory 3D Engine</title><meta name="description" content="An abstract type that represents an Enum type."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Enum&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4><h4></h4><span class="label label-meta label-meta-valueUsed" title="Internally used by DCE to mark an abstract value as used.">@:valueUsed</span><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span><span class="label label-meta label-meta-runtimeValue" title="Marks an abstract as being a runtime value.">@:runtimeValue</span></div><div class="body"><div class="doc doc-main"><p>An abstract type that represents an Enum type.</p>
<p>The corresponding enum instance type is <code><a href="./EnumValue.html">EnumValue</a></code>.</p>
<p>See <code><a href="./Type.html">Type</a></code> for the Haxe Reflection API.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-enum-instance.html">https://haxe.org/manual/types-enum-instance.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
28 changes: 28 additions & 0 deletions EnumValue.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>EnumValue - Armory 3D Engine</title><meta name="description" content="An abstract type that represents any enum value.
See &lt;code&gt;&lt;a href=&quot;./Type.html&quot;&gt;Type&lt;/a&gt;&lt;/code&gt; for the Haxe Reflection API."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> EnumValue</h1><h4><small><a href="./">no package</a></small></h4><h4></h4><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span></div><div class="body"><div class="doc doc-main"><p>An abstract type that represents any enum value.
See <code><a href="./Type.html">Type</a></code> for the Haxe Reflection API.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-enum-instance.html">https://haxe.org/manual/types-enum-instance.html</a></p></div></li></ul></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="match"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#match"><span class="identifier">match</span></a>(<span style="white-space:nowrap">this:<a class="type" title="EnumValue - An abstract type that represents any enum value." href="./EnumValue.html">EnumValue</a>,</span> <span style="white-space:nowrap">pattern:<a class="type" title="Dynamic - Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a></span>):<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></h3><div class="doc"><p>Matches enum instance <code>e</code> against pattern <code>pattern</code>, returning <code><a href="./Bool.html">true</a></code> if
matching succeeded and <code><a href="./Bool.html">false</a></code> otherwise.</p>
<p>Example usage:</p>
<pre><code class="prettyprint haxe">if (e.match(pattern)) {
// codeIfTrue
} else {
// codeIfFalse
}</code></pre>
<p>This is equivalent to the following code:</p>
<pre><code class="prettyprint haxe">switch (e) {
case pattern:
// codeIfTrue
case _:
// codeIfFalse
}</code></pre>
<p>This method is implemented in the compiler. This definition exists only
for documentation.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
14 changes: 14 additions & 0 deletions Float.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Float - Armory 3D Engine</title><meta name="description" content="The standard &lt;code&gt;&lt;a href=&quot;./Float.html&quot;&gt;Float&lt;/a&gt;&lt;/code&gt; type, this is a double-precision IEEE 64bit float."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Float</h1><h4><small><a href="./">no package</a></small></h4><h4></h4><span class="label label-meta label-meta-valueUsed" title="Internally used by DCE to mark an abstract value as used.">@:valueUsed</span><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span><span class="label label-meta label-meta-notNull" title="Declares an abstract type as not accepting null values.">@:notNull</span><span class="label label-meta label-meta-runtimeValue" title="Marks an abstract as being a runtime value.">@:runtimeValue</span></div><div class="body"><div class="doc doc-main"><p>The standard <code><a href="./Float.html">Float</a></code> type, this is a double-precision IEEE 64bit float.</p>
<p>On static targets, <code>null</code> cannot be assigned to Float. If this is necessary,
<code><a href="./Null.html">Null</a>&lt;<a href="./Float.html">Float</a>&gt;</code> can be used instead.</p>
<p><code><a href="./Std.html#int">Std.int</a></code> converts a <code><a href="./Float.html">Float</a></code> to an <code><a href="./Int.html">Int</a></code>, rounded towards 0.
<code><a href="./Std.html#parseFloat">Std.parseFloat</a></code> converts a <code><a href="./String.html">String</a></code> to a <code><a href="./Float.html">Float</a></code>.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-basic-types.html">https://haxe.org/manual/types-basic-types.html</a></p></div></li><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-nullability.html">https://haxe.org/manual/types-nullability.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
14 changes: 14 additions & 0 deletions Int.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Int - Armory 3D Engine</title><meta name="description" content="The standard &lt;code&gt;&lt;a href=&quot;./Int.html&quot;&gt;Int&lt;/a&gt;&lt;/code&gt; type. Its precision depends on the platform."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>abstract</small> Int</h1><h4><small><a href="./">no package</a></small></h4><h4><small> to <a class="type" title="Float - The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></small></h4><span class="label label-meta label-meta-valueUsed" title="Internally used by DCE to mark an abstract value as used.">@:valueUsed</span><span class="label label-meta label-meta-coreType" title="Identifies an abstract as core type so that it requires no implementation.">@:coreType</span><span class="label label-meta label-meta-notNull" title="Declares an abstract type as not accepting null values.">@:notNull</span><span class="label label-meta label-meta-runtimeValue" title="Marks an abstract as being a runtime value.">@:runtimeValue</span></div><div class="body"><div class="doc doc-main"><p>The standard <code><a href="./Int.html">Int</a></code> type. Its precision depends on the platform.</p>
<p>On static targets, <code>null</code> cannot be assigned to <code><a href="./Int.html">Int</a></code>. If this is necessary,
<code><a href="./Null.html">Null</a>&lt;<a href="./Int.html">Int</a>&gt;</code> can be used instead.</p>
<p><code><a href="./Std.html#int">Std.int</a></code> converts a <code><a href="./Float.html">Float</a></code> to an <code><a href="./Int.html">Int</a></code>, rounded towards 0.
<code><a href="./Std.html#parseInt">Std.parseInt</a></code> converts a <code><a href="./String.html">String</a></code> to an <code><a href="./Int.html">Int</a></code>.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-basic-types.html">https://haxe.org/manual/types-basic-types.html</a></p></div></li><li><div class="inline-content"><p><a href="https://haxe.org/manual/std-math-integer-math.html">https://haxe.org/manual/std-math-integer-math.html</a></p></div></li><li><div class="inline-content"><p><a href="https://haxe.org/manual/types-nullability.html">https://haxe.org/manual/types-nullability.html</a></p></div></li></ul></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
18 changes: 18 additions & 0 deletions IntIterator.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>IntIterator - Armory 3D Engine</title><meta name="description" content="IntIterator is used for implementing interval iterations."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> IntIterator</h1><h4><small><a href="./">no package</a></small></h4> </div><div class="body"><div class="doc doc-main"><p>IntIterator is used for implementing interval iterations.</p>
<p>It is usually not used explicitly, but through its special syntax:
<code>min...max</code></p>
<p>While it is possible to assign an instance of IntIterator to a variable or
field, it is worth noting that IntIterator does not reset after being used
in a for-loop. Subsequent uses of the same instance will then have no
effect.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/lf-iterators.html">https://haxe.org/manual/lf-iterators.html</a></p></div></li></ul></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3 class="anchor"><code><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="Int - The standard Int type." href="./Int.html">Int</a>,</span> <span style="white-space:nowrap">max:<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></span>)</code></h3><div class="doc"><p>Iterates from <code>min</code> (inclusive) to <code>max</code> (exclusive).</p>
<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 class="anchor"><code><span class="label label-inline">inline</span><a href="#hasNext"><span class="identifier">hasNext</span></a>():<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></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 class="anchor"><code><span class="label label-inline">inline</span><a href="#next"><span class="identifier">next</span></a>():<a class="type" title="Int - The standard Int type." href="./Int.html">Int</a></code></h3><div class="doc"><p>Moves to the next item of the iterator.</p>
<p>If this is called while hasNext() is false, the result is unspecified.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
12 changes: 12 additions & 0 deletions Iterable.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Iterable - Armory 3D Engine</title><meta name="description" content="An &lt;code&gt;&lt;a href=&quot;./Iterable.html&quot;&gt;Iterable&lt;/a&gt;&lt;/code&gt; is a data structure which has an &lt;code&gt;iterator()&lt;/code&gt; method.
See &lt;code&gt;&lt;a href=&quot;./Lambda.html&quot;&gt;Lambda&lt;/a&gt;&lt;/code&gt; for generic functions on iterable structures."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>typedef</small> Iterable&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4></div><div class="body"><div class="doc doc-main"><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><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/lf-iterators.html">https://haxe.org/manual/lf-iterators.html</a></p></div></li></ul></div><h3 class="section">Fields</h3><div class="fields"><div class="field "><a name="iterator"></a><h3 class="anchor"><code><a href="#iterator"><span class="identifier">iterator</span></a>():<a class="type" title="Iterator - An Iterator is a structure that permits iteration over elements of type T." href="./Iterator.html">Iterator</a>&lt;<span class="type">T</span>&gt;</code></h3><div class="doc"><p></p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
21 changes: 21 additions & 0 deletions Iterator.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE html>
<html lang="en"><!-- use theme color or fallback -->
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
<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"/><link href="./dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "./",platforms: ["api"]};</script><script src="./nav.js"></script><script src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"/><title>Iterator - Armory 3D Engine</title><meta name="description" content="An &lt;code&gt;&lt;a href=&quot;./Iterator.html&quot;&gt;Iterator&lt;/a&gt;&lt;/code&gt; is a structure that permits iteration over elements of type &lt;code&gt;T&lt;/code&gt;."/></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#cf2b43; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="https://armory3d.org/"><img alt="" src="https://avatars.githubusercontent.com/u/20436620?s=48"/></a><a class="brand" style="color:#ffffff" href="./">Armory 3D Engine</a><a href="#" id="theme-toggle" class="brand" style="color:#ffffff" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></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="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>typedef</small> Iterator&lt;<span class="type">T</span>&gt;</h1><h4><small><a href="./">no package</a></small></h4></div><div class="body"><div class="doc doc-main"><p>An <code><a href="./Iterator.html">Iterator</a></code> is a structure that permits iteration over elements of type <code>T</code>.</p>
<p>Any class with matching <code>hasNext()</code> and <code>next()</code> fields is considered an <code><a href="./Iterator.html">Iterator</a></code>
and can then be used e.g. in <code>for</code>-loops. This makes it easy to implement
custom iterators.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://haxe.org/manual/lf-iterators.html">https://haxe.org/manual/lf-iterators.html</a></p></div></li></ul></div><h3 class="section">Fields</h3><div class="fields"><div class="field "><a name="next"></a><h3 class="anchor"><code><a href="#next"><span class="identifier">next</span></a>():<span class="type">T</span></code></h3><div class="doc"><p>Returns the current item of the <code><a href="./Iterator.html">Iterator</a></code> and advances to the next one.</p>
<p>This method is not required to check <code>hasNext()</code> first. A call to this
method while <code>hasNext()</code> is <code><a href="./Bool.html">false</a></code> yields unspecified behavior.</p>
<p>On the other hand, iterators should not require a call to <code>hasNext()</code>
before the first call to <code>next()</code> if an element is available.</p></div></div><div class="field "><a name="hasNext"></a><h3 class="anchor"><code><a href="#hasNext"><span class="identifier">hasNext</span></a>():<a class="type" title="Bool - The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></h3><div class="doc"><p>Returns <code><a href="./Bool.html">false</a></code> if the iteration is complete, <code><a href="./Bool.html">true</a></code> otherwise.</p>
<p>Usually iteration is considered to be complete if all elements of the
underlying data structure were handled through calls to <code>next()</code>. However,
in custom iterators any logic may be used to determine the completion
state.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#cf2b43"><div class="container"><div class="copyright"><p style="color:#ffffff">&copy; 2024 &nbsp;<a style="color:#ffffff" href="https://armory3d.org/">https://armory3d.org/</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>
Loading

0 comments on commit d5ca385

Please sign in to comment.