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

{"class":{"name":"Phaser.ArrayList","extends":"","static":false,"constructor":true,"parameters":[],"help":"A set data structure. Allows items to add themselves to and remove themselves from the set. Items can only exist once in the set."},"consts":[],"methods":{"public":[{"name":"add","static":false,"returns":{"types":["object"],"help":"The child that was added."},"help":"Adds a new element to this list. The item can only exist in the list once.","line":43,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to add to this list. Can be a Phaser.Sprite or any other object you need to quickly iterate through.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"callAll","static":false,"returns":null,"help":"Calls a function on all members of this list, using the member as the context for the callback.\\nThe function must exist on the member.","line":142,"public":true,"protected":false,"private":false,"parameters":[{"name":"callback","type":["function"],"help":"The function to call.","optional":false,"default":null},{"name":"parameter","type":["any"],"help":"Additional parameters that will be passed to the callback.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"exists","static":false,"returns":{"types":["boolean"],"help":"True if the child is found in the list, otherwise false."},"help":"Checks for the child within this list.","line":75,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to get the list index for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"getIndex","static":false,"returns":{"types":["number"],"help":"The index of the child or -1 if not found."},"help":"Gets the index of the child in the list, or -1 if it isn't in the list.","line":62,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The element to get the list index for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"remove","static":false,"returns":{"types":["object"],"help":"child - The child that was removed."},"help":"Removes the given element from this list if it exists.","line":100,"public":true,"protected":false,"private":false,"parameters":[{"name":"child","type":["object"],"help":"The child to be removed from the list.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"reset","static":false,"returns":null,"help":"Resets the list length and drops all items in the list.","line":86,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"setAll","static":false,"returns":null,"help":"Sets the property `key` to the given value on all members of this list.","line":120,"public":true,"protected":false,"private":false,"parameters":[{"name":"key","type":["object"],"help":"The object on the child to set.","optional":false,"default":null},{"name":"value","type":["any"],"help":"The value to set the property to.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"first","type":["object"],"help":"Resets the cursor to the first item in the list and returns it.","inlineHelp":"The first item in the list.","line":166,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"list","type":["array"],"help":"","inlineHelp":"The list.","line":30,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"next","type":["object"],"help":"Gets the next item in the list and returns it, advancing the cursor.","inlineHelp":"Advanced the cursor and return.","line":191,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"position","type":["number"],"help":"","inlineHelp":"Current cursor position.","line":25,"default":"0","public":true,"protected":false,"private":false,"readOnly":false},{"name":"total","type":["number"],"help":"","inlineHelp":"Number of objects in the list.","line":19,"default":"0","public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}