3141 lines
76 KiB
HTML
3141 lines
76 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Text - Pixi.JS</title>
|
|
<link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0/build/cssgrids/cssgrids-min.css">
|
|
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
|
|
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
|
|
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
|
|
<script src="http://yui.yahooapis.com/combo?3.8.0/build/yui/yui-min.js"></script>
|
|
</head>
|
|
<body class="yui3-skin-sam">
|
|
|
|
<div id="doc">
|
|
<div id="hd" class="yui3-g header">
|
|
<div class="yui3-u-3-4">
|
|
|
|
<h1><img src="http://www.goodboydigital.com/pixijs/logo_small.png" title="Pixi.JS"></h1>
|
|
|
|
</div>
|
|
<div class="yui3-u-1-4 version">
|
|
<em>API Docs for: 1.3.0</em>
|
|
</div>
|
|
</div>
|
|
<div id="bd" class="yui3-g">
|
|
|
|
<div class="yui3-u-1-4">
|
|
<div id="docs-sidebar" class="sidebar apidocs">
|
|
<div id="api-list">
|
|
<h2 class="off-left">APIs</h2>
|
|
<div id="api-tabview" class="tabview">
|
|
<ul class="tabs">
|
|
<li><a href="#api-classes">Classes</a></li>
|
|
<li><a href="#api-modules">Modules</a></li>
|
|
</ul>
|
|
|
|
<div id="api-tabview-filter">
|
|
<input type="search" id="api-filter" placeholder="Type to filter APIs">
|
|
</div>
|
|
|
|
<div id="api-tabview-panel">
|
|
<ul id="api-classes" class="apis classes">
|
|
|
|
<li><a href="../classes/AssetLoader.html">AssetLoader</a></li>
|
|
|
|
<li><a href="../classes/BaseTexture.html">BaseTexture</a></li>
|
|
|
|
<li><a href="../classes/BitmapFontLoader.html">BitmapFontLoader</a></li>
|
|
|
|
<li><a href="../classes/BitmapText.html">BitmapText</a></li>
|
|
|
|
<li><a href="../classes/CanvasGraphics.html">CanvasGraphics</a></li>
|
|
|
|
<li><a href="../classes/CanvasRenderer.html">CanvasRenderer</a></li>
|
|
|
|
<li><a href="../classes/Circle.html">Circle</a></li>
|
|
|
|
<li><a href="../classes/CustomRenderable.html">CustomRenderable</a></li>
|
|
|
|
<li><a href="../classes/DisplayObject.html">DisplayObject</a></li>
|
|
|
|
<li><a href="../classes/DisplayObjectContainer.html">DisplayObjectContainer</a></li>
|
|
|
|
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
|
|
|
|
<li><a href="../classes/Graphics.html">Graphics</a></li>
|
|
|
|
<li><a href="../classes/ImageLoader.html">ImageLoader</a></li>
|
|
|
|
<li><a href="../classes/InteractionData.html">InteractionData</a></li>
|
|
|
|
<li><a href="../classes/InteractionManager.html">InteractionManager</a></li>
|
|
|
|
<li><a href="../classes/JsonLoader.html">JsonLoader</a></li>
|
|
|
|
<li><a href="../classes/MovieClip.html">MovieClip</a></li>
|
|
|
|
<li><a href="../classes/Point.html">Point</a></li>
|
|
|
|
<li><a href="../classes/Polygon.html">Polygon</a></li>
|
|
|
|
<li><a href="../classes/Rectangle.html">Rectangle</a></li>
|
|
|
|
<li><a href="../classes/RenderTexture.html">RenderTexture</a></li>
|
|
|
|
<li><a href="../classes/Spine.html">Spine</a></li>
|
|
|
|
<li><a href="../classes/Sprite.html">Sprite</a></li>
|
|
|
|
<li><a href="../classes/SpriteSheetLoader.html">SpriteSheetLoader</a></li>
|
|
|
|
<li><a href="../classes/Stage.html">Stage</a></li>
|
|
|
|
<li><a href="../classes/Text.html">Text</a></li>
|
|
|
|
<li><a href="../classes/Texture.html">Texture</a></li>
|
|
|
|
<li><a href="../classes/TilingSprite.html">TilingSprite</a></li>
|
|
|
|
<li><a href="../classes/WebGLBatch.html">WebGLBatch</a></li>
|
|
|
|
<li><a href="../classes/WebGLRenderer.html">WebGLRenderer</a></li>
|
|
|
|
</ul>
|
|
|
|
<ul id="api-modules" class="apis modules">
|
|
|
|
<li><a href="../modules/PIXI.html">PIXI</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui3-u-3-4">
|
|
<div id="api-options">
|
|
Show:
|
|
<label for="api-show-inherited">
|
|
<input type="checkbox" id="api-show-inherited" checked>
|
|
Inherited
|
|
</label>
|
|
|
|
<label for="api-show-protected">
|
|
<input type="checkbox" id="api-show-protected">
|
|
Protected
|
|
</label>
|
|
|
|
<label for="api-show-private">
|
|
<input type="checkbox" id="api-show-private">
|
|
Private
|
|
</label>
|
|
<label for="api-show-deprecated">
|
|
<input type="checkbox" id="api-show-deprecated">
|
|
Deprecated
|
|
</label>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="apidocs">
|
|
<div id="docs-main">
|
|
<div class="content">
|
|
<h1>Text Class</h1>
|
|
<div class="box meta">
|
|
|
|
|
|
|
|
<div class="extends">
|
|
Extends <a href="../classes/Sprite.html" class="crosslink">Sprite</a>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="foundat">
|
|
Defined in: <a href="../files/src_pixi_text_Text.js.html#l5"><code>src/pixi/text/Text.js:5</code></a>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
Module: <a href="../modules/PIXI.html">PIXI</a>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div class="box intro">
|
|
<p>A Text Object will create a line(s) of text to split a line you can use "\n"</p>
|
|
</div>
|
|
|
|
|
|
<div class="constructor">
|
|
<h2>Constructor</h2>
|
|
<div id="method_Text" class="method item">
|
|
<h3 class="name"><code>Text</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>text</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[style]</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_text_Text.js.html#l5"><code>src/pixi/text/Text.js:5</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">text</code>
|
|
<span class="type">String</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The copy that you would like the text to display</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[style]</code>
|
|
<span class="type">Object</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The style parameters</p>
|
|
</div>
|
|
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[font]</code>
|
|
<span class="type">String</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>default "bold 20pt Arial" The style and size of the font</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[fill="black"]</code>
|
|
<span class="type">Object</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>A canvas fillstyle that will be used on the text eg "red", "#00FF00"</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[align="left"]</code>
|
|
<span class="type">String</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>An alignment of the multiline text ("left", "center" or "right")</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[stroke]</code>
|
|
<span class="type">String</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>A canvas fillstyle that will be used on the text stroke eg "blue", "#FCFF00"</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[strokeThickness=0]</code>
|
|
<span class="type">Number</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>A number that represents the thickness of the stroke. Default is 0 (no stroke)</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[wordWrap=false]</code>
|
|
<span class="type">Boolean</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>Indicates if word wrap should be used</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[wordWrapWidth=100]</code>
|
|
<span class="type">Number</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The width at which text will wrap</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div id="classdocs" class="tabview">
|
|
<ul class="api-class-tabs">
|
|
<li class="api-class-tab index"><a href="#index">Index</a></li>
|
|
|
|
|
|
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
|
|
|
|
|
|
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
<div>
|
|
<div id="index" class="api-class-tabpanel index">
|
|
<h2 class="off-left">Item Index</h2>
|
|
|
|
|
|
<div class="index-section methods">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="index-list methods extends">
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_addChild">addChild</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_addChildAt">addChildAt</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_click">click</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_getChildAt">getChildAt</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_mousedown">mousedown</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_mouseout">mouseout</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_mouseover">mouseover</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<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">
|
|
<a href="#method_removeChild">removeChild</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_setInteractive">setInteractive</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method">
|
|
<a href="#method_setStyle">setStyle</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_setTexture">setTexture</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_swapChildren">swapChildren</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_tap">tap</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item method inherited">
|
|
<a href="#method_touchend">touchend</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<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>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="index-section properties">
|
|
<h3>Properties</h3>
|
|
|
|
<ul class="index-list properties extends">
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_alpha">alpha</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_anchor">anchor</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_blendMode">blendMode</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_buttonMode">buttonMode</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_children">children</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_height">height</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_hitArea">hitArea</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_interactive">interactive</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_mask">mask</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_parent">parent</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_pivot">pivot</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_position">position</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_rotation">rotation</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_scale">scale</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_stage">stage</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_texture">texture</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_visible">visible</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="index-item property inherited">
|
|
<a href="#property_width">width</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="methods" class="api-class-tabpanel">
|
|
<h2 class="off-left">Methods</h2>
|
|
|
|
|
|
<div id="method_addChild" class="method item inherited">
|
|
<h3 class="name"><code>addChild</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>DisplayObject</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObjectContainer.html#method_addChild">DisplayObjectContainer</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l42"><code>src/pixi/display/DisplayObjectContainer.js:42</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Adds a child to the container.</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">DisplayObject</code>
|
|
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_addChildAt" class="method item inherited">
|
|
<h3 class="name"><code>addChildAt</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>DisplayObject</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code>index</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObjectContainer.html#method_addChildAt">DisplayObjectContainer</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l139"><code>src/pixi/display/DisplayObjectContainer.js:139</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">DisplayObject</code>
|
|
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">index</code>
|
|
<span class="type">Number</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_click" class="method item inherited">
|
|
<h3 class="name"><code>click</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_click">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l109"><code>src/pixi/display/DisplayObject.js:109</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the users clicks on the displayObject with their mouse</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_getChildAt" class="method item inherited">
|
|
<h3 class="name"><code>getChildAt</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>index</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObjectContainer.html#method_getChildAt">DisplayObjectContainer</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l274"><code>src/pixi/display/DisplayObjectContainer.js:274</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Returns the Child at the specified index</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">index</code>
|
|
<span class="type">Number</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_mousedown" class="method item inherited">
|
|
<h3 class="name"><code>mousedown</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_mousedown">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l115"><code>src/pixi/display/DisplayObject.js:115</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the user clicks the mouse down 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_mouseout" class="method item inherited">
|
|
<h3 class="name"><code>mouseout</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_mouseout">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l141"><code>src/pixi/display/DisplayObject.js:141</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the users mouse leaves 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_mouseover" class="method item inherited">
|
|
<h3 class="name"><code>mouseover</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_mouseover">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l135"><code>src/pixi/display/DisplayObject.js:135</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the users mouse rolls 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_mouseup" class="method item inherited">
|
|
<h3 class="name"><code>mouseup</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_mouseup">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l121"><code>src/pixi/display/DisplayObject.js:121</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<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_display_DisplayObject.js.html#l128"><code>src/pixi/display/DisplayObject.js:128</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>
|
|
|
|
|
|
<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_removeChild" class="method item inherited">
|
|
<h3 class="name"><code>removeChild</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>DisplayObject</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObjectContainer.html#method_removeChild">DisplayObjectContainer</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l291"><code>src/pixi/display/DisplayObjectContainer.js:291</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Removes a child from the container.</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">DisplayObject</code>
|
|
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_setInteractive" class="method item inherited">
|
|
<h3 class="name"><code>setInteractive</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>interactive</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#method_setInteractive">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l193"><code>src/pixi/display/DisplayObject.js:193</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[Deprecated] Indicates if the sprite will have touch and mouse interactivity. It is false by default
|
|
Instead of using this function you can now simply set the interactive property to true or false</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">interactive</code>
|
|
<span class="type">Boolean</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_setStyle" class="method item">
|
|
<h3 class="name"><code>setStyle</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code class="optional">[style]</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code>[style.font="bold</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
|
|
<p>
|
|
|
|
Defined in
|
|
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_text_Text.js.html#l37"><code>src/pixi/text/Text.js:37</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Set the style of the text</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[style]</code>
|
|
<span class="type">Object</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The style parameters</p>
|
|
</div>
|
|
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[fill="black"]</code>
|
|
<span class="type">Object</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>A canvas fillstyle that will be used on the text eg "red", "#00FF00"</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[align="left"]</code>
|
|
<span class="type">String</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>An alignment of the multiline text ("left", "center" or "right")</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[stroke="black"]</code>
|
|
<span class="type">String</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>A canvas fillstyle that will be used on the text stroke eg "blue", "#FCFF00"</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[strokeThickness=0]</code>
|
|
<span class="type">Number</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>A number that represents the thickness of the stroke. Default is 0 (no stroke)</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[wordWrap=false]</code>
|
|
<span class="type">Boolean</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>Indicates if word wrap should be used</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name optional">[wordWrapWidth=100]</code>
|
|
<span class="type">Number</span>
|
|
<span class="flag optional" title="This parameter is optional.">optional</span>
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The width at which text will wrap</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">[style.font="bold</code>
|
|
<span class="type">String</span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>20pt Arial"] The style and size of the font</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_setTexture" class="method item inherited">
|
|
<h3 class="name"><code>setTexture</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>texture</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/Sprite.html#method_setTexture">Sprite</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_Sprite.js.html#l103"><code>src/pixi/display/Sprite.js:103</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">texture</code>
|
|
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
<p>The PIXI texture that is displayed by the sprite</p>
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_swapChildren" class="method item inherited">
|
|
<h3 class="name"><code>swapChildren</code></h3>
|
|
|
|
|
|
<div class="args">
|
|
<span class="paren">(</span><ul class="args-list inline commas">
|
|
|
|
<li class="arg">
|
|
|
|
<code>DisplayObject</code>
|
|
|
|
</li>
|
|
|
|
<li class="arg">
|
|
|
|
<code>DisplayObject2</code>
|
|
|
|
</li>
|
|
|
|
</ul><span class="paren">)</span>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObjectContainer.html#method_swapChildren">DisplayObjectContainer</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l227"><code>src/pixi/display/DisplayObjectContainer.js:227</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Swaps the depth of 2 displayObjects</p>
|
|
</div>
|
|
|
|
|
|
<div class="params">
|
|
<h4>Parameters:</h4>
|
|
|
|
<ul class="params-list">
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">DisplayObject</code>
|
|
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
<li class="param">
|
|
|
|
<code class="param-name">DisplayObject2</code>
|
|
<span class="type"><a href="../classes/DisplayObject.html" class="crosslink">DisplayObject</a></span>
|
|
|
|
|
|
|
|
|
|
<div class="param-description">
|
|
|
|
</div>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method_tap" class="method item inherited">
|
|
<h3 class="name"><code>tap</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_tap">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l152"><code>src/pixi/display/DisplayObject.js:152</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the users taps on the sprite with their finger
|
|
basically a touch version of click</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_touchend" class="method item inherited">
|
|
<h3 class="name"><code>touchend</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_touchend">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l165"><code>src/pixi/display/DisplayObject.js:165</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the user releases a touch 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_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_display_DisplayObject.js.html#l171"><code>src/pixi/display/DisplayObject.js:171</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>
|
|
|
|
|
|
<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_touchstart">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l159"><code>src/pixi/display/DisplayObject.js:159</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>A callback that is used when the user touch's 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>
|
|
|
|
|
|
|
|
<div id="properties" class="api-class-tabpanel">
|
|
<h2 class="off-left">Properties</h2>
|
|
|
|
|
|
<div id="property_alpha" class="property item inherited">
|
|
<h3 class="name"><code>alpha</code></h3>
|
|
<span class="type">Number</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_alpha">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l43"><code>src/pixi/display/DisplayObject.js:43</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The opacity of the object.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_anchor" class="property item inherited">
|
|
<h3 class="name"><code>anchor</code></h3>
|
|
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/Sprite.html#property_anchor">Sprite</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_Sprite.js.html#l21"><code>src/pixi/display/Sprite.js:21</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_blendMode" class="property item inherited">
|
|
<h3 class="name"><code>blendMode</code></h3>
|
|
<span class="type">Uint</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/Sprite.html#property_blendMode">Sprite</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_Sprite.js.html#l38"><code>src/pixi/display/Sprite.js:38</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The blend mode of sprite.
|
|
currently supports PIXI.blendModes.NORMAL and PIXI.blendModes.SCREEN</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_buttonMode" class="property item inherited">
|
|
<h3 class="name"><code>buttonMode</code></h3>
|
|
<span class="type">Boolean</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_buttonMode">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l98"><code>src/pixi/display/DisplayObject.js:98</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>This is used to indicate if the displayObject should display a mouse hand cursor on rollover</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_children" class="property item inherited">
|
|
<h3 class="name"><code>children</code></h3>
|
|
<span class="type">Array</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObjectContainer.html#property_children">DisplayObjectContainer</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObjectContainer.js.html#l16"><code>src/pixi/display/DisplayObjectContainer.js:16</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[read-only] The of children of this container.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_height" class="property item inherited">
|
|
<h3 class="name"><code>height</code></h3>
|
|
<span class="type">#Number</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/Sprite.html#property_height">Sprite</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_Sprite.js.html#l53"><code>src/pixi/display/Sprite.js:53</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The height of the sprite (this is initially set by the texture)</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</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_display_DisplayObject.js.html#l72"><code>src/pixi/display/DisplayObject.js:72</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>
|
|
|
|
|
|
<div id="property_interactive" class="property item inherited">
|
|
<h3 class="name"><code>interactive</code></h3>
|
|
<span class="type">Boolean</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_interactive">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l204"><code>src/pixi/display/DisplayObject.js:204</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Indicates if the sprite will have touch and mouse interactivity. It is false by default</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_mask" class="property item inherited">
|
|
<h3 class="name"><code>mask</code></h3>
|
|
<span class="type">PIXI.Graphics</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_mask">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l222"><code>src/pixi/display/DisplayObject.js:222</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.
|
|
In PIXI a regular mask must be a PIXI.Ggraphics object. This allows for much faster masking in canvas as it utilises shape clipping.
|
|
To remove a mask, set this property to null.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_parent" class="property item inherited">
|
|
<h3 class="name"><code>parent</code></h3>
|
|
<span class="type"><a href="../classes/DisplayObjectContainer.html" class="crosslink">DisplayObjectContainer</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_parent">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l58"><code>src/pixi/display/DisplayObject.js:58</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[read-only] The display object container that contains this display object.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_pivot" class="property item inherited">
|
|
<h3 class="name"><code>pivot</code></h3>
|
|
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_pivot">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l29"><code>src/pixi/display/DisplayObject.js:29</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The pivot point of the displayObject that it rotates around</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_position" class="property item inherited">
|
|
<h3 class="name"><code>position</code></h3>
|
|
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_position">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l15"><code>src/pixi/display/DisplayObject.js:15</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The coordinate of the object relative to the local coordinates of the parent.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_rotation" class="property item inherited">
|
|
<h3 class="name"><code>rotation</code></h3>
|
|
<span class="type">Number</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_rotation">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l36"><code>src/pixi/display/DisplayObject.js:36</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The rotation of the object in radians.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_scale" class="property item inherited">
|
|
<h3 class="name"><code>scale</code></h3>
|
|
<span class="type"><a href="../classes/Point.html" class="crosslink">Point</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_scale">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l22"><code>src/pixi/display/DisplayObject.js:22</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The scale factor of the object.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_stage" class="property item inherited">
|
|
<h3 class="name"><code>stage</code></h3>
|
|
<span class="type"><a href="../classes/Stage.html" class="crosslink">Stage</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_stage">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l65"><code>src/pixi/display/DisplayObject.js:65</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_texture" class="property item inherited">
|
|
<h3 class="name"><code>texture</code></h3>
|
|
<span class="type"><a href="../classes/Texture.html" class="crosslink">Texture</a></span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/Sprite.html#property_texture">Sprite</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_Sprite.js.html#l31"><code>src/pixi/display/Sprite.js:31</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The texture that the sprite is using</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_visible" class="property item inherited">
|
|
<h3 class="name"><code>visible</code></h3>
|
|
<span class="type">Boolean</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/DisplayObject.html#property_visible">DisplayObject</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_DisplayObject.js.html#l50"><code>src/pixi/display/DisplayObject.js:50</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The visibility of the object.</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="property_width" class="property item inherited">
|
|
<h3 class="name"><code>width</code></h3>
|
|
<span class="type">#Number</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="meta">
|
|
|
|
|
|
<p>Inherited from
|
|
<a href="../classes/Sprite.html#property_width">Sprite</a>:
|
|
|
|
|
|
|
|
<a href="../files/src_pixi_display_Sprite.js.html#l46"><code>src/pixi/display/Sprite.js:46</code></a>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="description">
|
|
<p>The width of the sprite (this is initially set by the texture)</p>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<script src="../assets/vendor/prettify/prettify-min.js"></script>
|
|
<script>prettyPrint();</script>
|
|
<script src="../assets/js/yui-prettify.js"></script>
|
|
<script src="../assets/../api.js"></script>
|
|
<script src="../assets/js/api-filter.js"></script>
|
|
<script src="../assets/js/api-list.js"></script>
|
|
<script src="../assets/js/api-search.js"></script>
|
|
<script src="../assets/js/apidocs.js"></script>
|
|
</body>
|
|
</html>
|