Documentation updated
pixi build republished
This commit is contained in:
Mat Groves
parent
11e047fe7b
commit
a1faefe5c7
28 changed files with 7889 additions and 2608 deletions
|
|
@ -275,7 +275,7 @@
|
|||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_click">click</a>
|
||||
|
||||
|
||||
|
|
@ -300,32 +300,39 @@
|
|||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_mousedown">mousedown</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_mouseout">mouseout</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_mouseover">mouseover</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_mouseup">mouseup</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_mouseupoutside">mouseupoutside</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method inherited">
|
||||
|
|
@ -335,7 +342,7 @@
|
|||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_setInteractive">setInteractive</a>
|
||||
|
||||
|
||||
|
|
@ -349,21 +356,28 @@
|
|||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_tap">tap</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_touchend">touchend</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method">
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_touchendoutside">touchendoutside</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item method inherited">
|
||||
<a href="#method_touchstart">touchstart</a>
|
||||
|
||||
|
||||
|
|
@ -413,6 +427,13 @@
|
|||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item property inherited">
|
||||
<a href="#property_hitArea">hitArea</a>
|
||||
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
<li class="index-item property inherited">
|
||||
|
|
@ -674,7 +695,7 @@
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_click" class="method item">
|
||||
<div id="method_click" class="method item inherited">
|
||||
<h3 class="name"><code>click</code></h3>
|
||||
|
||||
|
||||
|
|
@ -708,15 +729,12 @@
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_click">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l86"><code>src/pixi/Sprite.js:86</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l91"><code>src/pixi/DisplayObject.js:91</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -727,7 +745,7 @@
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the users clicks on the sprite with thier mouse</p>
|
||||
<p>A callback that is used when the users clicks on the displayObject with their mouse</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -809,7 +827,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l189"><code>src/pixi/Sprite.js:189</code></a>
|
||||
<a href="../files/src_pixi_Sprite.js.html#l113"><code>src/pixi/Sprite.js:113</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -916,7 +934,7 @@
|
|||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l205"><code>src/pixi/Sprite.js:205</code></a>
|
||||
<a href="../files/src_pixi_Sprite.js.html#l129"><code>src/pixi/Sprite.js:129</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -975,7 +993,7 @@
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_mousedown" class="method item">
|
||||
<div id="method_mousedown" class="method item inherited">
|
||||
<h3 class="name"><code>mousedown</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1009,15 +1027,12 @@
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_mousedown">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l92"><code>src/pixi/Sprite.js:92</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l97"><code>src/pixi/DisplayObject.js:97</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1062,7 +1077,7 @@
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_mouseout" class="method item">
|
||||
<div id="method_mouseout" class="method item inherited">
|
||||
<h3 class="name"><code>mouseout</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1096,15 +1111,12 @@
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_mouseout">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l111"><code>src/pixi/Sprite.js:111</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l123"><code>src/pixi/DisplayObject.js:123</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1115,7 +1127,7 @@
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the users mouse leaves the sprite</p>
|
||||
<p>A callback that is used when the users mouse leaves the displayObject</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -1149,7 +1161,7 @@
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_mouseover" class="method item">
|
||||
<div id="method_mouseover" class="method item inherited">
|
||||
<h3 class="name"><code>mouseover</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1183,15 +1195,12 @@
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_mouseover">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l105"><code>src/pixi/Sprite.js:105</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l117"><code>src/pixi/DisplayObject.js:117</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1202,7 +1211,7 @@
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the users mouse rolls over the sprite</p>
|
||||
<p>A callback that is used when the users mouse rolls over the displayObject</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -1236,7 +1245,7 @@
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_mouseup" class="method item">
|
||||
<div id="method_mouseup" class="method item inherited">
|
||||
<h3 class="name"><code>mouseup</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1270,15 +1279,12 @@
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_mouseup">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l98"><code>src/pixi/Sprite.js:98</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l103"><code>src/pixi/DisplayObject.js:103</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1289,8 +1295,93 @@
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the user releases the mouse that was over the sprite
|
||||
for this callback to be fired the mouse must have been pressed down over the sprite</p>
|
||||
<p>A callback that is used when the user releases the mouse that was over the displayObject
|
||||
for this callback to be fired the mouse must have been pressed down over the displayObject</p>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="params">
|
||||
<h4>Parameters:</h4>
|
||||
|
||||
<ul class="params-list">
|
||||
|
||||
<li class="param">
|
||||
|
||||
<code class="param-name">interactionData</code>
|
||||
<span class="type"><a href="../classes/InteractionData.html" class="crosslink">InteractionData</a></span>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="param-description">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method_mouseupoutside" class="method item inherited">
|
||||
<h3 class="name"><code>mouseupoutside</code></h3>
|
||||
|
||||
|
||||
<div class="args">
|
||||
<span class="paren">(</span><ul class="args-list inline commas">
|
||||
|
||||
<li class="arg">
|
||||
|
||||
<code>interactionData</code>
|
||||
|
||||
</li>
|
||||
|
||||
</ul><span class="paren">)</span>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="meta">
|
||||
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_mouseupoutside">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l110"><code>src/pixi/DisplayObject.js:110</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the user releases the mouse that was over the displayObject but is no longer over the displayObject
|
||||
for this callback to be fired, The touch must have started over the displayObject</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -1408,7 +1499,7 @@ for this callback to be fired the mouse must have been pressed down over the spr
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_setInteractive" class="method item">
|
||||
<div id="method_setInteractive" class="method item inherited">
|
||||
<h3 class="name"><code>setInteractive</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1442,15 +1533,12 @@ for this callback to be fired the mouse must have been pressed down over the spr
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_setInteractive">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l164"><code>src/pixi/Sprite.js:164</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l164"><code>src/pixi/DisplayObject.js:164</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1537,7 +1625,7 @@ for this callback to be fired the mouse must have been pressed down over the spr
|
|||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l146"><code>src/pixi/Sprite.js:146</code></a>
|
||||
<a href="../files/src_pixi_Sprite.js.html#l83"><code>src/pixi/Sprite.js:83</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1582,7 +1670,7 @@ for this callback to be fired the mouse must have been pressed down over the spr
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_tap" class="method item">
|
||||
<div id="method_tap" class="method item inherited">
|
||||
<h3 class="name"><code>tap</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1616,15 +1704,12 @@ for this callback to be fired the mouse must have been pressed down over the spr
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_tap">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l121"><code>src/pixi/Sprite.js:121</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l134"><code>src/pixi/DisplayObject.js:134</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1635,7 +1720,7 @@ for this callback to be fired the mouse must have been pressed down over the spr
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the users taps on the sprite with thier finger
|
||||
<p>A callback that is used when the users taps on the sprite with their finger
|
||||
basically a touch version of click</p>
|
||||
</div>
|
||||
|
||||
|
|
@ -1670,7 +1755,7 @@ basically a touch version of click</p>
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_touchend" class="method item">
|
||||
<div id="method_touchend" class="method item inherited">
|
||||
<h3 class="name"><code>touchend</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1704,15 +1789,12 @@ basically a touch version of click</p>
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_touchend">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l134"><code>src/pixi/Sprite.js:134</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l147"><code>src/pixi/DisplayObject.js:147</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1723,8 +1805,7 @@ basically a touch version of click</p>
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the user releases the touch that was over the sprite
|
||||
for this callback to be fired. The touch must have started over the sprite</p>
|
||||
<p>A callback that is used when the user releases a touch over the displayObject</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -1758,7 +1839,92 @@ for this callback to be fired. The touch must have started over the sprite</p>
|
|||
</div>
|
||||
|
||||
|
||||
<div id="method_touchstart" class="method item">
|
||||
<div id="method_touchendoutside" class="method item inherited">
|
||||
<h3 class="name"><code>touchendoutside</code></h3>
|
||||
|
||||
|
||||
<div class="args">
|
||||
<span class="paren">(</span><ul class="args-list inline commas">
|
||||
|
||||
<li class="arg">
|
||||
|
||||
<code>interactionData</code>
|
||||
|
||||
</li>
|
||||
|
||||
</ul><span class="paren">)</span>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="meta">
|
||||
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_touchendoutside">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l153"><code>src/pixi/DisplayObject.js:153</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the user releases the touch that was over the displayObject
|
||||
for this callback to be fired, The touch must have started over the sprite</p>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="params">
|
||||
<h4>Parameters:</h4>
|
||||
|
||||
<ul class="params-list">
|
||||
|
||||
<li class="param">
|
||||
|
||||
<code class="param-name">interactionData</code>
|
||||
<span class="type"><a href="../classes/InteractionData.html" class="crosslink">InteractionData</a></span>
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="param-description">
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="method_touchstart" class="method item inherited">
|
||||
<h3 class="name"><code>touchstart</code></h3>
|
||||
|
||||
|
||||
|
|
@ -1792,15 +1958,12 @@ for this callback to be fired. The touch must have started over the sprite</p>
|
|||
<div class="meta">
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
|
||||
Defined in
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#method_touchstart">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_Sprite.js.html#l128"><code>src/pixi/Sprite.js:128</code></a>
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l141"><code>src/pixi/DisplayObject.js:141</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -1811,7 +1974,7 @@ for this callback to be fired. The touch must have started over the sprite</p>
|
|||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>A callback that is used when the user touch's over the sprite</p>
|
||||
<p>A callback that is used when the user touch's over the displayObject</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
|
@ -2068,6 +2231,48 @@ currently supports PIXI.blendModes.NORMAL and PIXI.blendModes.SCREEN</p>
|
|||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div id="property_hitArea" class="property item inherited">
|
||||
<h3 class="name"><code>hitArea</code></h3>
|
||||
<span class="type"><a href="../classes/Rectangle.html" class="crosslink">Rectangle</a></span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="meta">
|
||||
|
||||
|
||||
<p>Inherited from
|
||||
<a href="../classes/DisplayObject.html#property_hitArea">DisplayObject</a>:
|
||||
|
||||
|
||||
|
||||
<a href="../files/src_pixi_DisplayObject.js.html#l62"><code>src/pixi/DisplayObject.js:62</code></a>
|
||||
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="description">
|
||||
<p>This is the defined area that will pick up mouse / touch events. It is null by default.
|
||||
Setting it is a neat way of optimising the hitTest function that the interactionManager will use (as it will not need to hit test all the children)</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue