This repository has been archived by the owner on Jan 18, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathType.html
40 lines (40 loc) · 9.35 KB
/
Type.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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"/><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>Type</title><meta name="description" content="The Haxe Reflection API allows retrieval of type information at runtime."/></head><body><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:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="./">API Documentation</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="Filter" autocomplete="off"/></div></form></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Type</h1><h4><small><a href="./">no package</a></small></h4> <span class="label label-meta label-meta-keep" title="@:keep metadata">@:keep</span><span class="label label-meta label-meta-directlyUsed" title="@:directlyUsed metadata">@:directlyUsed</span><span class="label label-meta label-meta-coreApi" title="@:coreApi metadata">@:coreApi</span><hr/></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The Haxe Reflection API allows retrieval of type information at runtime.</p>
<p>This class complements the more lightweight Reflect class, with a focus on
class and enum instances.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://haxe.org/manual/types.html">https://haxe.org/manual/types.html</a></p></div><div class="indent inline-content"><p><a href="https://haxe.org/manual/std-reflection.html">https://haxe.org/manual/std-reflection.html</a></p></div></div></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="createEnum"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#createEnum"><span class="identifier">createEnum</span></a><<span class="type">T</span>> (<span style="white-space:nowrap">e:<a class="type" title="An abstract type that represents an Enum type." href="./Enum.html">Enum</a><<span class="type">T</span>>,</span> <span style="white-space:nowrap">constr:<a class="type" title="The basic String class." href="./String.html">String</a>,</span> <span style="white-space:nowrap">?params:<a class="type" title="An Array is a storage for values." href="./Array.html">Array</a><<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a>></span>):<span class="type">T</span></code></h3><div class="doc"><p>Creates an instance of enum <code>e</code> by calling its constructor <code>constr</code> with
arguments <code>params</code>.</p>
<p>If <code>e</code> or <code>constr</code> is null, or if enum <code>e</code> has no constructor named
<code>constr</code>, or if the number of elements in <code>params</code> does not match the
expected number of constructor arguments, or if any argument has an
invalid type, the result is unspecified.</p></div></div><div class="field "><a name="createInstance"></a><h3 class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><span class="label label-static">static</span><a href="#createInstance"><span class="identifier">createInstance</span></a><<span class="type">T</span>> (<span style="white-space:nowrap">cl:<a class="type" title="An abstract type that represents a Class." href="./Class.html">Class</a><<span class="type">T</span>>,</span> <span style="white-space:nowrap">args:<a class="type" title="An Array is a storage for values." href="./Array.html">Array</a><<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a>></span>):<span class="type">T</span></code></h3><div class="doc"><p>Creates an instance of class <code>cl</code>, using <code>args</code> as arguments to the
class constructor.</p>
<p>This function guarantees that the class constructor is called.</p>
<p>Default values of constructors arguments are not guaranteed to be
taken into account.</p>
<p>If <code>cl</code> or <code>args</code> are null, or if the number of elements in <code>args</code> does
not match the expected number of constructor arguments, or if any
argument has an invalid type, or if <code>cl</code> has no own constructor, the
result is unspecified.</p>
<p>In particular, default values of constructor arguments are not
guaranteed to be taken into account.</p></div></div><div class="field "><a name="enumParameters"></a><h3 class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><span class="label label-static">static</span><a href="#enumParameters"><span class="identifier">enumParameters</span></a> (<span style="white-space:nowrap">e:<a class="type" title="An abstract type that represents any enum value." href="./EnumValue.html">EnumValue</a></span>):<a class="type" title="An Array is a storage for values." href="./Array.html">Array</a><<a class="type" title="Dynamic is a special type which is compatible with all other types." href="./Dynamic.html">Dynamic</a>></code></h3><div class="doc"><p>Returns a list of the constructor arguments of enum instance <code>e</code>.</p>
<p>If <code>e</code> has no arguments, the result is [].</p>
<p>Otherwise the result are the values that were used as arguments to <code>e</code>,
in the order of their declaration.</p>
<p>If <code>e</code> is null, the result is unspecified.</p></div></div><div class="field "><a name="getInstanceFields"></a><h3 class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><span class="label label-static">static</span><a href="#getInstanceFields"><span class="identifier">getInstanceFields</span></a> (<span style="white-space:nowrap">c:<a class="type" title="An abstract type that represents a Class." href="./Class.html">Class</a><<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="An Array is a storage for values." href="./Array.html">Array</a><<a class="type" title="The basic String class." href="./String.html">String</a>></code></h3><div class="doc"><p>Returns a list of the instance fields of class <code>c</code>, including
inherited fields.</p>
<p>This only includes fields which are known at compile-time. In
particular, using <code>getInstanceFields(getClass(obj))</code> will not include
any fields which were added to <code>obj</code> at runtime.</p>
<p>The order of the fields in the returned Array is unspecified.</p>
<p>If <code>c</code> is null, the result is unspecified.</p>
<p>(As3) This method only returns instance fields that are public.</p></div></div><div class="field "><a name="typeof"></a><h3 class="anchor"><code><span class="label label-meta label-meta-has_untyped" title="@:has_untyped metadata">@:has_untyped</span><span class="label label-meta label-meta-access" title="@:access metadata">@:access(js.Boot)</span><span class="label label-static">static</span><a href="#typeof"><span class="identifier">typeof</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>):<a class="type" title="" href="./ValueType.html">ValueType</a></code></h3><div class="doc"><p>Returns the runtime type of value <code>v</code>.</p>
<p>The result corresponds to the type <code>v</code> has at runtime, which may vary
per platform. Assumptions regarding this should be minimized to avoid
surprises.</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:#000000">© 2019 </p></div></div></footer><script src=".//highlighter.js"></script><link href="./highlighter.css" rel="stylesheet"/></body></html>