Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-16 09:48:18 +00:00
Code Issues Projects Releases Packages Wiki Activity
phaser/docs/Phaser.Text.html
photonstorm deeb2c4942 2.2 doc files.
2014-11-15 20:01:46 +00:00

10650 lines
No EOL
157 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Phaser Class: Text</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/default.css">
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Phaser</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="Phaser.html">Phaser</a>
</li>
<li class="class-depth-0">
<a href="PIXI.html">PIXI</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-1">
<a href="Phaser.Animation.html">Animation</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationManager.html">AnimationManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AnimationParser.html">AnimationParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayList.html">ArrayList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ArrayUtils.html">ArrayUtils</a>
</li>
<li class="class-depth-1">
<a href="Phaser.AudioSprite.html">AudioSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapData.html">BitmapData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Button.html">Button</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Cache.html">Cache</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Camera.html">Camera</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Canvas.html">Canvas</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Color.html">Color</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Device.html">Device</a>
</li>
<li class="class-depth-1">
<a href="Phaser.DOM.html">DOM</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Easing.html">Easing</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Back.html">Back</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Bounce.html">Bounce</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Circular.html">Circular</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Cubic.html">Cubic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Elastic.html">Elastic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Exponential.html">Exponential</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Linear.html">Linear</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quartic.html">Quartic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Quintic.html">Quintic</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Events.html">Events</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Filter.html">Filter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexGrid.html">FlexGrid</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FlexLayer.html">FlexLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Frame.html">Frame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.FrameData.html">FrameData</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Game.html">Game</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Gamepad.html">Gamepad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.GamepadButton.html">GamepadButton</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Group.html">Group</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Image.html">Image</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Input.html">Input</a>
</li>
<li class="class-depth-1">
<a href="Phaser.InputHandler.html">InputHandler</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Key.html">Key</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Keyboard.html">Keyboard</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Line.html">Line</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LinkedList.html">LinkedList</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Loader.html">Loader</a>
</li>
<li class="class-depth-1">
<a href="Phaser.LoaderParser.html">LoaderParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Math.html">Math</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Mouse.html">Mouse</a>
</li>
<li class="class-depth-1">
<a href="Phaser.MSPointer.html">MSPointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Net.html">Net</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particle.html">Particle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Particles.html">Particles</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Particles.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Physics.html">Physics</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Arcade.html">Arcade</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.Ninja.html">Ninja</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Physics.P2.html">P2</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Body.html">Body</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Material.html">Material</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.RotationalSpring.html">RotationalSpring</a>
</li>
<li class="class-depth-3">
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Plugin.html">Plugin</a>
</li>
<li class="class-depth-1">
<a href="Phaser.PluginManager.html">PluginManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Pointer.html">Pointer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="Phaser.QuadTree.html">QuadTree</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
</li>
<li class="class-depth-1">
<a href="Phaser.RetroFont.html">RetroFont</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="Phaser.ScaleManager.html">ScaleManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Signal.html">Signal</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SignalBinding.html">SignalBinding</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SinglePad.html">SinglePad</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sound.html">Sound</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SoundManager.html">SoundManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="Phaser.State.html">State</a>
</li>
<li class="class-depth-1">
<a href="Phaser.StateManager.html">StateManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tile.html">Tile</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tilemap.html">Tilemap</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TilemapParser.html">TilemapParser</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tileset.html">Tileset</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TileSprite.html">TileSprite</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Time.html">Time</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Timer.html">Timer</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TimerEvent.html">TimerEvent</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Touch.html">Touch</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Tween.html">Tween</a>
</li>
<li class="class-depth-1">
<a href="Phaser.TweenManager.html">TweenManager</a>
</li>
<li class="class-depth-1">
<a href="Phaser.Utils.html">Utils</a>
</li>
<li class="class-depth-2">
<a href="Phaser.Utils.Debug.html">Debug</a>
</li>
<li class="class-depth-1">
<a href="Phaser.World.html">World</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AbstractFilter.html">AbstractFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AjaxRequest.html">AjaxRequest</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AlphaMaskFilter.html">AlphaMaskFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AsciiFilter.html">AsciiFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AssetLoader.html">AssetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.AtlasLoader.html">AtlasLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BaseTexture.html">BaseTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapFontLoader.html">BitmapFontLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BitmapText.html">BitmapText</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurFilter.html">BlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurXFilter.html">BlurXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.BlurYFilter.html">BlurYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasBuffer.html">CanvasBuffer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasGraphics.html">CanvasGraphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasMaskManager.html">CanvasMaskManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasRenderer.html">CanvasRenderer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CanvasTinter.html">CanvasTinter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Circle.html">Circle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorMatrixFilter.html">ColorMatrixFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ColorStepFilter.html">ColorStepFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ComplexPrimitiveShader.html">ComplexPrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ConvolutionFilter.html">ConvolutionFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.CrossHatchFilter.html">CrossHatchFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplacementFilter.html">DisplacementFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObject.html">DisplayObject</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DisplayObjectContainer.html">DisplayObjectContainer</a>
</li>
<li class="class-depth-1">
<a href="PIXI.DotScreenFilter.html">DotScreenFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Ellipse.html">Ellipse</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Event.html">Event</a>
</li>
<li class="class-depth-1">
<a href="PIXI.EventTarget.html">EventTarget</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterBlock.html">FilterBlock</a>
</li>
<li class="class-depth-1">
<a href="PIXI.FilterTexture.html">FilterTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Graphics.html">Graphics</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GraphicsData.html">GraphicsData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.GrayFilter.html">GrayFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.ImageLoader.html">ImageLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionData.html">InteractionData</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InteractionManager.html">InteractionManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.InvertFilter.html">InvertFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.JsonLoader.html">JsonLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Matrix.html">Matrix</a>
</li>
<li class="class-depth-1">
<a href="PIXI.MovieClip.html">MovieClip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NoiseFilter.html">NoiseFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.NormalMapFilter.html">NormalMapFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixelateFilter.html">PixelateFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PIXI.html">PIXI</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiFastShader.html">PixiFastShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PixiShader.html">PixiShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Point.html">Point</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Polygon.html">Polygon</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PolyK.html">PolyK</a>
</li>
<li class="class-depth-1">
<a href="PIXI.PrimitiveShader.html">PrimitiveShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rectangle.html">Rectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RenderTexture.html">RenderTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RGBSplitFilter.html">RGBSplitFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Rope.html">Rope</a>
</li>
<li class="class-depth-1">
<a href="PIXI.RoundedRectangle.html">RoundedRectangle</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SepiaFilter.html">SepiaFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SmartBlurFilter.html">SmartBlurFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Spine.html">Spine</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpineLoader.html">SpineLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Sprite.html">Sprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteBatch.html">SpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.SpriteSheetLoader.html">SpriteSheetLoader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Stage.html">Stage</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Strip.html">Strip</a>
</li>
<li class="class-depth-1">
<a href="PIXI.StripShader.html">StripShader</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Text.html">Text</a>
</li>
<li class="class-depth-1">
<a href="PIXI.Texture.html">Texture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TilingSprite.html">TilingSprite</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftFilter.html">TiltShiftFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftXFilter.html">TiltShiftXFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TiltShiftYFilter.html">TiltShiftYFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.TwistFilter.html">TwistFilter</a>
</li>
<li class="class-depth-1">
<a href="PIXI.VideoTexture.html">VideoTexture</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLBlendModeManager.html">WebGLBlendModeManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFastSpriteBatch.html">WebGLFastSpriteBatch</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLFilterManager.html">WebGLFilterManager</a>
</li>
<li class="class-depth-1">
<a href="PIXI.WebGLRenderer.html">WebGLRenderer</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li class="class-depth-0">
<a href="global.html#clone">clone</a>
</li>
<li class="class-depth-0">
<a href="global.html#createCustomLayer">createCustomLayer</a>
</li>
<li class="class-depth-0">
<a href="global.html#createFixedLayer">createFixedLayer</a>
</li>
<li class="class-depth-0">
<a href="global.html#createFluidLayer">createFluidLayer</a>
</li>
<li class="class-depth-0">
<a href="global.html#createFullLayer">createFullLayer</a>
</li>
<li class="class-depth-0">
<a href="global.html#debug">debug</a>
</li>
<li class="class-depth-0">
<a href="global.html#destroy">destroy</a>
</li>
<li class="class-depth-0">
<a href="global.html#onResize">onResize</a>
</li>
<li class="class-depth-0">
<a href="global.html#originalEvent">originalEvent</a>
</li>
<li class="class-depth-0">
<a href="global.html#refresh">refresh</a>
</li>
<li class="class-depth-0">
<a href="global.html#reset">reset</a>
</li>
<li class="class-depth-0">
<a href="global.html#setSize">setSize</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Class: Text</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="Phaser.html">Phaser</a>.</span>
Text
</h2>
<div class="class-description"><p>Phaser.Text</p></div>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name "
id="Text"><span class="type-signature"></span>new Text<span class="signature">(game, x, y, text, style)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Create a new <code>Text</code> object. This uses a local hidden Canvas object and renders the type into it. It then makes a texture from this for renderning to the view.
Because of this you can only display fonts that are currently loaded and available to the browser. It won't load the fonts for you.
Here is a compatibility table showing the available default fonts across different mobile browsers: <a href="http://www.jordanm.co.uk/tinytype">http://www.jordanm.co.uk/tinytype</a></p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="Phaser.Game.html">Phaser.Game</a></span>
</td>
<td class="description last"><p>Current game instance.</p></td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>X position of the new text object.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Y position of the new text object.</p></td>
</tr>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The actual text that will be written.</p></td>
</tr>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"><p>The style object containing style attributes like font, font size ,</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-21">line 21</a>
</dt>
</dl>
</dd>
</div>
<h3 class="subsection-title">Extends</h3>
<ul>
<li><a href="PIXI.Text.html">PIXI.Text</a></li>
</ul>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name "
id="align"><span class="type-signature"></span>align<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-717">line 717</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="alpha"><span class="type-signature"></span>alpha<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The opacity of the object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#alpha">PIXI.DisplayObject#alpha</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-65">line 65</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="anchor"><span class="type-signature"></span>anchor<span class="type-signature"> :<a href="PIXI.Point.html">PIXI.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's 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 corner</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#anchor">PIXI.Sprite#anchor</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Sprite.js.html">pixi/display/Sprite.js</a>, <a href="Sprite.js.html#sunlight-1-line-22">line 22</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="angle"><span class="type-signature"></span>angle<span class="type-signature"> :number</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. Gets or sets the angle of rotation in degrees.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-562">line 562</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="blendMode"><span class="type-signature"></span>blendMode<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#blendMode">PIXI.Sprite#blendMode</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>PIXI.blendModes.NORMAL;</li></ul></dd>
<dt class="tag-source">Source -
<a href="Sprite.js.html">pixi/display/Sprite.js</a>, <a href="Sprite.js.html#sunlight-1-line-68">line 68</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="buttonMode"><span class="type-signature"></span>buttonMode<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>This is used to indicate if the displayObject should display a mouse hand cursor on rollover</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#buttonMode">PIXI.DisplayObject#buttonMode</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-90">line 90</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="cacheAsBitmap"><span class="type-signature"></span>cacheAsBitmap<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Set if this display object is cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'null'</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#cacheAsBitmap">PIXI.DisplayObject#cacheAsBitmap</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-436">line 436</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="cameraOffset"><span class="type-signature"></span>cameraOffset<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>If this object is fixedToCamera then this stores the x/y offset that its drawn at, from the top-left of the camera view.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-119">line 119</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="canvas"><span class="type-signature"></span>canvas<span class="type-signature"> :HTMLCanvasElement</span></h4>
</dt>
<dd>
<div class="description">
<p>The canvas element that everything is drawn to</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#canvas">PIXI.Text#canvas</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-29">line 29</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="children"><span class="type-signature">&lt;readonly> </span>children<span class="type-signature"> :Array.&lt;DisplayObject></span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] The array of children of this container.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;DisplayObject></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#children">PIXI.DisplayObjectContainer#children</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-17">line 17</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="colors"><span class="type-signature"></span>colors<span class="type-signature"> :array</span></h4>
</dt>
<dd>
<div class="description">
<p>An array of the color values as specified by <code>Text.addColor</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-124">line 124</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="context"><span class="type-signature"></span>context<span class="type-signature"> :HTMLCanvasElement</span></h4>
</dt>
<dd>
<div class="description">
<p>The canvas 2d context that everything is drawn with</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#context">PIXI.Text#context</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-37">line 37</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="defaultCursor"><span class="type-signature"></span>defaultCursor<span class="type-signature"> :String</span></h4>
</dt>
<dd>
<div class="description">
<p>This is the cursor that will be used when the mouse is over this object. To enable this the element must have interaction = true and buttonMode = true</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#defaultCursor">PIXI.DisplayObject#defaultCursor</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-143">line 143</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="destroyPhase"><span class="type-signature"></span>destroyPhase<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>True if this object is currently being destroyed.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-1014">line 1014</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="events"><span class="type-signature"></span>events<span class="type-signature"> :<a href="Phaser.Events.html">Phaser.Events</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-109">line 109</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="exists"><span class="type-signature"></span>exists<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>If exists = false then the Text isn't updated by the core game loop.</p>
</div>
<dl class="details">
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>true</li></ul></dd>
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-46">line 46</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fill"><span class="type-signature"></span>fill<span class="type-signature"> :object</span></h4>
</dt>
<dd>
<div class="description">
<p>A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-695">line 695</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="filterArea"><span class="type-signature"></span>filterArea<span class="type-signature"> :<a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The area the filter is applied to like the hitArea this is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#filterArea">PIXI.DisplayObject#filterArea</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-180">line 180</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="filters"><span class="type-signature"></span>filters<span class="type-signature"> :Array.&lt;Filter></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the filters for the displayObject.
IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.&lt;Filter></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#filters">PIXI.DisplayObject#filters</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-400">line 400</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fixedToCamera"><span class="type-signature"></span>fixedToCamera<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>An Text that is fixed to the camera uses its x/y coordinates as offsets from the top left of the camera. These are stored in Text.cameraOffset.
Note that the cameraOffset values are in addition to any parent in the display list.
So if this Text was in a Group that has x: 200, then this will be added to the cameraOffset.x Set to true to fix this Text to the Camera at its current world coordinates.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-983">line 983</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="font"><span class="type-signature"></span>font<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-609">line 609</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fontSize"><span class="type-signature"></span>fontSize<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The size of the font in pixels.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-637">line 637</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="fontWeight"><span class="type-signature"></span>fontWeight<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The weight of the font: 'normal', 'bold', 'italic'. You can combine settings too, such as 'bold italic'.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-667">line 667</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="game"><span class="type-signature"></span>game<span class="type-signature"> :<a href="Phaser.Game.html">Phaser.Game</a></span></h4>
</dt>
<dd>
<div class="description">
<p>A reference to the currently running Game.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-40">line 40</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="height"><span class="type-signature"></span>height<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The height of the Text, setting this will actually modify the scale to achieve the value set</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#height">PIXI.Text#height</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-86">line 86</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="hitArea"><span class="type-signature"></span>hitArea<span class="type-signature"> :<a href="PIXI.Rectangle.html">PIXI.Rectangle</a>|<a href="PIXI.Circle.html">PIXI.Circle</a>|<a href="PIXI.Ellipse.html">PIXI.Ellipse</a>|<a href="PIXI.Polygon.html">PIXI.Polygon</a></span></h4>
</dt>
<dd>
<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>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span>
|
<span class="param-type"><a href="PIXI.Circle.html">PIXI.Circle</a></span>
|
<span class="param-type"><a href="PIXI.Ellipse.html">PIXI.Ellipse</a></span>
|
<span class="param-type"><a href="PIXI.Polygon.html">PIXI.Polygon</a></span>
</li>
</ul>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#hitArea">PIXI.DisplayObject#hitArea</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-81">line 81</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="input"><span class="type-signature"></span>input<span class="type-signature"> :<a href="Phaser.InputHandler.html">Phaser.InputHandler</a>|null</span></h4>
</dt>
<dd>
<div class="description">
<p>The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="Phaser.InputHandler.html">Phaser.InputHandler</a></span>
|
<span class="param-type">null</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-114">line 114</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="inputEnabled"><span class="type-signature"></span>inputEnabled<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>By default a Text object won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is
activated for this object and it will then start to process click/touch events and more. Set to true to allow this object to receive input events.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-942">line 942</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="interactive"><span class="type-signature"></span>interactive<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Indicates if the sprite will have touch and mouse interactivity. It is false by default</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#interactive">PIXI.DisplayObject#interactive</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>false</li></ul></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-339">line 339</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="lineSpacing"><span class="type-signature"></span>lineSpacing<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>Additional spacing (in pixels) between each line of text if multi-line.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-827">line 827</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mask"><span class="type-signature"></span>mask<span class="type-signature"> :<a href="PIXI.Graphics.html">PIXI.Graphics</a></span></h4>
</dt>
<dd>
<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.Graphics 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>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mask">PIXI.DisplayObject#mask</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-380">line 380</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The user defined name given to this object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-52">line 52</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="parent"><span class="type-signature">&lt;readonly> </span>parent<span class="type-signature"> :<a href="PIXI.DisplayObjectContainer.html">PIXI.DisplayObjectContainer</a></span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] The display object container that contains this display object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#parent">PIXI.DisplayObject#parent</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-106">line 106</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="pivot"><span class="type-signature"></span>pivot<span class="type-signature"> :<a href="PIXI.Point.html">PIXI.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The pivot point of the displayObject that it rotates around</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#pivot">PIXI.DisplayObject#pivot</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-49">line 49</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="position"><span class="type-signature"></span>position<span class="type-signature"> :<a href="PIXI.Point.html">PIXI.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The coordinate of the object relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#position">PIXI.DisplayObject#position</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-14">line 14</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="renderable"><span class="type-signature"></span>renderable<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Can this object be rendered</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#renderable">PIXI.DisplayObject#renderable</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-98">line 98</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="resolution"><span class="type-signature"></span>resolution<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The resolution of the canvas.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#resolution">PIXI.Text#resolution</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-44">line 44</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="rotation"><span class="type-signature"></span>rotation<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The rotation of the object in radians.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#rotation">PIXI.DisplayObject#rotation</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-57">line 57</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="scale"><span class="type-signature"></span>scale<span class="type-signature"> :<a href="PIXI.Point.html">PIXI.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The scale factor of the object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#scale">PIXI.DisplayObject#scale</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-22">line 22</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="shader"><span class="type-signature"></span>shader<span class="type-signature"> :<a href="PIXI.AbstractFilter.html">PIXI.AbstractFilter</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The shader that will be used to render the texture to the stage. Set to null to remove a current shader.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#shader">PIXI.Sprite#shader</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>null</li></ul></dd>
<dt class="tag-source">Source -
<a href="Sprite.js.html">pixi/display/Sprite.js</a>, <a href="Sprite.js.html#sunlight-1-line-77">line 77</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="shadowBlur"><span class="type-signature"></span>shadowBlur<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene).</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-920">line 920</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="shadowColor"><span class="type-signature"></span>shadowColor<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-898">line 898</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="shadowOffsetX"><span class="type-signature"></span>shadowOffsetX<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-854">line 854</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="shadowOffsetY"><span class="type-signature"></span>shadowOffsetY<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-876">line 876</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stage"><span class="type-signature">&lt;readonly> </span>stage<span class="type-signature"> :<a href="PIXI.Stage.html">PIXI.Stage</a></span></h4>
</dt>
<dd>
<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>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#stage">PIXI.DisplayObject#stage</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-115">line 115</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="stroke"><span class="type-signature"></span>stroke<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-739">line 739</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="strokeThickness"><span class="type-signature"></span>strokeThickness<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>A number that represents the thickness of the stroke. Default is 0 (no stroke)</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-761">line 761</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="text"><span class="type-signature"></span>text<span class="type-signature"> :string</span></h4>
</dt>
<dd>
<div class="description">
<p>The text string to be displayed by this Text object, taking into account the style settings.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-581">line 581</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="texture"><span class="type-signature"></span>texture<span class="type-signature"> :<a href="PIXI.Texture.html">PIXI.Texture</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The texture that the sprite is using</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#texture">PIXI.Sprite#texture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Sprite.js.html">pixi/display/Sprite.js</a>, <a href="Sprite.js.html#sunlight-1-line-33">line 33</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tint"><span class="type-signature"></span>tint<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#tint">PIXI.Sprite#tint</a>
</li></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy"><li>0xFFFFFF</li></ul></dd>
<dt class="tag-source">Source -
<a href="Sprite.js.html">pixi/display/Sprite.js</a>, <a href="Sprite.js.html#sunlight-1-line-59">line 59</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="transformCallback"><span class="type-signature"></span>transformCallback<span class="type-signature"> :function</span></h4>
</dt>
<dd>
<div class="description">
<p>The transform callback is an optional callback that if set will be called at the end of the updateTransform method and sent two parameters:
This Display Objects worldTransform matrix and its parents transform matrix. Both are PIXI.Matrix object types.
The matrix are passed by reference and can be modified directly without needing to return them.
This ability allows you to check any of the matrix values and perform actions such as clamping scale or limiting rotation, regardless of the parent transforms.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#transformCallback">PIXI.DisplayObject#transformCallback</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-30">line 30</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="transformCallbackContext"><span class="type-signature"></span>transformCallbackContext<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
<p>The context under which the transformCallback is invoked.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#transformCallbackContext">PIXI.DisplayObject#transformCallbackContext</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-41">line 41</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="type"><span class="type-signature"></span>type<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The const type of this object.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-58">line 58</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="visible"><span class="type-signature"></span>visible<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>The visibility of the object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#visible">PIXI.DisplayObject#visible</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-73">line 73</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="width"><span class="type-signature"></span>width<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The width of the Text, setting this will actually modify the scale to achieve the value set</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#width">PIXI.Text#width</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-62">line 62</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="wordWrap"><span class="type-signature"></span>wordWrap<span class="type-signature"> :boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>Indicates if word wrap should be used.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-783">line 783</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="wordWrapWidth"><span class="type-signature"></span>wordWrapWidth<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The width at which text will wrap.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-805">line 805</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="world"><span class="type-signature"></span>world<span class="type-signature"> :<a href="Phaser.Point.html">Phaser.Point</a></span></h4>
</dt>
<dd>
<div class="description">
<p>The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-68">line 68</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldAlpha"><span class="type-signature">&lt;readonly> </span>worldAlpha<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] The multiplied alpha of the displayObject</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldAlpha">PIXI.DisplayObject#worldAlpha</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-124">line 124</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="worldVisible"><span class="type-signature"></span>worldVisible<span class="type-signature"> :Boolean</span></h4>
</dt>
<dd>
<div class="description">
<p>[read-only] Indicates if the sprite is globally visible.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#worldVisible">PIXI.DisplayObject#worldVisible</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-359">line 359</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="x"><span class="type-signature"></span>x<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the displayObject on the x axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#x">PIXI.DisplayObject#x</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-762">line 762</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="y"><span class="type-signature"></span>y<span class="type-signature"> :Number</span></h4>
</dt>
<dd>
<div class="description">
<p>The position of the displayObject on the y axis relative to the local coordinates of the parent.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#y">PIXI.DisplayObject#y</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-777">line 777</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="z"><span class="type-signature"></span>z<span class="type-signature"> :number</span></h4>
</dt>
<dd>
<div class="description">
<p>The z-depth value of this object within its Group (remember the World is a Group as well). No two objects in a Group can have the same z value.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-63">line 63</a>
</dt>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name "
id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Adds a child to the container.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The DisplayObject to add to the container</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was added.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#addChild">PIXI.DisplayObjectContainer#addChild</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-90">line 90</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addChildAt"><span class="type-signature"></span>addChildAt<span class="signature">(child, index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<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>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The child to add</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The index to place the child in</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was added.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#addChildAt">PIXI.DisplayObjectContainer#addChildAt</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-102">line 102</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="addColor"><span class="type-signature"></span>addColor<span class="signature">(color, position)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>This method allows you to set specific colors within the Text.
It works by taking a color value, which is a typical HTML string such as <code>#ff0000</code> or <code>rgb(255,0,0)</code> and a position.
The position value is the index of the character in the Text string to start applying this color to.
Once set the color remains in use until either another color or the end of the string is encountered.
For example if the Text was <code>Photon Storm</code> and you did <code>Text.addColor('#ffff00', 6)</code> it would color in the word <code>Storm</code> in yellow.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>A canvas fillstyle that will be used on the text eg <code>red</code>, <code>#00FF00</code>, <code>rgba()</code>.</p></td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>The index of the character in the string to start applying this color value from.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-495">line 495</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="clearColors"><span class="type-signature"></span>clearColors<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Clears any previously set color stops.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-483">line 483</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="click"><span class="type-signature"></span>click<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the users clicks on the displayObject with their mouse's left button</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#click">PIXI.DisplayObject#click</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-252">line 252</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="destroy"><span class="type-signature"></span>destroy<span class="signature">(<span class="optional">destroyChildren</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>destroyChildren</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
true
</td>
<td class="description last"><p>Should every child of this object have its destroy method called?</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-227">line 227</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="generateTexture"><span class="type-signature"></span>generateTexture<span class="signature">(resolution, scaleMode, renderer)</span><span class="type-signature"> &rarr; {<a href="PIXI.Texture.html">PIXI.Texture</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Useful function that returns a texture of the displayObject object that can then be used to create sprites
This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resolution</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The resolution of the texture being generated</p></td>
</tr>
<tr>
<td class="name"><code>scaleMode</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>See {{#crossLink &quot;PIXI/scaleModes:property&quot;}}PIXI.scaleModes{{/crossLink}} for possible values</p></td>
</tr>
<tr>
<td class="name"><code>renderer</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.CanvasRenderer.html">PIXI.CanvasRenderer</a></span>
|
<span class="param-type"><a href="PIXI.WebGLRenderer.html">PIXI.WebGLRenderer</a></span>
</td>
<td class="description last"><p>The renderer used to generate the texture.</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>a texture of the graphics object</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#generateTexture">PIXI.DisplayObject#generateTexture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-583">line 583</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getBounds"><span class="type-signature"></span>getBounds<span class="signature">(matrix)</span><span class="type-signature"> &rarr; {<a href="PIXI.Rectangle.html">PIXI.Rectangle</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>matrix</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Matrix.html">PIXI.Matrix</a></span>
</td>
<td class="description last"><p>the transformation matrix of the Text</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>the framing rectangle</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#getBounds">PIXI.Text#getBounds</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-492">line 492</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getChildAt"><span class="type-signature"></span>getChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the child at the specified index</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The index to get the child from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child at the given index, if any.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getChildAt">PIXI.DisplayObjectContainer#getChildAt</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-193">line 193</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getChildIndex"><span class="type-signature"></span>getChildIndex<span class="signature">(child)</span><span class="type-signature"> &rarr; {Number}</span></h4>
</dt>
<dd>
<div class="description">
<p>Returns the index position of a child DisplayObject instance</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The DisplayObject instance to identify</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type">Number</span>
-
</div>
<div class="returns-desc param-desc">
<p>The index position of the child display object to identify</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getChildIndex">PIXI.DisplayObjectContainer#getChildIndex</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-158">line 158</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="getLocalBounds"><span class="type-signature"></span>getLocalBounds<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="PIXI.Rectangle.html">PIXI.Rectangle</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.</p>
</div>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Rectangle.html">PIXI.Rectangle</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The rectangular bounding area</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#getLocalBounds">PIXI.DisplayObjectContainer#getLocalBounds</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-362">line 362</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mousedown"><span class="type-signature"></span>mousedown<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user clicks the mouse's left button down over the sprite</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mousedown">PIXI.DisplayObject#mousedown</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-258">line 258</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mouseout"><span class="type-signature"></span>mouseout<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the users mouse leaves the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mouseout">PIXI.DisplayObject#mouseout</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-245">line 245</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mouseover"><span class="type-signature"></span>mouseover<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the users mouse rolls over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mouseover">PIXI.DisplayObject#mouseover</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-239">line 239</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mouseup"><span class="type-signature"></span>mouseup<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user releases the mouse's left button that was over the displayObject
for this callback to be fired, the mouse's left button must have been pressed down over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mouseup">PIXI.DisplayObject#mouseup</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-264">line 264</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="mouseupoutside"><span class="type-signature"></span>mouseupoutside<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user releases the mouse's left button that was over the displayObject but is no longer over the displayObject
for this callback to be fired, the mouse's left button must have been pressed down over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#mouseupoutside">PIXI.DisplayObject#mouseupoutside</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-271">line 271</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="postUpdate"><span class="type-signature"></span>postUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Automatically called by World.postUpdate.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-207">line 207</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="preUpdate"><span class="type-signature"></span>preUpdate<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Automatically called by World.preUpdate.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-158">line 158</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeChild"><span class="type-signature"></span>removeChild<span class="signature">(child)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a child from the container.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The DisplayObject to remove</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was removed.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#removeChild">PIXI.DisplayObjectContainer#removeChild</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-210">line 210</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeChildAt"><span class="type-signature"></span>removeChildAt<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Removes a child from the specified index position.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The index to get the child from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>The child that was removed.</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#removeChildAt">PIXI.DisplayObjectContainer#removeChildAt</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-225">line 225</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeChildren"><span class="type-signature"></span>removeChildren<span class="signature">(beginIndex, endIndex)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes all children from this container that are within the begin and end indexes.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>beginIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The beginning position. Default value is 0.</p></td>
</tr>
<tr>
<td class="name"><code>endIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The ending position. Default value is size of the container.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#removeChildren">PIXI.DisplayObjectContainer#removeChildren</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-243">line 243</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="removeStageReference"><span class="type-signature"></span>removeStageReference<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Removes the current stage reference from the container and all of its children.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#removeStageReference">PIXI.DisplayObjectContainer#removeStageReference</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-404">line 404</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="rightclick"><span class="type-signature"></span>rightclick<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the users clicks on the displayObject with their mouse's right button</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#rightclick">PIXI.DisplayObject#rightclick</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-279">line 279</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="rightdown"><span class="type-signature"></span>rightdown<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user clicks the mouse's right button down over the sprite</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#rightdown">PIXI.DisplayObject#rightdown</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-285">line 285</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="rightup"><span class="type-signature"></span>rightup<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user releases the mouse's right button that was over the displayObject
for this callback to be fired the mouse's right button must have been pressed down over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#rightup">PIXI.DisplayObject#rightup</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-291">line 291</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="rightupoutside"><span class="type-signature"></span>rightupoutside<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user releases the mouse's right button that was over the displayObject but is no longer over the displayObject
for this callback to be fired, the mouse's right button must have been pressed down over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#rightupoutside">PIXI.DisplayObject#rightupoutside</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-298">line 298</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setChildIndex"><span class="type-signature"></span>setChildIndex<span class="signature">(child, index)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Changes the position of an existing child in the display object container</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>The child DisplayObject instance for which you want to change the index number</p></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"><p>The resulting index number for the child display object</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#setChildIndex">PIXI.DisplayObjectContainer#setChildIndex</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-175">line 175</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setShadow"><span class="type-signature"></span>setShadow<span class="signature">(<span class="optional">x</span>, <span class="optional">y</span>, <span class="optional">color</span>, <span class="optional">blur</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</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="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.</p></td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'rgba(0,0,0,0)'
</td>
<td class="description last"><p>The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.</p></td>
</tr>
<tr>
<td class="name"><code>blur</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>The shadowBlur value. Make the shadow softer by applying a Gaussian blur to it. A number from 0 (no blur) up to approx. 10 (depending on scene).</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-296">line 296</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setStageReference"><span class="type-signature"></span>setStageReference<span class="signature">(stage)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>stage</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Stage.html">PIXI.Stage</a></span>
</td>
<td class="description last"><p>the stage that the container will have as its current stage reference</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#setStageReference">PIXI.DisplayObjectContainer#setStageReference</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-386">line 386</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setStyle"><span class="type-signature"></span>setStyle<span class="signature">(<span class="optional">style</span>)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the style of the text by passing a single style object to it.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>style</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The style properties to be set on the Text.</p>
<h6>Properties</h6>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</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="attributes">
&lt;optional><br>
</td>
<td class="default">
'bold 20pt Arial'
</td>
<td class="description last"><p>The style and size of the font.</p></td>
</tr>
<tr>
<td class="name"><code>fill</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'black'
</td>
<td class="description last"><p>A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.</p></td>
</tr>
<tr>
<td class="name"><code>align</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'left'
</td>
<td class="description last"><p>Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.</p></td>
</tr>
<tr>
<td class="name"><code>stroke</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
'black'
</td>
<td class="description last"><p>A canvas stroke style that will be used on the text stroke eg 'blue', '#FCFF00'.</p></td>
</tr>
<tr>
<td class="name"><code>strokeThickness</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
0
</td>
<td class="description last"><p>A number that represents the thickness of the stroke. Default is 0 (no stroke).</p></td>
</tr>
<tr>
<td class="name"><code>wordWrap</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
false
</td>
<td class="description last"><p>Indicates if word wrap should be used.</p></td>
</tr>
<tr>
<td class="name"><code>wordWrapWidth</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="default">
100
</td>
<td class="description last"><p>The width in pixels at which text will wrap.</p></td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-313">line 313</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setText"><span class="type-signature"></span>setText<span class="signature">(text)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Set the copy for the text object. To split a line you can use '\n'.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>The copy that you would like the text to display</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Text.html#setText">PIXI.Text#setText</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Text.js.html">pixi/text/Text.js</a>, <a href="Text.js.html#sunlight-1-line-147">line 147</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="setTexture"><span class="type-signature"></span>setTexture<span class="signature">(texture)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Sets the texture of the sprite</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>texture</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Texture.html">PIXI.Texture</a></span>
</td>
<td class="description last"><p>The PIXI texture that is displayed by the sprite</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.Sprite.html#setTexture">PIXI.Sprite#setTexture</a>
</li></dd>
<dt class="tag-source">Source -
<a href="Sprite.js.html">pixi/display/Sprite.js</a>, <a href="Sprite.js.html#sunlight-1-line-135">line 135</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="swapChildren"><span class="type-signature"></span>swapChildren<span class="signature">(child, child2)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Swaps the position of 2 Display Objects within this container.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>child</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
<tr>
<td class="name"><code>child2</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObjectContainer.html#swapChildren">PIXI.DisplayObjectContainer#swapChildren</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObjectContainer.js.html">pixi/display/DisplayObjectContainer.js</a>, <a href="DisplayObjectContainer.js.html#sunlight-1-line-133">line 133</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="tap"><span class="type-signature"></span>tap<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#tap">PIXI.DisplayObject#tap</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-309">line 309</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="toGlobal"><span class="type-signature"></span>toGlobal<span class="signature">(position)</span><span class="type-signature"> &rarr; {<a href="PIXI.Point.html">PIXI.Point</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Calculates the global position of the display object</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Point.html">PIXI.Point</a></span>
</td>
<td class="description last"><p>The world origin to calculate from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Point.html">PIXI.Point</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this object</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#toGlobal">PIXI.DisplayObject#toGlobal</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-617">line 617</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="toLocal"><span class="type-signature"></span>toLocal<span class="signature">(position, <span class="optional">from</span>)</span><span class="type-signature"> &rarr; {<a href="PIXI.Point.html">PIXI.Point</a>}</span></h4>
</dt>
<dd>
<div class="description">
<p>Calculates the local position of the display object relative to another point</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.Point.html">PIXI.Point</a></span>
</td>
<td class="attributes">
</td>
<td class="description last"><p>The world origin to calculate from</p></td>
</tr>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.DisplayObject.html">PIXI.DisplayObject</a></span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>The DisplayObject to calculate the global position from</p></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="returns">
<div class="returns-type">
<span class="param-type"><a href="PIXI.Point.html">PIXI.Point</a></span>
-
</div>
<div class="returns-desc param-desc">
<p>A point object representing the position of this object</p>
</div>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#toLocal">PIXI.DisplayObject#toLocal</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-631">line 631</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="touchend"><span class="type-signature"></span>touchend<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user releases a touch over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#touchend">PIXI.DisplayObject#touchend</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-322">line 322</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="touchendoutside"><span class="type-signature"></span>touchendoutside<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<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>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#touchendoutside">PIXI.DisplayObject#touchendoutside</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-328">line 328</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="touchstart"><span class="type-signature"></span>touchstart<span class="signature">(interactionData)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>A callback that is used when the user touches over the displayObject</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>interactionData</code></td>
<td class="type">
<span class="param-type"><a href="PIXI.InteractionData.html">PIXI.InteractionData</a></span>
</td>
<td class="description last"><p>-</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#touchstart">PIXI.DisplayObject#touchstart</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-316">line 316</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="update"><span class="type-signature"></span>update<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Override and use this function in your own custom objects to handle any update requirements you may have.</p>
</div>
<dl class="details">
<dt class="tag-source">Source -
<a href="Text.js_.html">gameobjects/Text.js</a>, <a href="Text.js_.html#sunlight-1-line-197">line 197</a>
</dt>
</dl>
</dd>
<dt>
<h4 class="name "
id="updateCache"><span class="type-signature"></span>updateCache<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
<p>Generates and updates the cached sprite for this object.</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a href="PIXI.DisplayObject.html#updateCache">PIXI.DisplayObject#updateCache</a>
</li></dd>
<dt class="tag-source">Source -
<a href="DisplayObject.js.html">pixi/display/DisplayObject.js</a>, <a href="DisplayObject.js.html#sunlight-1-line-607">line 607</a>
</dt>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Phaser Copyright © 2012-2014 Photon Storm Ltd.
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Sat Nov 15 2014 19:55:01 GMT-0000 (GMT) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>
Reference in a new issue View git blame Copy permalink