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

{"class":{"name":"Phaser.Frame","extends":"","static":false,"constructor":true,"parameters":[{"name":"index","type":["number"],"help":"The index of this Frame within the FrameData set it is being added to.","optional":false,"default":null},{"name":"x","type":["number"],"help":"X position of the frame within the texture image.","optional":false,"default":null},{"name":"y","type":["number"],"help":"Y position of the frame within the texture image.","optional":false,"default":null},{"name":"width","type":["number"],"help":"Width of the frame within the texture image.","optional":false,"default":null},{"name":"height","type":["number"],"help":"Height of the frame within the texture image.","optional":false,"default":null},{"name":"name","type":["string"],"help":"The name of the frame. In Texture Atlas data this is usually set to the filename.","optional":false,"default":null},{"name":"uuid","type":["string"],"help":"Internal UUID key.","optional":false,"default":null}],"help":"A Frame is a single frame of an animation and is part of a FrameData collection."},"consts":[],"methods":{"public":[{"name":"clone","static":false,"returns":{"types":["Phaser.Frame"],"help":"An exact copy of this Frame object."},"help":"Clones this Frame into a new Phaser.Frame object and returns it.\\nNote that all properties are cloned, including the name, index and UUID.","line":175,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getRect","static":false,"returns":{"types":["Phaser.Rectangle"],"help":"A rectangle."},"help":"Returns a Rectangle set to the dimensions of this Frame.","line":198,"public":true,"protected":false,"private":false,"parameters":[{"name":"out","type":["Phaser.Rectangle"],"help":"A rectangle to copy the frame dimensions to.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setTrim","static":false,"returns":null,"help":"If the frame was trimmed when added to the Texture Atlas this records the trim and source data.","line":150,"public":true,"protected":false,"private":false,"parameters":[{"name":"trimmed","type":["boolean"],"help":"If this frame was trimmed or not.","optional":false,"default":null},{"name":"actualWidth","type":["number"],"help":"The width of the frame before being trimmed.","optional":false,"default":null},{"name":"actualHeight","type":["number"],"help":"The height of the frame before being trimmed.","optional":false,"default":null},{"name":"destX","type":["number"],"help":"The destination X position of the trimmed frame for display.","optional":false,"default":null},{"name":"destY","type":["number"],"help":"The destination Y position of the trimmed frame for display.","optional":false,"default":null},{"name":"destWidth","type":["number"],"help":"The destination width of the trimmed frame for display.","optional":false,"default":null},{"name":"destHeight","type":["number"],"help":"The destination height of the trimmed frame for display.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"bottom","type":["number"],"help":"","inlineHelp":"The bottom of the frame (y + height).","line":132,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerX","type":["number"],"help":"","inlineHelp":"Center X position within the image to cut from.","line":60,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"centerY","type":["number"],"help":"","inlineHelp":"Center Y position within the image to cut from.","line":65,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"distance","type":["number"],"help":"","inlineHelp":"The distance from the top left to the bottom-right of this Frame.","line":70,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"height","type":["number"],"help":"","inlineHelp":"Height of the frame.","line":45,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"index","type":["number"],"help":"","inlineHelp":"The index of this Frame within the FrameData set it is being added to.","line":25,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"name","type":["string"],"help":"","inlineHelp":"Useful for Texture Atlas files (is set to the filename value).","line":50,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"right","type":["number"],"help":"","inlineHelp":"The right of the Frame (x + width).","line":127,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotated","type":["boolean"],"help":"","inlineHelp":"Rotated? (not yet implemented)","line":76,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"rotationDirection","type":["string"],"help":"","inlineHelp":"Either 'cw' or 'ccw', rotation is always 90 degrees.","line":82,"default":"'cw'","public":true,"protected":false,"private":false,"readOnly":false},{"name":"sourceSizeH","type":["number"],"help":"","inlineHelp":"Height of the original sprite.","line":98,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sourceSizeW","type":["number"],"help":"","inlineHelp":"Width of the original sprite.","line":93,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeH","type":["number"],"help":"","inlineHelp":"Height of the trimmed sprite.","line":122,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeW","type":["number"],"help":"","inlineHelp":"Width of the trimmed sprite.","line":116,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeX","type":["number"],"help":"","inlineHelp":"X position of the trimmed sprite inside original sprite.","line":104,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"spriteSourceSizeY","type":["number"],"help":"","inlineHelp":"Y position of the trimmed sprite inside original sprite.","line":110,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"trimmed","type":["boolean"],"help":"","inlineHelp":"Was it trimmed when packed?","line":88,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"uuid","type":["string"],"help":"","inlineHelp":"DEPRECATED: A link to the PIXI.TextureCache entry.","line":55,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"width","type":["number"],"help":"","inlineHelp":"Width of the frame.","line":40,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"x","type":["number"],"help":"","inlineHelp":"X position within the image to cut from.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"y","type":["number"],"help":"","inlineHelp":"Y position within the image to cut from.","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}