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

{"class":{"name":"Phaser.Utils","extends":"","static":true,"constructor":false,"parameters":[],"help":""},"consts":[],"methods":{"public":[{"name":"extend","static":false,"returns":{"types":["object"],"help":"The extended object."},"help":"This is a slightly modified version of http:\/\/api.jquery.com\/jQuery.extend\/","line":292,"public":true,"protected":false,"private":false,"parameters":[{"name":"deep","type":["boolean"],"help":"Perform a deep copy?","optional":false,"default":null},{"name":"target","type":["object"],"help":"The target object to copy to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getProperty","static":false,"returns":{"types":["any"],"help":"the value of the property or null if property isn't found ."},"help":"Gets an objects property by string.","line":23,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to traverse.","optional":false,"default":null},{"name":"prop","type":["string"],"help":"The property whose value will be returned.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"isPlainObject","static":false,"returns":{"types":["boolean"],"help":"- true if the object is plain, otherwise false."},"help":"This is a slightly modified version of jQuery.isPlainObject. A plain object is an object whose internal class property is [object Object].","line":256,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to inspect.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mixin","static":false,"returns":{"types":["object"],"help":"The modified destination object."},"help":"Mixes the source object into the destination object, returning the newly modified destination object.\\nBased on original code by @mudcube","line":373,"public":true,"protected":false,"private":false,"parameters":[{"name":"from","type":["object"],"help":"The object to copy (the source object).","optional":false,"default":null},{"name":"to","type":["object"],"help":"The object to copy to (the destination object).","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"pad","static":false,"returns":{"types":["string"],"help":"The padded string"},"help":"Javascript string pad http:\/\/www.webtoolkit.info\/.\\npad = the string to pad it out with (defaults to a space)\\ndir = 1 (left), 2 (right), 3 (both)","line":218,"public":true,"protected":false,"private":false,"parameters":[{"name":"str","type":["string"],"help":"The target string.","optional":false,"default":null},{"name":"len","type":["number"],"help":"The number of characters to be added.","optional":false,"default":null},{"name":"pad","type":["number"],"help":"The string to pad it out with (defaults to a space).","optional":false,"default":null},{"name":"dir","type":["number"],"help":" The direction dir = 1 (left), 2 (right), 3 (both).","optional":true,"default":"3"}],"inherited":false,"inheritedFrom":""},{"name":"parseDimension","static":false,"returns":{"types":["number"],"help":"The parsed dimension."},"help":"Get a unit dimension from a string.","line":152,"public":true,"protected":false,"private":false,"parameters":[{"name":"size","type":["string","number"],"help":"The size to parse.","optional":false,"default":null},{"name":"dimension","type":["number"],"help":"The window dimension to check.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"rotateArray","static":false,"returns":{"types":["array"],"help":"The rotated array"},"help":"Rotates the given array.\\nBased on the routine from http:\/\/jsfiddle.net\/MrPolywhirl\/NH42z\/","line":113,"public":true,"protected":false,"private":false,"parameters":[{"name":"matrix","type":["array"],"help":"The array to rotate.","optional":false,"default":null},{"name":"direction","type":["number","string"],"help":"The amount to rotate. Either a number: 90, -90, 270, -270, 180 or a string: 'rotateLeft', 'rotateRight' or 'rotate180'","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"setProperty","static":false,"returns":{"types":["object"],"help":"The object on which the property was set."},"help":"Sets an objects property by string.","line":56,"public":true,"protected":false,"private":false,"parameters":[{"name":"obj","type":["object"],"help":"The object to traverse","optional":false,"default":null},{"name":"prop","type":["string"],"help":"The property whose value will be changed","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"shuffle","static":false,"returns":{"types":["array"],"help":"The shuffled array."},"help":"A standard Fisher-Yates Array shuffle implementation.","line":193,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to shuffle.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"transposeArray","static":false,"returns":{"types":["array"],"help":"The transposed array."},"help":"Transposes the elements of the given Array.","line":86,"public":true,"protected":false,"private":false,"parameters":[{"name":"array","type":["array"],"help":"The array to transpose.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[],"protected":[],"private":[]}}