phaser/resources/docgen/output/PIXI.Sprite.json

{"class":{"name":"PIXI.Sprite","extends":"PIXI.DisplayObjectContainer","static":false,"constructor":true,"parameters":[{"name":"texture","type":["PIXI.Texture"],"help":"The texture for this sprite","optional":false,"default":null}],"help":"The Sprite object is the base for all textured objects that are rendered to the screen\\n\\n\\nA sprite can be created directly from an image like this :\\nvar sprite = new PIXI.Sprite.fromImage('assets\/image.png');\\nyourStage.addChild(sprite);\\nthen obviously don't forget to add it to the stage you have already created"},"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":"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":"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":"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":"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":"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":"_renderCanvas","static":false,"returns":null,"help":"Renders the object using the Canvas renderer","line":313,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"_renderWebGL","static":false,"returns":null,"help":"Renders the object using the WebGL renderer","line":250,"public":false,"protected":false,"private":true,"parameters":[{"name":"renderSession","type":["PIXI.RenderSession"],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"onTextureUpdate","static":false,"returns":null,"help":"When the texture is updated, this event will fire to update the scale and frame","line":155,"public":false,"protected":false,"private":true,"parameters":[{"name":null,"type":[],"help":"","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"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":"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":"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":"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":"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":"height","type":["number"],"help":"The height of the sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":126,"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":"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":"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":"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":"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":"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":"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 sprite, setting this will actually modify the scale to achieve the value set","inlineHelp":"","line":110,"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}],"protected":[],"private":[{"name":"_height","type":["number"],"help":"The height of the sprite (this is initially set by the texture)","inlineHelp":"","line":57,"default":null,"public":false,"protected":false,"private":true,"readOnly":false},{"name":"_width","type":["number"],"help":"The width of the sprite (this is initially set by the texture)","inlineHelp":"","line":48,"default":null,"public":false,"protected":false,"private":true,"readOnly":false}]}}