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

1 line
39 KiB
JSON
Raw Normal View History

{"class":{"name":"Phaser.TileSprite","extends":"PIXI.TilingSprite","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running game.","optional":false,"default":null},{"name":"x","type":["number"],"help":"The x coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"y","type":["number"],"help":"The y coordinate (in world space) to position the TileSprite at.","optional":false,"default":null},{"name":"width","type":["number"],"help":"The width of the TileSprite.","optional":false,"default":null},{"name":"height","type":["number"],"help":"The height of the TileSprite.","optional":false,"default":null},{"name":"key","type":["string","Phaser.RenderTexture","Phaser.BitmapData","PIXI.Texture"],"help":"This is the image or texture used by the TileSprite during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture or PIXI.Texture.","optional":false,"default":null},{"name":"frame","type":["string","number"],"help":"If this TileSprite is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.","optional":false,"default":null}],"help":"A TileSprite is a Sprite that has a repeating texture. The texture can be scrolled and scaled and will automatically wrap on the edges as it does so.\\nPlease note that TileSprites, as with normal Sprites, have no input handler or physics bodies by default. Both need enabling."},"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":"autoScroll","static":false,"returns":null,"help":"Sets this TileSprite to automatically scroll in the given direction until stopped via TileSprite.stopScroll().\\nThe scroll speed is specified in pixels per second.\\nA negative x value will scroll to the left. A positive x value will scroll to the right.\\nA negative y value will scroll up. A positive y value will scroll down.","line":315,"public":true,"protected":false,"private":false,"parameters":[{"name":"x","type":["number"],"help":"Horizontal scroll speed in pixels per second.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Vertical scroll speed in pixels per second.","optional":false,"default":null}],"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":"Destroys the TileSprite. This removes it from its parent group, destroys the event and animation handlers if present\\nand nulls its reference to game, freeing it up for garbage collection.","line":441,"public":true,"protected":false,"private":false,"parameters":[{"name":"destroyChildren","type":["boolean"],"help":"Should every child of this object have its destroy meth