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

{"class":{"name":"Phaser.TimerEvent","extends":"","static":false,"constructor":true,"parameters":[{"name":"timer","type":["Phaser.Timer"],"help":"The Timer object that this TimerEvent belongs to.","optional":false,"default":null},{"name":"delay","type":["number"],"help":"The delay in ms at which this TimerEvent fires.","optional":false,"default":null},{"name":"tick","type":["number"],"help":"The tick is the next game clock time that this event will fire at.","optional":false,"default":null},{"name":"repeatCount","type":["number"],"help":"If this TimerEvent repeats it will do so this many times.","optional":false,"default":null},{"name":"loop","type":["boolean"],"help":"True if this TimerEvent loops, otherwise false.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The callback that will be called when the TimerEvent occurs.","optional":false,"default":null},{"name":"callbackContext","type":["object"],"help":"The context in which the callback will be called.","optional":false,"default":null},{"name":"arguments","type":["array"],"help":"The values to be passed to the callback.","optional":false,"default":null}],"help":"A TimerEvent is a single event that is processed by a Phaser.Timer.\\nIt consists of a delay, which is a value in milliseconds after which the event will fire.\\nIt can call a specific callback, passing in optional parameters."},"consts":[],"methods":{"public":[],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"arguments","type":["array"],"help":"","inlineHelp":"The values to be passed to the callback.","line":63,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"callback","type":["function"],"help":"","inlineHelp":"The callback that will be called when the TimerEvent occurs.","line":53,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"callbackContext","type":["object"],"help":"","inlineHelp":"The context in which the callback will be called.","line":58,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"delay","type":["number"],"help":"","inlineHelp":"The delay in ms at which this TimerEvent fires.","line":33,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"loop","type":["boolean"],"help":"","inlineHelp":"True if this TimerEvent loops, otherwise false.","line":48,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"repeatCount","type":["number"],"help":"","inlineHelp":"If this TimerEvent repeats it will do so this many times.","line":43,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"tick","type":["number"],"help":"","inlineHelp":"The tick is the next game clock time that this event will fire at.","line":38,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"timer","type":["Phaser.Timer"],"help":"","inlineHelp":"The Timer object that this TimerEvent belongs to.","line":28,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[{"name":"pendingDelete","type":["boolean"],"help":"","inlineHelp":"A flag that controls if the TimerEvent is pending deletion.","line":69,"default":null,"public":false,"protected":true,"private":false,"readOnly":false}],"private":[]}}