phaser/resources/docgen/output/Phaser.Text.json

{"class":{"name":"Phaser.Text","extends":"PIXI.Text","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Current game instance.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the new text object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new text object.","optional":false,"default":null},{"name":"text","type":["string"],"help":"The actual text that will be written.","optional":false,"default":null},{"name":"style","type":["object"],"help":"The style object containing style attributes like font, font size ,","optional":false,"default":null}],"help":"Create a new `Text` 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.\\nBecause of this you can only display fonts that are currently loaded and available to the browser. It won't load the fonts for you.\\nHere is a compatibility table showing the available default fonts across different mobile browsers: http:\/\/www.jordanm.co.uk\/tinytype"},"consts":[],"methods":{"public":[{"name":"addChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container.","line":93,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to add to the container","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was added."},"help":"Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child to add","optional":false,"default":null},{"name":"index","type":["number"],"help":"The index to place the child in","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"addColor","static":false,"returns":null,"help":"This method allows you to set specific colors within the Text.\\nIt works by taking a color value, which is a typical HTML string such as `#ff0000` or `rgb(255,0,0)` and a position.\\nThe position value is the index of the character in the Text string to start applying this color to.\\nOnce set the color remains in use until either another color or the end of the string is encountered.\\nFor example if the Text was `Photon Storm` and you did `Text.addColor('#ffff00', 6)` it would color in the word `Storm` in yellow.","line":498,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["string"],"help":"A canvas fillstyle that will be used on the text eg `red`, `#00FF00`, `rgba()`.","optional":false,"default":null},{"name":"position","type":["number"],"help":"The index of the character in the string to start applying this color value from.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clearColors","static":false,"returns":null,"help":"Clears any previously set color stops.","line":480,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"click","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's left button","line":238,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"destroy","static":false,"returns":null,"help":"","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy method called?","optional":true,"default":"true"}],"inherited":false,"inheritedFrom":""},{"name":"fromFrame","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the frameId"},"help":"\\nHelper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\\nThe frame ids are created when a Texture packer file has been loaded","line":429,"public":true,"protected":false,"private":false,"parameters":[{"name":"frameId","type":["string"],"help":"The frame Id of the texture in the cache","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"fromImage","static":true,"returns":{"types":["PIXI.Sprite"],"help":"A new Sprite using a texture from the texture cache matching the image id"},"help":"\\nHelper function that creates a sprite that will contain a texture based on an image url\\nIf the image is not in the texture cache it will be loaded","line":446,"public":true,"protected":false,"private":false,"parameters":[{"name":"imageId","type":["string"],"help":"The image url of the texture","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the displayObject object that can then be used to create sprites\\nThis can be quite useful if your displayObject is static \/ complicated and needs to be reused multiple times.","line":565,"public":true,"protected":false,"private":false,"parameters":[{"name":"resolution","type":["number"],"help":"The resolution of the texture being generated","optional":false,"default":null},{"name":"scaleMode","type":["number"],"help":"Should be one of the PIXI.scaleMode consts","optional":false,"default":null},{"name":"renderer","type":["PIXI.CanvasRenderer","PIXI.WebGLRenderer"],"help":"The renderer used to generate the texture.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the framing rectangle"},"help":"Returns the bounds of the Sprite as a rectangle. The bounds calculation takes the worldTransform into account.","line":171,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["PIXI.Matrix"],"help":"the transformation matrix of the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child at the given index, if any."},"help":"Returns the child at the specified index","line":196,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getChildIndex","static":false,"returns":{"types":["number"],"help":"The index position of the child display object to identify"},"help":"Returns the index position of a child DisplayObject instance","line":161,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject instance to identify","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"getLocalBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"The rectangular bounding area"},"help":"Retrieves the non-global local bounds of the displayObjectContainer as a rectangle. The calculation takes all visible children into consideration.","line":359,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mousedown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's left button down over the sprite","line":244,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseout","static":false,"returns":null,"help":"A callback that is used when the users mouse leaves the displayObject","line":231,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseover","static":false,"returns":null,"help":"A callback that is used when the users mouse rolls over the displayObject","line":225,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's left button that was over the displayObject\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":251,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"mouseupoutside","static":false,"returns":null,"help":"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\\nfor this callback to be fired, the mouse's left button must have been pressed down over the displayObject","line":258,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"postUpdate","static":false,"returns":null,"help":"Automatically called by World.postUpdate.","line":211,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":162,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"removeChild","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the container.","line":213,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The DisplayObject to remove","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildAt","static":false,"returns":{"types":["PIXI.DisplayObject"],"help":"The child that was removed."},"help":"Removes a child from the specified index position.","line":228,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index to get the child from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeChildren","static":false,"returns":null,"help":"Removes all children from this container that are within the begin and end indexes.","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"beginIndex","type":["number"],"help":"The beginning position. Default value is 0.","optional":false,"default":null},{"name":"endIndex","type":["number"],"help":"The ending position. Default value is size of the container.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"removeStageReference","static":false,"returns":null,"help":"Removes the current stage reference from the container and all of its children.","line":400,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightclick","static":false,"returns":null,"help":"A callback that is used when the users clicks on the displayObject with their mouse's right button","line":265,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightdown","static":false,"returns":null,"help":"A callback that is used when the user clicks the mouse's right button down over the sprite","line":271,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightup","static":false,"returns":null,"help":"A callback that is used when the user releases the mouse's right button that was over the displayObject\\nfor this callback to be fired the mouse's right button must have been pressed down over the displayObject","line":278,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"rightupoutside","static":false,"returns":null,"help":"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\\nfor this callback to be fired, the mouse's right button must have been pressed down over the displayObject","line":285,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setChildIndex","static":false,"returns":null,"help":"Changes the position of an existing child in the display object container","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"The child DisplayObject instance for which you want to change the index number","optional":false,"default":null},{"name":"index","type":["number"],"help":"The resulting index number for the child display object","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setShadow","static":false,"returns":null,"help":"","line":303,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.","optional":true,"default":"0"},{"name":"y","type":["number"],"help":"The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.","optional":true,"default":"0"},{"name":"color","type":["string"],"help":"The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.","optional":true,"default":"'rgba(0,0,0,0)'"},{"name":"blur","type":["number"],"help":"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).","optional":true,"default":"0"}],"inherited":false,"inheritedFrom":""},{"name":"setStageReference","static":false,"returns":null,"help":"Sets the containers Stage reference. This is the Stage that this object, and all of its children, is connected to.","line":383,"public":true,"protected":false,"private":false,"parameters":[{"name":"stage","type":["PIXI.Stage"],"help":"the stage that the container will have as its current stage reference","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"setStyle","static":false,"returns":null,"help":"Set the style of the text by passing a single style object to it.","line":326,"public":true,"protected":false,"private":false,"parameters":[{"name":"style","type":["object"],"help":"The style properties to be set on the Text.","optional":true,"default":null},{"name":"style.font","type":["string"],"help":" 20pt Arial'] - The style and size of the font.","optional":true,"default":"'bol"},{"name":"style.fill","type":["string"],"help":"A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.","optional":true,"default":"'black'"},{"name":"style.align","type":["string"],"help":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.","optional":true,"default":"'left'"},{"name":"style.stroke","type":["string"],"help":"A canvas stroke style that will be used on the text stroke eg 'blue', '#FCFF00'.","optional":true,"default":"'black'"},{"name":"style.strokeThickness","type":["number"],"help":"A number that represents the thickness of the stroke. Default is 0 (no stroke).","optional":true,"default":"0"},{"name":"style.wordWrap","type":["boolean"],"help":"Indicates if word wrap should be used.","optional":true,"default":"false"},{"name":"style.wordWrapWidth","type":["number"],"help":"The width in pixels at which text will wrap.","optional":true,"default":"100"}],"inherited":false,"inheritedFrom":""},{"name":"setText","static":false,"returns":null,"help":"Set the copy for the text object. To split a line you can use '\\n'.","line":153,"public":true,"protected":false,"private":false,"parameters":[{"name":"text","type":["string"],"help":"The copy that you would like the text to display","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Text"},{"name":"setTexture","static":false,"returns":null,"help":"Sets the texture of the sprite","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The PIXI texture that is displayed by the sprite","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"swapChildren","static":false,"returns":null,"help":"Swaps the position of 2 Display Objects within this container.","line":136,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null},{"name":"child2","type":["PIXI.DisplayObject"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"tap","static":false,"returns":null,"help":"A callback that is used when the users taps on the sprite with their finger\\nbasically a touch version of click","line":296,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toGlobal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the global position of the display object","line":592,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"toLocal","static":false,"returns":{"types":["Phaser.Point"],"help":"A point object representing the position of this object"},"help":"Calculates the local position of the display object relative to another point","line":606,"public":true,"protected":false,"private":false,"parameters":[{"name":"position","type":["Phaser.Point"],"help":"The world origin to calculate from","optional":false,"default":null},{"name":"[from]","type":["PIXI.DisplayObject"],"help":"The DisplayObject to calculate the global position from","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchend","static":false,"returns":null,"help":"A callback that is used when the user releases a touch over the displayObject","line":308,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchendoutside","static":false,"returns":null,"help":"A callback that is used when the user releases the touch that was over the displayObject\\nfor this callback to be fired, The touch must have started over the sprite","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"touchstart","static":false,"returns":null,"help":"A callback that is used when the user touches over the displayObject","line":302,"public":true,"protected":false,"private":false,"parameters":[{"name":"interactionData","type":["PIXI.InteractionData"],"help":"","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Sprite"},{"name":"update","static":false,"returns":null,"help":"Override and use this function in your own custom objects to handle any update requirements you may have.","line":203,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateCache","static":false,"returns":null,"help":"Generates and updates the cached sprite for this object.","line":580,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Sprite"}],"protected":[],"private":[{"name":"runWordWrap","static":false,"returns":null,"help":"Greedy wrapping algorithm that will wrap words as the line grows longer than its horizontal bounds.","line":512,"public":false,"protected":false,"private":true,"parameters":[{"name":"text","type":["string"],"help":"The text to perform word wrap detection against.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"updateText","static":false,"returns":null,"help":"Renders text. This replaces the Pixi.Text.updateText function as we need a few extra bits in here.","line":352,"public":false,"protected":false,"private":true,"parameters":[],"inherited":false,"inheritedFrom":""}],"static":[]},"properties":{"public":[{"name":"align","type":["string"],"help":"","inlineHelp":"Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text.","line":713,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"anchor","type":["Phaser.Point"],"help":"The anchor sets the origin point of the texture.\\nThe default is 0,0 this means the texture's origin is the top left\\nSetting than anchor to 0.5,0.5 means the textures origin is centered\\nSetting the anchor to 1,1 would mean the textures origin points will be the bottom right corner","inlineHelp":"","line":31,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"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.\\nValues 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.\\nIf you wish to work in radians instead of degrees use the property Sprite.rotation instead.","inlineHelp":"Gets or sets the angle of rotation in degrees.","line":561,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the sprite. Set to PIXI.blendModes.NORMAL to remove any blend mode.","inlineHelp":"","line":75,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"buttonMode","type":["boolean"],"help":"This is used to indicate if the displayObject should display a mouse hand cursor on rollover","inlineHelp":"","line":77,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cacheAsBitmap","type":["boolean"],"help":"Set if this display object is cached as a bitmap.\\nThis 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.\\nTo remove simply set this property to 'null'","inlineHelp":"","line":424,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"cameraOffset","type":["Phaser.Point"],"help":"","inlineHelp":"If this object is fixedToCamera then this stores the x\/y offset that its drawn at, from the top-left of the camera view.","line":119,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"canvas","type":["HTMLCanvasElement"],"help":"The canvas element that everything is drawn to","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"children","type":["array PIXI.DisplayObject"],"help":"[read-only] The array of children of this container.","inlineHelp":"","line":24,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"colors","type":["array"],"help":"","inlineHelp":"An array of the color values as specified by `Text.addColor`.","line":124,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"context","type":["HTMLCanvasElement"],"help":"The canvas 2d context that everything is drawn with","inlineHelp":"","line":42,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"defaultCursor","type":["string"],"help":"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\\n","inlineHelp":"","line":131,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"destroyPhase","type":["boolean"],"help":"","inlineHelp":"True if this object is currently being destroyed.","line":1010,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"events","type":["Phaser.Events"],"help":"","inlineHelp":"The Events you can subscribe to that are dispatched when certain things happen on this Sprite or its components.","line":109,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"exists","type":["boolean"],"help":"","inlineHelp":"If exists = false then the Text isn't updated by the core game loop.","line":46,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fill","type":["object"],"help":"","inlineHelp":"A canvas fillstyle that will be used on the text eg 'red', '#00FF00'.","line":691,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filterArea","type":["Phaser.Rectangle"],"help":"The area the filter is applied to like the hitArea this is used as more of an optimisation\\nrather than figuring out the dimensions of the displayObject each frame you can set this rectangle","inlineHelp":"","line":168,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"filters","type":["array"],"help":"Sets the filters for the displayObject.\\n* IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\\nTo remove filters simply set this property to 'null'","inlineHelp":"","line":388,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fixedToCamera","type":["boolean"],"help":"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.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Text was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Text to the Camera at its current world coordinates.","line":983,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"font","type":["string"],"help":"","inlineHelp":"The font the text will be rendered in, i.e. 'Arial'. Must be loaded in the browser before use.","line":605,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fontSize","type":["number"],"help":"","inlineHelp":"The size of the font in pixels.","line":633,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"fontWeight","type":["number"],"help":"","inlineHelp":"The weight of the font: 'normal', 'bold', 'italic'. You can combine settings too, such as 'bold italic'.","line":663,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"","inlineHelp":"A reference to the currently running Game.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the Text, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":92,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"hitArea","type":["Phaser.Rectangle","Phaser.Circle","Phaser.Ellipse","Phaser.Polygon"],"help":"This is the defined area that will pick up mouse \/ touch events. It is null by default.\\nSetting 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)","inlineHelp":"","line":69,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"input","type":["Phaser.InputHandler","null"],"help":"","inlineHelp":"The Input Handler for this object. Needs to be enabled with image.inputEnabled = true before you can use it.","line":114,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"inputEnabled","type":["boolean"],"help":"By default a Text object won't process any input events at all. By setting inputEnabled to true the Phaser.InputHandler is\\nactivated for this object and it will then start to process click\/touch events and more.","inlineHelp":"Set to true to allow this object to receive input events.","line":941,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"interactive","type":["boolean"],"help":"Indicates if the sprite will have touch and mouse interactivity. It is false by default","inlineHelp":"","line":327,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineSpacing","type":["number"],"help":"","inlineHelp":"Additional spacing (in pixels) between each line of text if multi-line.","line":823,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"mask","type":["PIXI.Graphics"],"help":"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.\\nIn PIXI a regular mask must be a PIXI.Graphics object. This allows for much faster masking in canvas as it utilises shape clipping.\\nTo remove a mask, set this property to null.","inlineHelp":"","line":369,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"The user defined name given to this object.","line":52,"default":"''","public":true,"protected":false,"private":false,"readOnly":false},{"name":"parent","type":["PIXI.DisplayObjectContainer"],"help":"[read-only] The display object container that contains this display object.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"pivot","type":["Phaser.Point"],"help":"The pivot point of the displayObject that it rotates around","inlineHelp":"","line":36,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["Phaser.Point"],"help":"The coordinate of the object relative to the local coordinates of the parent.","inlineHelp":"","line":20,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"renderable","type":["boolean"],"help":"Can this object be rendered","inlineHelp":"","line":85,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"resolution","type":["number"],"help":"The resolution of the canvas.","inlineHelp":"","line":49,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotation","type":["number"],"help":"The rotation of the object in radians.","inlineHelp":"","line":44,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"scale","type":["Phaser.Point"],"help":"The scale factor of the object.","inlineHelp":"","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shader","type":["PIXI.AbstractFilter"],"help":"The shader that will be used to render the texture to the stage. Set to null to remove a current shader.","inlineHelp":"","line":84,"default":"null","public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowBlur","type":["number"],"help":"","inlineHelp":"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).","line":916,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowColor","type":["string"],"help":"","inlineHelp":"The color of the shadow, as given in CSS rgba format. Set the alpha component to 0 to disable the shadow.","line":894,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowOffsetX","type":["number"],"help":"","inlineHelp":"The shadowOffsetX value in pixels. This is how far offset horizontally the shadow effect will be.","line":850,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"shadowOffsetY","type":["number"],"help":"","inlineHelp":"The shadowOffsetY value in pixels. This is how far offset vertically the shadow effect will be.","line":872,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"stage","type":["PIXI.Stage"],"help":"[read-only] The stage the display object is connected to, or undefined if it is not connected to the stage.","inlineHelp":"","line":103,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"stroke","type":["string"],"help":"","inlineHelp":"A canvas fillstyle that will be used on the text stroke eg 'blue', '#FCFF00'.","line":735,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"strokeThickness","type":["number"],"help":"","inlineHelp":"A number that represents the thickness of the stroke. Default is 0 (no stroke)","line":757,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"text","type":["string"],"help":"The text string to be displayed by this Text object, taking into account the style settings.","inlineHelp":"The text string to be displayed by this Text object, taking into account the style settings.","line":578,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"texture","type":["PIXI.Texture"],"help":"The texture that the sprite is using","inlineHelp":"","line":39,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tint","type":["number"],"help":"The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.","inlineHelp":"","line":66,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":58,"default":"Phaser.TEXT","public":true,"protected":false,"private":false,"readOnly":false},{"name":"visible","type":["boolean"],"help":"The visibility of the object.","inlineHelp":"","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"The width of the Text, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"wordWrap","type":["boolean"],"help":"","inlineHelp":"Indicates if word wrap should be used.","line":779,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"wordWrapWidth","type":["number"],"help":"","inlineHelp":"The width at which text will wrap.","line":801,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"world","type":["Phaser.Point"],"help":"","inlineHelp":"The world coordinates of this Sprite. This differs from the x\/y coordinates which are relative to the Sprites container.","line":68,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"worldAlpha","type":["number"],"help":"[read-only] The multiplied alpha of the displayObject","inlineHelp":"","line":112,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"worldVisible","type":["boolean"],"help":"[read-only] Indicates if the sprite is globally visible.","inlineHelp":"","line":346,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"The position of the displayObject on the x axis relative to the local coordinates of the parent.","inlineHelp":"","line":734,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"The position of the displayObject on the y axis relative to the local coordinates of the parent.","inlineHelp":"","line":749,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"z","type":["number"],"help":"","inlineHelp":"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.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[{"name":"_cache","type":["array"],"help":"A small internal cache:\\n0 = previous position.x\\n1 = previous position.y\\n2 = previous rotation\\n3 = renderID\\n4 = fresh? (0 = no, 1 = yes)\\n5 = outOfBoundsFired (0 = no, 1 = yes)\\n6 = exists (0 = no, 1 = yes)\\n7 = fixed to camera (0 = no, 1 = yes)\\n8 = destroy phase? (0 = no, 1 = yes)","inlineHelp":"","line":146,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_charCount","type":["number"],"help":"","inlineHelp":"Internal character counter used by the text coloring.","line":104,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_font","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":80,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fontSize","type":["number"],"help":"","inlineHelp":"Internal cache var.","line":86,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_fontWeight","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":92,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_text","type":["string"],"help":"","inlineHelp":"Internal cache var.","line":74,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"lineSpacing","type":["number"],"help":"","inlineHelp":"Additional spacing (in pixels) between each line of text if multi-line.","line":98,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}