wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-08-04 13:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation.

Browse Source
This commit is contained in:
photonstorm
2013-11-28 15:57:09 +00:00
parent 8da9b67c18
commit f22159e257
193 changed files with 68905 additions and 93104 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Phaser.Text.html
+603 -27
View File
@@ -54,6 +54,10 @@
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li>
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li>
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
@@ -138,6 +142,10 @@
<a href="Phaser.Events.html">Events</a>
</li>
<li>
<a href="Phaser.Filter.html">Filter</a>
</li>
<li>
<a href="Phaser.Frame.html">Frame</a>
</li>
@@ -302,6 +310,26 @@
<a href="Phaser.Text.html">Text</a>
</li>
<li>
<a href="Phaser.Tile.html">Tile</a>
</li>
<li>
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li>
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li>
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li>
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li>
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
@@ -310,6 +338,10 @@
<a href="Phaser.Time.html">Time</a>
</li>
<li>
<a href="Phaser.Timer.html">Timer</a>
</li>
<li>
<a href="Phaser.Touch.html">Touch</a>
</li>
@@ -356,6 +388,14 @@
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
</li>
<li>
<a href="global.html#render">render</a>
</li>
<li>
<a href="global.html#renderXY">renderXY</a>
</li>
<li>
<a href="global.html#right">right</a>
</li>
@@ -679,7 +719,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>This is a handy little var your game can use to determine if an object is alive or not, it doesn't effect rendering.</p></td>
</tr>
@@ -711,7 +751,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-36">line 36</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-39">line 39</a>
</li></ul></dd>
@@ -735,6 +775,13 @@
</dt>
<dd>
<div class="description">
<p>The anchor sets the origin point of the texture.
The default is 0,0 this means the textures origin is the top left
Setting than anchor to 0.5,0.5 means the textures origin is centered
Setting the anchor to 1,1 would mean the textures origin points will be the bottom right</p>
</div>
@@ -784,7 +831,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The anchor around which rotation and scaling takes place.</p></td>
</tr>
@@ -813,7 +860,221 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-75">line 75</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-86">line 86</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="angle"><span class="type-signature"></span>angle<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Indicates the rotation of the Text, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
If you wish to work in radians instead of degrees use the property Sprite.rotation instead.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>angle</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Gets or sets the angle of rotation in degrees.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-184">line 184</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="content"><span class="type-signature"></span>content<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The string to be rendered by this Text object.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>content</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The string to be rendered by this Text object.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-237">line 237</a>
</li></ul></dd>
@@ -886,7 +1147,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>If exists = false then the Text isn't updated by the core game loop.</p></td>
</tr>
@@ -918,7 +1179,113 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-29">line 29</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-33">line 33</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="font"><span class="type-signature"></span>font<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The font the text will be rendered in.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>font</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The font the text will be rendered in.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-261">line 261</a>
</li></ul></dd>
@@ -991,7 +1358,7 @@
<td class="description last"><p>A reference to the currently running game.</p></td>
<td class="description last"><p>A reference to the currently running Game.</p></td>
</tr>
@@ -1020,7 +1387,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-53">line 53</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-27">line 27</a>
</li></ul></dd>
@@ -1083,7 +1450,7 @@
<td class="type">
<span class="param-type">Description</span>
<span class="param-type"><a href="Phaser.Group.html">Phaser.Group</a></span>
@@ -1093,7 +1460,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The parent Group of this Text object.</p></td>
</tr>
@@ -1118,14 +1485,11 @@
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-42">line 42</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
@@ -1198,7 +1562,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The user defined name given to this object.</p></td>
</tr>
@@ -1227,7 +1591,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-48">line 48</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-50">line 50</a>
</li></ul></dd>
@@ -1300,7 +1664,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>A renderable object will be rendered to the context each frame.</p></td>
</tr>
@@ -1329,7 +1693,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-108">line 108</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-126">line 126</a>
</li></ul></dd>
@@ -1402,7 +1766,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The scale of the object when rendered. By default it's set to 1 (no scale). You can modify it via scale.x or scale.y or scale.setTo(x, y). A value of 1 means no change to the scale, 0.5 means &quot;half the size&quot;, 2 means &quot;twice the size&quot;, etc.</p></td>
</tr>
@@ -1431,7 +1795,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-80">line 80</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-91">line 91</a>
</li></ul></dd>
@@ -1494,7 +1858,7 @@
<td class="type">
<span class="param-type">Description</span>
<span class="param-type">number</span>
@@ -1504,7 +1868,7 @@
<td class="description last"><p>Description.</p></td>
<td class="description last"><p>The const type of this object.</p></td>
</tr>
@@ -1533,7 +1897,219 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-63">line 63</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-56">line 56</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="x"><span class="type-signature"></span>x<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The x coordinate of this object in world space.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The x coordinate of this object in world space.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-203">line 203</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="y"><span class="type-signature"></span>y<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>The y coordinate of this object in world space.</p>
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The y coordinate of this object in world space.</p></td>
</tr>
</tbody>
</table>
</dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-220">line 220</a>
</li></ul></dd>
@@ -1594,7 +2170,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-148">line 148</a>
<a href="BitmapText.js.html">gameobjects/BitmapText.js</a>, <a href="BitmapText.js.html#sunlight-1-line-161">line 161</a>
</li></ul></dd>
@@ -1659,7 +2235,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-140">line 140</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-158">line 158</a>
</li></ul></dd>
@@ -1728,7 +2304,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-115">line 115</a>
<a href="Text.js.html">gameobjects/Text.js</a>, <a href="Text.js.html#sunlight-1-line-133">line 133</a>
</li></ul></dd>
@@ -1779,7 +2355,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Thu Nov 07 2013 06:07:41 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:34 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>