mirror of
https://github.com/photonstorm/phaser
synced 2024-12-19 09:34:02 +00:00
1 line
5.5 KiB
JSON
1 line
5.5 KiB
JSON
|
{"class":{"name":"Phaser.FrameData","extends":"","static":false,"constructor":true,"parameters":[],"help":"FrameData is a container for Frame objects, which are the internal representation of animation data in Phaser."},"consts":[],"methods":{"public":[{"name":"addFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame that was just added."},"help":"Adds a new Frame to this FrameData collection. Typically called by the Animation.Parser and not directly.","line":39,"public":true,"protected":false,"private":false,"parameters":[{"name":"frame","type":["Phaser.Frame"],"help":"The frame to add to this FrameData set.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"checkFrameName","static":false,"returns":{"types":["boolean"],"help":"True if the frame is found, otherwise false."},"help":"Check if there is a Frame with the given name.","line":97,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the frame you want to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"clone","static":false,"returns":{"types":["Phaser.FrameData"],"help":"A clone of this object, including clones of the Frame objects it contains."},"help":"Makes a copy of this FrameData including copies (not references) to all of the Frames it contains.","line":114,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"getFrame","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame, if found."},"help":"Get a Frame by its numerical index.","line":61,"public":true,"protected":false,"private":false,"parameters":[{"name":"index","type":["number"],"help":"The index of the frame you want to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameByName","static":false,"returns":{"types":["Phaser.Frame"],"help":"The frame, if found."},"help":"Get a Frame by its frame name.","line":79,"public":true,"protected":false,"private":false,"parameters":[{"name":"name","type":["string"],"help":"The name of the frame you want to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameIndexes","static":false,"returns":{"types":["array"],"help":"An array of all Frame indexes matching the given names or IDs."},"help":"Returns all of the Frame indexes in this FrameData set.\\nThe frames indexes are returned in the output array, or if none is provided in a new Array object.","line":212,"public":true,"protected":false,"private":false,"parameters":[{"name":"frames","type":["array"],"help":"An Array containing the indexes of the frames to retrieve. If the array is empty then all frames in the FrameData are returned.","optional":false,"default":null},{"name":"useNumericIndex","type":["boolean"],"help":"Are the given frames using numeric indexes (default) or strings? (false)","optional":true,"default":"true"},{"name":"output","type":["array"],"help":"If given the results will be appended to the end of this array otherwise a new array will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrameRange","static":false,"returns":{"types":["array"],"help":"An array of Frames between the start and end index values, or an empty array if none were found."},"help":"Returns a range of frames based on the given start and end frame indexes and returns them in an Array.","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"start","type":["number"],"help":"The starting frame index.","optional":false,"default":null},{"name":"end","type":["number"],"help":"The ending frame index.","optional":false,"default":null},{"name":"output","type":["array"],"help":"If given the results will be appended to the end of this array otherwise a new array will be created.","optional":true,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getFrames","static":false,"returns":{"types":["array"],"help":"An array of all Frames in this FrameData
|