wassname/phaser
1
0
Fork 0
mirror of https://github.com/wassname/phaser.git synced 2026-07-30 12:30:07 +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.Button.html
+75 -37
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>
@@ -387,7 +427,14 @@
Button
</h2>
<div class="class-description"><p>Phaser.Button</p></div>
<div class="class-description"><p>Create a new <code>Button</code> object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:</p>
<ul>
<li>'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.</li>
<li>'Out' - when the Pointer that was previously over the Button moves out of it.</li>
<li>'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.</li>
<li>'Up' - when the Pointer that was pressed down on the Button is released again.</li>
</ul>
<p>You can set a unique texture frame and Sound for any of these states.</p></div>
</header>
@@ -405,15 +452,6 @@
<dd>
<div class="description">
<p>Create a new <code>Button</code> object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:
'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.
'Out' - when the Pointer that was previously over the Button moves out of it.
'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.
'Up' - when the Pointer that was pressed down on the Button is released again.
You can set a unique texture frame and Sound for any of these states.</p>
</div>
@@ -776,7 +814,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-28">line 28</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-31">line 31</a>
</li></ul></dd>
@@ -911,7 +949,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-177">line 177</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-180">line 180</a>
</li></ul></dd>
@@ -1013,7 +1051,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-170">line 170</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-173">line 173</a>
</li></ul></dd>
@@ -1118,7 +1156,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-115">line 115</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-118">line 118</a>
</li></ul></dd>
@@ -1220,7 +1258,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-139">line 139</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-142">line 142</a>
</li></ul></dd>
@@ -1322,7 +1360,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-160">line 160</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-163">line 163</a>
</li></ul></dd>
@@ -1424,7 +1462,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-155">line 155</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-158">line 158</a>
</li></ul></dd>
@@ -1526,7 +1564,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-150">line 150</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-153">line 153</a>
</li></ul></dd>
@@ -1628,7 +1666,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-165">line 165</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-168">line 168</a>
</li></ul></dd>
@@ -1733,7 +1771,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-109">line 109</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-112">line 112</a>
</li></ul></dd>
@@ -1835,7 +1873,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-133">line 133</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-136">line 136</a>
</li></ul></dd>
@@ -1940,7 +1978,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-103">line 103</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-106">line 106</a>
</li></ul></dd>
@@ -2042,7 +2080,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-127">line 127</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-130">line 130</a>
</li></ul></dd>
@@ -2147,7 +2185,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-121">line 121</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-124">line 124</a>
</li></ul></dd>
@@ -2249,7 +2287,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-145">line 145</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-148">line 148</a>
</li></ul></dd>
@@ -2351,7 +2389,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-41">line 41</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-44">line 44</a>
</li></ul></dd>
@@ -2465,7 +2503,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-401">line 401</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-404">line 404</a>
</li></ul></dd>
@@ -2583,7 +2621,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-433">line 433</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-436">line 436</a>
</li></ul></dd>
@@ -2701,7 +2739,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-465">line 465</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-468">line 468</a>
</li></ul></dd>
@@ -2819,7 +2857,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-497">line 497</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-500">line 500</a>
</li></ul></dd>
@@ -2980,7 +3018,7 @@ You can set a unique texture frame and Sound for any of these states.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-377">line 377</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-380">line 380</a>
</li></ul></dd>
@@ -3186,7 +3224,7 @@ exactly like setting them in the constructor.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-200">line 200</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-203">line 203</a>
</li></ul></dd>
@@ -3347,7 +3385,7 @@ exactly like setting them in the constructor.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-329">line 329</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-332">line 332</a>
</li></ul></dd>
@@ -3508,7 +3546,7 @@ exactly like setting them in the constructor.</p>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-305">line 305</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-308">line 308</a>
</li></ul></dd>
@@ -3871,7 +3909,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-281">line 281</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-284">line 284</a>
</li></ul></dd>
@@ -4032,7 +4070,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-353">line 353</a>
<a href="Button.js.html">gameobjects/Button.js</a>, <a href="Button.js.html#sunlight-1-line-356">line 356</a>
</li></ul></dd>
@@ -4083,7 +4121,7 @@ Call this function with no parameters at all to reset all sounds on this Button.
<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:34 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
on Thu Nov 28 2013 15:56:27 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>