2025-01-15 19:42:35 +01:00

74 lines
11 KiB
HTML

<!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="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://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="./haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "./",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><title>Std - API Reference</title><meta name="description" content="The Std class provides standard methods for manipulating basic types."/></head><body><style>
a, code .type {
color: #24afc4;
}
.navbar .brand {
display: inline-block;
float: none;
text-shadow: 0 0 0 transparent;
}
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
background: #24afc4;
color: #ffffff;
text-shadow: 0 0 0 transparent;
}
.navbar .container {
width: 940px ;
}
@media (max-width: 767px) {
.navbar .container {
width: auto;
}
}
@media (max-width: 979px) and (min-width: 768px) {
.navbar .container {
width: 724px;
}
}
@media (min-width: 1200px) {
.navbar .container {
width: 1170px;
}
}
.navbar .container img {
margin: 5px 0 0 4px;
}
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="./">API Reference</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="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Std</h1><h4><small><a href="./">no package</a></small></h4> <p class="availability"><hr/><em>Available on all platforms</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The Std class provides standard methods for manipulating basic types.</p></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="instance"></a><h3><p><code><span class="label">static</span><a href="#instance"><span class="identifier">instance</span></a>&lt;<span class="type">T</span>, <span class="type">S</span>&gt; (<span style="white-space:nowrap">value:<span class="type">T</span>,</span> <span style="white-space:nowrap">c:<a class="type" title="An abstract type that represents a Class." href="./Class.html">Class</a>&lt;<span class="type">S</span>&gt;</span>):<span class="type">S</span></code></p></h3><p class="availability"><em>Available on Android, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Checks if object <code>value</code> is an instance of class <code>c</code>.</p>
<p>Compiles only if the class specified by <code>c</code> can be assigned to the type
of <code>value</code>.</p>
<p>This method checks if a downcast is possible. That is, if the runtime
type of <code>value</code> is assignable to the class specified by <code>c</code>, <code>value</code> is
returned. Otherwise null is returned.</p>
<p>This method is not guaranteed to work with interfaces or core types such
as <code><a href="./String.html">String</a></code>, <code><a href="./Array.html">Array</a></code> and <code><a href="./Date.html">Date</a></code>.</p>
<p>If <code>value</code> is null, the result is null. If <code>c</code> is null, the result is
unspecified.</p></div></div><div class="field "><a name="int"></a><h3><p><code><span class="label">static</span><a href="#int"><span class="identifier">int</span></a> (<span style="white-space:nowrap">x:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></span>):<a class="type" title="The standard Int type." href="./Int.html">Int</a></code></p></h3><p class="availability"><em>Available on Neko, Android, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Converts a <code><a href="./Float.html">Float</a></code> to an <code><a href="./Int.html">Int</a></code>, rounded towards 0.</p>
<p>If <code>x</code> is outside of the signed Int32 range, or is <code>NaN</code>, <code>NEGATIVE_INFINITY</code> or <code>POSITIVE_INFINITY</code>, the result is unspecified.</p></div></div><div class="field "><a name="is"></a><h3><p><code><span class="label">static</span><a href="#is"><span class="identifier">is</span></a> (<span style="white-space:nowrap">v:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a>,</span> <span style="white-space:nowrap">t:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="./Bool.html">Bool</a></code></p></h3><p class="availability"><em>Available on Neko, Android, Flash, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Tells if a value <code>v</code> is of the type <code>t</code>. Returns <code>false</code> if <code>v</code> or <code>t</code> are null.</p></div></div><div class="field "><a name="parseFloat"></a><h3><p><code><span class="label">static</span><a href="#parseFloat"><span class="identifier">parseFloat</span></a> (<span style="white-space:nowrap">x:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="./Float.html">Float</a></code></p></h3><p class="availability"><em>Available on Neko, Android, Flash, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Converts a <code><a href="./String.html">String</a></code> to a <code><a href="./Float.html">Float</a></code>.</p>
<p>The parsing rules for <code>parseInt</code> apply here as well, with the exception of invalid input
resulting in a <code>NaN</code> value instead of null.</p>
<p>Additionally, decimal notation may contain a single <code>.</code> to denote the start of the fractions.</p></div></div><div class="field "><a name="parseInt"></a><h3><p><code><span class="label">static</span><a href="#parseInt"><span class="identifier">parseInt</span></a> (<span style="white-space:nowrap">x:<a class="type" title="The basic String class." href="./String.html">String</a></span>):<a class="type" title="Null can be useful in two cases." href="./Null.html">Null</a>&lt;<a class="type" title="The standard Int type." href="./Int.html">Int</a>&gt;</code></p></h3><div class="doc"><p>Converts a <code><a href="./String.html">String</a></code> to an <code><a href="./Int.html">Int</a></code>.</p>
<p>Leading whitespaces are ignored.</p>
<p>If <code>x</code> starts with 0x or 0X, hexadecimal notation is recognized where the following digits may
contain 0-9 and A-F.</p>
<p>Otherwise <code>x</code> is read as decimal number with 0-9 being allowed characters. <code>x</code> may also start with
a - to denote a negative value.</p>
<p>In decimal mode, parsing continues until an invalid character is detected, in which case the
result up to that point is returned. For hexadecimal notation, the effect of invalid characters
is unspecified.</p>
<p>Leading 0s that are not part of the 0x/0X hexadecimal notation are ignored, which means octal
notation is not supported.</p>
<p>If the input cannot be recognized, the result is <code>null</code>.</p></div></div><div class="field "><a name="random"></a><h3><p><code><span class="label">static</span><a href="#random"><span class="identifier">random</span></a> (<span style="white-space:nowrap">x:<a class="type" title="The standard Int type." href="./Int.html">Int</a></span>):<a class="type" title="The standard Int type." href="./Int.html">Int</a></code></p></h3><p class="availability"><em>Available on Android, iOS, macOS, Linux, Windows</em></p><div class="doc"><p>Return a random integer between 0 included and <code>x</code> excluded.</p>
<p>If <code>x &lt;= 1</code>, the result is always 0.</p></div></div><div class="field "><a name="string"></a><h3><p><code><span class="label">static</span><a href="#string"><span class="identifier">string</span></a> (<span style="white-space:nowrap">s:<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a></span>):<a class="type" title="The basic String class." href="./String.html">String</a></code></p></h3><div class="doc"><p>Converts any value to a String.</p>
<p>If <code>s</code> is of <code><a href="./String.html">String</a></code>, <code><a href="./Int.html">Int</a></code>, <code><a href="./Float.html">Float</a></code> or <code><a href="./Bool.html">Bool</a></code>, its value is returned.</p>
<p>If <code>s</code> is an instance of a class and that class or one of its parent classes has
a <code>toString</code> method, that method is called. If no such method is present, the result
is unspecified.</p>
<p>If <code>s</code> is an enum constructor without argument, the constructor's name is returned. If
arguments exists, the constructor's name followed by the String representations of
the arguments is returned.</p>
<p>If <code>s</code> is a structure, the field names along with their values are returned. The field order
and the operator separating field names and values are unspecified.</p>
<p>If s is null, "null" is returned.</p></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2017 &nbsp;<a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>