Skip to content

Commit f3d04cd

Browse files
scriptorumscriptorum
committed
Updated Flaxen API
1 parent 237f089 commit f3d04cd

File tree

4 files changed

+64
-39
lines changed

4 files changed

+64
-39
lines changed

‎flaxen/dox/flaxen/EntityRef.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
<html lang="en"><head><meta charset="utf-8"/><link href="../bootstrap-combined.min.css" rel="stylesheet" /><script type="text/javascript" src="../jquery-1.9.1.min.js"></script><script type="text/javascript" src="../bootstrap.min.js"></script><link href="../styles.css" rel="stylesheet" /><link rel="icon" href="../favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="../nav.js"></script><script type="text/javascript" src="../index.js"></script><script type="text/javascript">var dox = {rootPath: "../",platforms: ["dox"]};</script><title>EntityRef - Flaxen API 30-Apr-15</title></head><body><div class="navbar navbar-inverse navbar-fixed-top"><div class="navbar-inner"><form class="navbar-search pull-left" id="searchForm"><input id="search" type="text" class="search-query" placeholder="Filter" autocomplete="off"/></form><ul class="nav"><li id="select-platform" class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Platform<b class="caret"></b></a><ul class="dropdown-menu"><li data="all"><a href="#">All Platforms</a></li><li data="dox"><a href="#">dox</a></li></ul></li></ul></div></div><div id="container"><div id="nav"></div><div id="content"><div class="header"><span class="viewsource"><a href="https://github.com/scriptorum/flaxen/blob/master/source/flaxen/Flaxen.hx">View source</a></span><h1><code><span class="directive">abstract </span><span class="type">flaxen.EntityRef</span>(<span class="type">Either</span>&lt;<span class="type">Entity</span>, <span class="type">String</span>&gt;)</code></h1></div><div class="body"><p><code class="dark"><span class="directive">import</span> <span class="type">flaxen.Flaxen</span>;</code></p><p class="availability">Available on all platforms</p><div class="doc"><p>In many methods where an Entity is expected you can instead pass a String
33
that is the name of an Entity in Ash. EntityRef is an abstract type that
44
could be referring to either an Entity or a String. A class may use
5-
ref.toEntity() to validate the reference and return a full Entity instance.</p></div><h2>Class Fields</h2><div class="platform platform-dox"><a name="fromEntity"></a><h3><p><code><span class="keyword">function</span> <a href="#fromEntity"><span class="identifier">fromEntity</span></a>(e:<span class="type">Entity</span>):<a class="type" href="../flaxen/EntityRef.html">EntityRef</a></code></p></h3><div class="doc"><p></p></div></div><div class="platform platform-dox"><a name="fromString"></a><h3><p><code><span class="keyword">function</span> <a href="#fromString"><span class="identifier">fromString</span></a>(str:<span class="type">String</span>):<a class="type" href="../flaxen/EntityRef.html">EntityRef</a></code></p></h3><div class="doc"><p></p></div></div><h2>Instance Fields</h2><div class="platform platform-dox"><a name="type"></a><h3><p><code><span class="keyword">var</span> <a href="#type"><span class="identifier">type</span></a>:<span class="type">Either</span>&lt;<span class="type">Entity</span>, <span class="type">String</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="platform platform-dox"><a name="get_type"></a><h3><p><code><span class="keyword">function</span> <a href="#get_type"><span class="identifier">get_type</span></a>():<span class="type">Either</span>&lt;<span class="type">Entity</span>, <span class="type">String</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="platform platform-dox"><a name="toEntity"></a><h3><p><code><span class="keyword">function</span> <a href="#toEntity"><span class="identifier">toEntity</span></a>(f:<a class="type" href="../flaxen/Flaxen.html">Flaxen</a>, ?compulsory:<span class="type">Bool</span> = true):<span class="type">Entity</span></code></p></h3><div class="doc"><p>Converts the EntityRef into an Entity. If the EntityRef already
6-
references an Entity, does not do a lookup to verify the entity
7-
exists in the Ash engine.</p><table class="table table-condensed"><tbody><col width="10%"/> <col width="100%"/><tr><td>f</td><td><p>The Flaxen object</p></td></tr><tr><td>compulsory</td><td><p>If true, throws exception instead of returning null</p></td></tr><tr><td>returns</td><td><p>The Entity object, or null if string lookup fails or ref was null</p></td></tr></tbody></table></div></div><div class="platform platform-dox"><a name="toString"></a><h3><p><code><span class="keyword">function</span> <a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></p></h3><div class="doc"><table class="table table-condensed"><tbody><col width="10%"/> <col width="100%"/><tr><td>returns</td><td><p>The entity's name</p></td></tr></tbody></table></div></div></div></div></div></body></html>
5+
ref.toEntity() to validate the reference and return a full Entity instance.</p></div><h2>Class Fields</h2><div class="platform platform-dox"><a name="fromEntity"></a><h3><p><code><span class="keyword">function</span> <a href="#fromEntity"><span class="identifier">fromEntity</span></a>(e:<span class="type">Entity</span>):<a class="type" href="../flaxen/EntityRef.html">EntityRef</a></code></p></h3><div class="doc"><p></p></div></div><div class="platform platform-dox"><a name="fromString"></a><h3><p><code><span class="keyword">function</span> <a href="#fromString"><span class="identifier">fromString</span></a>(str:<span class="type">String</span>):<a class="type" href="../flaxen/EntityRef.html">EntityRef</a></code></p></h3><div class="doc"><p></p></div></div><h2>Instance Fields</h2><div class="platform platform-dox"><a name="type"></a><h3><p><code><span class="keyword">var</span> <a href="#type"><span class="identifier">type</span></a>:<span class="type">Either</span>&lt;<span class="type">Entity</span>, <span class="type">String</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="platform platform-dox"><a name="get_type"></a><h3><p><code><span class="keyword">function</span> <a href="#get_type"><span class="identifier">get_type</span></a>():<span class="type">Either</span>&lt;<span class="type">Entity</span>, <span class="type">String</span>&gt;</code></p></h3><div class="doc"><p></p></div></div><div class="platform platform-dox"><a name="toEntity"></a><h3><p><code><span class="keyword">function</span> <a href="#toEntity"><span class="identifier">toEntity</span></a>(f:<a class="type" href="../flaxen/Flaxen.html">Flaxen</a>, ?compulsory:<span class="type">Bool</span> = true):<span class="type">Entity</span></code></p></h3><div class="doc"><p>Converts the EntityRef into an Entity. If the EntityRef references
6+
an Entity, does not do a lookup to verify the entity exists in the
7+
Ash engine (i.e., it may be a free entity).</p><table class="table table-condensed"><tbody><col width="10%"/> <col width="100%"/><tr><td>f</td><td><p>The Flaxen object</p></td></tr><tr><td>compulsory</td><td><p>If true, throws exception instead of returning null</p></td></tr><tr><td>returns</td><td><p>The Entity object, or null if string lookup fails or ref was null</p></td></tr></tbody></table></div></div><div class="platform platform-dox"><a name="toString"></a><h3><p><code><span class="keyword">function</span> <a href="#toString"><span class="identifier">toString</span></a>():<span class="type">String</span></code></p></h3><div class="doc"><p>Returns the name of this entity. May return null if the ref is null.</p><table class="table table-condensed"><tbody><col width="10%"/> <col width="100%"/><tr><td>returns</td><td><p>The entity's name</p></td></tr></tbody></table></div></div></div></div></div></body></html>

0 commit comments

Comments
 (0)