phaser/resources/docgen/output/PIXI.EventTarget.json
2014-11-25 00:24:29 +00:00

1 line
No EOL
4.8 KiB
JSON

{"class":{"name":"PIXI.EventTarget","extends":"","static":true,"constructor":false,"parameters":[],"help":"Mixins event emitter functionality to a class\\n\\nfunction MyEmitter() {}\\n\\nPIXI.EventTarget.mixin(MyEmitter.prototype);\\n\\nvar em = new MyEmitter();\\nem.emit('eventName', 'some data', 'some more data', {}, null, ...);"},"consts":[],"methods":{"public":[{"name":"emit","static":false,"returns":null,"help":"Emit an event to all registered event listeners.","line":62,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The name of the event.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"listeners","static":false,"returns":null,"help":"Return a list of assigned event listeners.","line":48,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The events that should be listed.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"mixin","static":false,"returns":null,"help":"Mixes in the properties of the EventTarget prototype onto another object","line":40,"public":true,"protected":false,"private":false,"parameters":[{"name":"object","type":["object"],"help":"The obj to mix into","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"off","static":false,"returns":null,"help":"Remove event listeners.","line":151,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The event we want to remove.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"The listener that we need to find.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"on","static":false,"returns":null,"help":"Register a new EventListener for the given event.","line":115,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"Name of the event.","optional":false,"default":null},{"name":"callback","type":["PIXI.Functon"],"help":"fn Callback function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"once","static":false,"returns":null,"help":"Add an EventListener that's only called once.","line":131,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"Name of the event.","optional":false,"default":null},{"name":"callback","type":["function"],"help":"Callback function.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"removeAllListeners","static":false,"returns":null,"help":"Remove all listeners or only the listeners for the specified event.","line":179,"public":true,"protected":false,"private":false,"parameters":[{"name":"eventName","type":["string"],"help":"The event you want to remove all listeners for.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"stopImmediatePropagation","static":false,"returns":null,"help":"Stops the propagation of events to sibling listeners (no longer calls any listeners).","line":282,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""},{"name":"stopPropagation","static":false,"returns":null,"help":"Stops the propagation of events up the scene graph (prevents bubbling).","line":273,"public":true,"protected":false,"private":false,"parameters":[],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"data","type":["object"],"help":"The data that was passed in with this event.","inlineHelp":"","line":253,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"target","type":["object"],"help":"The original target the event triggered on.","inlineHelp":"","line":235,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"timeStamp","type":["number"],"help":"The timestamp when the event occurred.","inlineHelp":"","line":265,"default":null,"public":true,"protected":false,"private":false,"readOnly":true},{"name":"type","type":["string"],"help":"The string name of the event that this represents.","inlineHelp":"","line":244,"default":null,"public":true,"protected":false,"private":false,"readOnly":true}],"protected":[],"private":[{"name":"stopped","type":["boolean"],"help":"Tracks the state of bubbling propagation. Do not\\nset this directly, instead use `event.stopPropagation()`","inlineHelp":"","line":215,"default":null,"public":false,"protected":false,"private":true,"readOnly":true},{"name":"stoppedImmediate","type":["boolean"],"help":"Tracks the state of sibling listener propagation. Do not\\nset this directly, instead use `event.stopImmediatePropagation()`","inlineHelp":"","line":226,"default":null,"public":false,"protected":false,"private":true,"readOnly":true}]}}