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

{"class":{"name":"Phaser.Graphics","extends":"PIXI.Graphics","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 graphics object.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the new graphics object.","optional":false,"default":null}],"help":"Creates a new `Graphics` object."},"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":"arc","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"The arc method creates an arc\/curve (used to create circles, or parts of circles).","line":419,"public":true,"protected":false,"private":false,"parameters":[{"name":"cx","type":["number"],"help":"The x-coordinate of the center of the circle","optional":false,"default":null},{"name":"cy","type":["number"],"help":"The y-coordinate of the center of the circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null},{"name":"startAngle","type":["number"],"help":"The starting angle, in radians (0 is at the 3 o'clock position of the arc's circle)","optional":false,"default":null},{"name":"endAngle","type":["number"],"help":"The ending angle, in radians","optional":false,"default":null},{"name":"anticlockwise","type":["boolean"],"help":"Optional. Specifies whether the drawing should be counterclockwise or clockwise. False is default, and indicates clockwise, while true indicates counter-clockwise.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"beginFill","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Specifies a simple one-color fill that subsequent calls to other Graphics methods\\n(such as lineTo() or drawCircle()) use when drawing.","line":486,"public":true,"protected":false,"private":false,"parameters":[{"name":"color","type":["number"],"help":"the color of the fill","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"the alpha of the fill","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"bezierCurveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Calculate the points for a bezier curve and then draws it.","line":297,"public":true,"protected":false,"private":false,"parameters":[{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"cpX2","type":["number"],"help":"Second Control point x","optional":false,"default":null},{"name":"cpY2","type":["number"],"help":"Second Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"clear","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.","line":604,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"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":"Destroy this Graphics instance.","line":149,"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":"destroyCachedSprite","static":false,"returns":null,"help":"Destroys a previous cached sprite.","line":1039,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawCircle","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a circle.","line":560,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the circle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the circle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"The radius of the circle","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawEllipse","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws an ellipse.","line":577,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coordinate of the center of the ellipse","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coordinate of the center of the ellipse","optional":false,"default":null},{"name":"width","type":["number"],"help":"The half width of the ellipse","optional":false,"default":null},{"name":"height","type":["number"],"help":"The half height of the ellipse","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawPolygon","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a polygon using the given path.","line":591,"public":true,"protected":false,"private":false,"parameters":[{"name":"path","type":["array"],"help":"The path data used to construct the polygon.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawRect","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"","line":528,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coord of the top-left of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coord of the top-left of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawRoundedRect","static":false,"returns":null,"help":"","line":544,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"The X coord of the top-left of the rectangle","optional":false,"default":null},{"name":"y","type":["number"],"help":"The Y coord of the top-left of the rectangle","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the rectangle","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the rectangle","optional":false,"default":null},{"name":"radius","type":["number"],"help":"Radius of the rectangle corners","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"drawShape","static":false,"returns":{"types":["PIXI.GraphicsData"],"help":"The generated GraphicsData object."},"help":"Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.","line":1055,"public":true,"protected":false,"private":false,"parameters":[{"name":"shape","type":["Phaser.Circle","Phaser.Rectangle","Phaser.Ellipse","Phaser.Line","Phaser.Polygon"],"help":" The Shape object to draw.","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"endFill","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.","line":510,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"generateTexture","static":false,"returns":{"types":["PIXI.Texture"],"help":"a texture of the graphics object"},"help":"Useful function that returns a texture of the graphics object that can then be used to create sprites\\nThis can be quite useful if your geometry is complicated and needs to be reused multiple times.","line":625,"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}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"getBounds","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"the rectangular bounding area"},"help":"Retrieves the bounds of the graphic shape as a rectangle object","line":800,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"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":"lineStyle","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Specifies the line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method.","line":178,"public":true,"protected":false,"private":false,"parameters":[{"name":"lineWidth","type":["number"],"help":"width of the line to draw, will update the objects stored style","optional":false,"default":null},{"name":"color","type":["number"],"help":"color of the line to draw, will update the objects stored style","optional":false,"default":null},{"name":"alpha","type":["number"],"help":"alpha of the line to draw, will update the objects stored style","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"lineTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Draws a line using the current line style from the current drawing position to (x, y);\\nThe current drawing position is then set to (x, y).","line":227,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"the X coordinate to draw to","optional":false,"default":null},{"name":"y","type":["number"],"help":"the Y coordinate to draw to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"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":"moveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Moves the current drawing position to x, y.","line":211,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"the X coordinate to move to","optional":false,"default":null},{"name":"y","type":["number"],"help":"the Y coordinate to move to","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"name":"postUpdate","static":false,"returns":null,"help":"Automatically called by World.postUpdate.","line":132,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"preUpdate","static":false,"returns":null,"help":"Automatically called by World.preUpdate.","line":89,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"quadraticCurveTo","static":false,"returns":{"types":["PIXI.Graphics"],"help":""},"help":"Calculate the points for a quadratic bezier curve and then draws it.\\nBased on: https:\/\/stackoverflow.com\/questions\/785097\/how-do-i-implement-a-bezier-curve-in-c","line":246,"public":true,"protected":false,"private":false,"parameters":[{"name":"cpX","type":["number"],"help":"Control point x","optional":false,"default":null},{"name":"cpY","type":["number"],"help":"Control point y","optional":false,"default":null},{"name":"toX","type":["number"],"help":"Destination point x","optional":false,"default":null},{"name":"toY","type":["number"],"help":"Destination point y","optional":false,"default":null}],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"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":"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":"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":124,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"updateBounds","static":false,"returns":null,"help":"Update the bounds of the object","line":875,"public":true,"protected":false,"private":false,"parameters":[],"inherited":true,"inheritedFrom":"PIXI.Graphics"},{"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":[],"static":[]},"properties":{"public":[{"name":"alpha","type":["number"],"help":"The opacity of the object.","inlineHelp":"","line":52,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"angle","type":["number"],"help":"Indicates the rotation of the Graphics, 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":331,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"blendMode","type":["number"],"help":"The blend mode to be applied to the graphic shape. Apply a value of PIXI.blendModes.NORMAL to reset the blend mode.","inlineHelp":"","line":68,"default":"PIXI.blendModes.NORMAL;","public":true,"protected":false,"private":false,"readOnly":false},{"name":"boundsPadding","type":["number"],"help":"The bounds' padding used for bounds calculation.","inlineHelp":"","line":102,"default":null,"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":58,"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":"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":378,"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":31,"default":"true","public":true,"protected":false,"private":false,"readOnly":false},{"name":"fillAlpha","type":["number"],"help":"The alpha value used when filling the Graphics object.","inlineHelp":"","line":24,"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 Graphics that is fixed to the camera uses its x\/y coordinates as offsets from the top left of the camera. These are stored in Graphics.cameraOffset.\\nNote that the cameraOffset values are in addition to any parent in the display list.\\nSo if this Graphics was in a Group that has x: 200, then this will be added to the cameraOffset.x","inlineHelp":"Set to true to fix this Graphics to the Camera at its current world coordinates.","line":351,"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":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"The height of the displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":65,"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":"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":"isMask","type":["boolean"],"help":"Whether this shape is being used as a mask.","inlineHelp":"","line":94,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineColor","type":["string"],"help":"The color of any lines drawn.","inlineHelp":"","line":41,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"lineWidth","type":["number"],"help":"The width (thickness) of any lines drawn.","inlineHelp":"","line":32,"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":37,"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":"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":"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":"tint","type":["number"],"help":"The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to reset the tint.","inlineHelp":"","line":59,"default":"0xFFFFFF","public":true,"protected":false,"private":false,"readOnly":false},{"name":"type","type":["number"],"help":"","inlineHelp":"The const type of this object.","line":43,"default":"Phaser.GRAPHICS","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 displayObjectContainer, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":37,"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":53,"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":48,"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":78,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}