2013-10-25 15:54:40 +00:00
<!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/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 >
< a href = "Phaser.html" > Phaser< / 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 >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
< li >
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
< li >
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
< li >
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
< li >
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
< li >
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Color.html" > Color< / a >
< / li >
< li >
< a href = "Phaser.Device.html" > Device< / a >
< / li >
< li >
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
< / li >
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.Arcade.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.html" > Ninja< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.AABB.html" > AABB< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Physics.Ninja.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.html" > P2< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.BodyDebug.html" > BodyDebug< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.CollisionGroup.html" > CollisionGroup< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.ContactMaterial.html" > ContactMaterial< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.DistanceConstraint.html" > DistanceConstraint< / a >
< / li >
< li >
< a href = "Phaser.Physics.P2.GearConstraint.html" > GearConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.InversePointProxy.html" > InversePointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.LockConstraint.html" > LockConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Material.html" > Material< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PointProxy.html" > PointProxy< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.PrismaticConstraint.html" > PrismaticConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.RevoluteConstraint.html" > RevoluteConstraint< / a >
2014-02-21 15:37:26 +00:00
< / li >
< li >
2014-03-14 06:36:05 +00:00
< a href = "Phaser.Physics.P2.Spring.html" > Spring< / a >
2014-02-21 15:37:26 +00:00
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.QuadTree.html" > QuadTree< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
2014-03-14 06:36:05 +00:00
< li >
< a href = "Phaser.RetroFont.html" > RetroFont< / a >
< / li >
< li >
< a href = "Phaser.ScaleManager.html" > ScaleManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / 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" >
2014-02-21 15:37:26 +00:00
< 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 >
2013-10-25 15:54:40 +00:00
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-21 15:37:26 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-21" > line 21< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
2014-02-21 15:37:26 +00:00
< h3 class = "subsection-title" > Extends< / h3 >
< ul >
< li > PIXI.Text< / li >
< / ul >
2013-10-25 15:54:40 +00:00
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "align" > < span class = "type-signature" > < / span > align< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > align< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-596" > line 596< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "angle" > < span class = "type-signature" > < / span > angle< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
< div class = "description" >
2014-02-18 03:01:51 +00:00
< p > Indicates the rotation of the Text, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
If you wish to work in radians instead of degrees use the property Sprite.rotation instead.< / p >
2013-11-28 15:57:09 +00:00
< / div >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > angle< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > number< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Gets or sets the angle of rotation in degrees.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-457" > line 457< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "cameraOffset" > < span class = "type-signature" > < / span > cameraOffset< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > cameraOffset< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < 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 > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-113" > line 113< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "events" > < span class = "type-signature" > < / span > events< span class = "type-signature" > < / span > < / h4 >
2014-02-05 06:29:17 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > events< / code > < / td >
2014-02-05 06:29:17 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > < a href = "Phaser.Events.html" > Phaser.Events< / a > < / span >
2014-02-05 06:29:17 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-103" > line 103< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "exists" > < span class = "type-signature" > < / span > exists< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > exists< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > boolean< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > If exists = false then the Text isn't updated by the core game loop.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2014-02-18 03:01:51 +00:00
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > true< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-46" > line 46< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "fill" > < span class = "type-signature" > < / span > fill< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > fill< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > object< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-574" > line 574< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
2014-02-05 06:29:17 +00:00
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "fixedToCamera" > < span class = "type-signature" > < / span > fixedToCamera< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
2014-02-18 03:01:51 +00:00
< 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< / p >
2014-02-05 06:29:17 +00:00
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > fixedToCamera< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Set to true to fix this Text to the Camera at its current world coordinates.< / p > < / td >
2014-02-05 06:29:17 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-853" > line 853< / a >
2014-02-05 06:29:17 +00:00
< / li > < / ul > < / dd >
2013-10-25 15:54:40 +00:00
< / dl >
< / dd >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "font" > < span class = "type-signature" > < / span > font< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-11-28 15:57:09 +00:00
< td class = "name" > < code > font< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-500" > line 500< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "fontSize" > < span class = "type-signature" > < / span > fontSize< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > fontSize< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > number< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The size of the font in pixels.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-524" > line 524< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "fontWeight" > < span class = "type-signature" > < / span > fontWeight< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > fontWeight< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > number< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The weight of the font: 'normal', 'bold', 'italic'. You can combine settings too, such as 'bold italic'.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-550" > line 550< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > game< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > A reference to the currently running Game.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-40" > line 40< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "input" > < span class = "type-signature" > < / span > input< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > input< / code > < / td >
2013-10-25 15:54:40 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > < a href = "Phaser.InputHandler.html" > Phaser.InputHandler< / a > < / span >
|
< span class = "param-type" > null< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-108" > line 108< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "inputEnabled" > < span class = "type-signature" > < / span > inputEnabled< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
< 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.< / p >
< / div >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > inputEnabled< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > boolean< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Set to true to allow this object to receive input events.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-817" > line 817< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "lineSpacing" > < span class = "type-signature" > < / span > lineSpacing< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > lineSpacing< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > Additional spacing (in pixels) between each line of text if multi-line.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-706" > line 706< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "name" > < span class = "type-signature" > < / span > name< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > name< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
2014-02-18 03:01:51 +00:00
< span class = "param-type" > string< / span >
2013-11-28 15:57:09 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< td class = "description last" > < p > The user defined name given to this object.< / p > < / td >
2013-11-28 15:57:09 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-52" > line 52< / a >
2013-11-28 15:57:09 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "shadowBlur" > < span class = "type-signature" > < / span > shadowBlur< span class = "type-signature" > < / span > < / h4 >
2013-11-28 15:57:09 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > shadowBlur< / code > < / td >
2013-11-28 15:57:09 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
2013-10-25 15:54:40 +00:00
< / td >
2014-02-18 03:01:51 +00:00
< 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 >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-795" > line 795< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
< dt >
2014-02-18 03:01:51 +00:00
< h4 class = "name" id = "shadowColor" > < span class = "type-signature" > < / span > shadowColor< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
< / dt >
< dd >
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
< dl class = "details" >
2014-02-18 03:01:51 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > shadowColor< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / 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 >
< / tbody >
< / table >
< / dl >
2013-10-25 15:54:40 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-773" > line 773< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
2014-02-18 03:01:51 +00:00
< / dd >
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
< dt >
< h4 class = "name" id = "shadowOffsetX" > < span class = "type-signature" > < / span > shadowOffsetX< span class = "type-signature" > < / span > < / h4 >
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
< dl class = "details" >
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
< td class = "name" > < code > shadowOffsetX< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / 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 >
< / tbody >
< / table >
< / dl >
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
2013-10-25 15:54:40 +00:00
2014-02-18 03:01:51 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-729" > line 729< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "shadowOffsetY" > < span class = "type-signature" > < / span > shadowOffsetY< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > shadowOffsetY< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / 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 >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-751" > line 751< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "stroke" > < span class = "type-signature" > < / span > stroke< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > stroke< / 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 stroke eg 'blue', '#FCFF00'.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-618" > line 618< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "strokeThickness" > < span class = "type-signature" > < / span > strokeThickness< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > strokeThickness< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > A number that represents the thickness of the stroke. Default is 0 (no stroke)< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-640" > line 640< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "text" > < span class = "type-signature" > < / span > text< span class = "type-signature" > < / 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" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > text< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The text string to be displayed by this Text object, taking into account the style settings.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-476" > line 476< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "type" > < span class = "type-signature" > < / span > type< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > type< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The const type of this object.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-58" > line 58< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "wordWrap" > < span class = "type-signature" > < / span > wordWrap< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > wordWrap< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Indicates if word wrap should be used.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-662" > line 662< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "wordWrapWidth" > < span class = "type-signature" > < / span > wordWrapWidth< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > wordWrapWidth< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > The width at which text will wrap.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-684" > line 684< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "world" > < span class = "type-signature" > < / span > world< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > world< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Point.html" > Phaser.Point< / a > < / span >
< / td >
< td class = "description last" > < p > The world coordinates of this Sprite. This differs from the x/y coordinates which are relative to the Sprites container.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-68" > line 68< / a >
2014-03-14 06:36:05 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "z" > < span class = "type-signature" > < / span > z< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > z< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < 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 > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-63" > line 63< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
2014-03-14 06:36:05 +00:00
< 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 >
2014-02-18 03:01:51 +00:00
< / dt >
< dd >
2014-03-14 06:36:05 +00:00
< 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" >
< 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 >
2014-02-18 03:01:51 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-210" > line 210< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-190" > line 190< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-141" > line 141< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / 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" >
< 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" >
< 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" >
< 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" >
< 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:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-270" > line 270< / a >
2014-02-18 03:01:51 +00:00
< / li > < / ul > < / dd >
< / 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" >
< optional>< br >
< / td >
< td class = "description last" > < p > The style parameters< / 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" >
< 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" > Object< / span >
< / td >
< td class = "attributes" >
< 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" >
< 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" >
< optional>< br >
< / td >
< td class = "default" >
'black'
< / td >
< td class = "description last" > < p > A canvas fillstyle 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" >
< 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" >
< 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" >
< optional>< br >
< / td >
< td class = "default" >
100
< / td >
< td class = "description last" > < p > The width at which text will wrap< / p > < / td >
< / tr >
< / tbody >
< / table >
< / td >
< / tr >
< / tbody >
< / table >
2013-10-25 15:54:40 +00:00
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-287" > line 287< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / 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" >
2014-02-18 03:01:51 +00:00
< p > Override and use this function in your own custom objects to handle any update requirements you may have.< / p >
2013-10-25 15:54:40 +00:00
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-03-24 12:41:45 +00:00
< a href = "Text.js.html" > gameobjects/Text.js< / a > , < a href = "Text.js.html#sunlight-1-line-180" > line 180< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-03-24 12:41:45 +00:00
on Mon Mar 24 2014 12:38:54 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-25 15:54:40 +00:00
< / 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( {
2014-03-14 06:36:05 +00:00
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
2013-10-25 15:54:40 +00:00
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 >
