Home

class: InteractionEvent

Event class that mimics native DOM events.

Methods summary

Public methods
public	stopPropagation(): void
private	_reset(): void
public	stopPropagation(): void
private	_reset(): void

Properties

Name	Type	Attribute	Description
stopped	boolean	public	Whether this event will continue propagating in the tree
target	PIXI.DisplayObject	public	The object which caused this event to be dispatched. For listener callback see {@link PIXI.interaction.InteractionEvent.currentTarget}.
currentTarget	PIXI.DisplayObject	public	The object whose event listener’s callback is currently being invoked.
stopped	boolean	public	Whether this event will continue propagating in the tree
target	PIXI.DisplayObject	public	The object which caused this event to be dispatched. For listener callback see {@link PIXI.interaction.InteractionEvent.currentTarget}.
currentTarget	PIXI.DisplayObject	public	The object whose event listener’s callback is currently being invoked.

Methods

stopPropagation(): void

interaction\InteractionEvent.js, line 57

Prevents event from reaching any objects other than the current object.

Returns:

void

_reset(): void

interaction\InteractionEvent.js, line 67

Resets the event.

Returns:

void

stopPropagation(): void

interaction\InteractionEvent.js, line 57

Prevents event from reaching any objects other than the current object.

Returns:

void

_reset(): void

interaction\InteractionEvent.js, line 67

Resets the event.

Returns:

void

{ "comment": "/**\n * Event class that mimics native DOM events.\n *\n * @class\n * @memberof PIXI.interaction\n */", "meta": { "range": [ 131, 1667 ], "filename": "InteractionEvent.js", "lineno": 9, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100060888", "name": "InteractionEvent", "type": "ClassDeclaration", "paramnames": [] } }, "classdesc": "

Event class that mimics native DOM events.

", "kind": "class", "memberof": "PIXI.interaction", "name": "InteractionEvent", "longname": "PIXI.interaction.InteractionEvent", "scope": "static", "params": [], "___id": "T000002R005680", "___s": true, "$methods": [ { "comment": "/**\n * Prevents event from reaching any objects other than the current object.\n *\n */", "meta": { "range": [ 1424, 1482 ], "filename": "InteractionEvent.js", "lineno": 57, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100060925", "name": "InteractionEvent#stopPropagation", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Prevents event from reaching any objects other than the current object.

", "name": "stopPropagation", "longname": "PIXI.interaction.InteractionEvent#stopPropagation", "kind": "function", "memberof": "PIXI.interaction.InteractionEvent", "scope": "instance", "params": [], "___id": "T000002R005690", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventstopPropagation", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * Resets the event.\n *\n * @private\n */", "meta": { "range": [ 1552, 1665 ], "filename": "InteractionEvent.js", "lineno": 67, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100060935", "name": "InteractionEvent#_reset", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Resets the event.

", "access": "private", "name": "_reset", "longname": "PIXI.interaction.InteractionEvent#_reset", "kind": "function", "memberof": "PIXI.interaction.InteractionEvent", "scope": "instance", "params": [], "___id": "T000002R005692", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEvent_reset", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * Prevents event from reaching any objects other than the current object.\n *\n */", "meta": { "range": [ 1424, 1482 ], "filename": "InteractionEvent.js", "lineno": 57, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100135604", "name": "InteractionEvent#stopPropagation", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Prevents event from reaching any objects other than the current object.

", "name": "stopPropagation", "longname": "PIXI.interaction.InteractionEvent#stopPropagation", "kind": "function", "memberof": "PIXI.interaction.InteractionEvent", "scope": "instance", "params": [], "___id": "T000002R012624", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventstopPropagation", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * Resets the event.\n *\n * @private\n */", "meta": { "range": [ 1552, 1665 ], "filename": "InteractionEvent.js", "lineno": 67, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": { "id": "astnode100135614", "name": "InteractionEvent#_reset", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Resets the event.

", "access": "private", "name": "_reset", "longname": "PIXI.interaction.InteractionEvent#_reset", "kind": "function", "memberof": "PIXI.interaction.InteractionEvent", "scope": "instance", "params": [], "___id": "T000002R012626", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEvent_reset", "filepath": "interaction\\InteractionEvent.js" } ], "$attributes": [ { "comment": "/**\n * Whether this event will continue propagating in the tree\n *\n * @member {boolean} PIXI.interaction.InteractionEvent#stopped\n */", "meta": { "range": [ 211, 376 ], "filename": "InteractionEvent.js", "lineno": 16, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "

Whether this event will continue propagating in the tree

", "kind": "member", "name": "stopped", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.interaction.InteractionEvent", "longname": "PIXI.interaction.InteractionEvent#stopped", "scope": "instance", "___id": "T000002R005682", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventstopped", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * The object which caused this event to be dispatched.\n * For listener callback see {@link PIXI.interaction.InteractionEvent.currentTarget}.\n *\n * @member {PIXI.DisplayObject} PIXI.interaction.InteractionEvent#target\n */", "meta": { "range": [ 416, 681 ], "filename": "InteractionEvent.js", "lineno": 23, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "

The object which caused this event to be dispatched.
For listener callback see {@link PIXI.interaction.InteractionEvent.currentTarget}.

", "kind": "member", "name": "target", "type": { "names": [ "PIXI.DisplayObject" ] }, "memberof": "PIXI.interaction.InteractionEvent", "longname": "PIXI.interaction.InteractionEvent#target", "scope": "instance", "___id": "T000002R005684", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventtarget", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * The object whose event listener’s callback is currently being invoked.\n *\n * @member {PIXI.DisplayObject} PIXI.interaction.InteractionEvent#currentTarget\n */", "meta": { "range": [ 719, 915 ], "filename": "InteractionEvent.js", "lineno": 31, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "

The object whose event listener’s callback is currently being invoked.

", "kind": "member", "name": "currentTarget", "type": { "names": [ "PIXI.DisplayObject" ] }, "memberof": "PIXI.interaction.InteractionEvent", "longname": "PIXI.interaction.InteractionEvent#currentTarget", "scope": "instance", "___id": "T000002R005686", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventcurrentTarget", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * Whether this event will continue propagating in the tree\n *\n * @member {boolean} PIXI.interaction.InteractionEvent#stopped\n */", "meta": { "range": [ 211, 376 ], "filename": "InteractionEvent.js", "lineno": 16, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "

Whether this event will continue propagating in the tree

", "kind": "member", "name": "stopped", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.interaction.InteractionEvent", "longname": "PIXI.interaction.InteractionEvent#stopped", "scope": "instance", "___id": "T000002R012616", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventstopped", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * The object which caused this event to be dispatched.\n * For listener callback see {@link PIXI.interaction.InteractionEvent.currentTarget}.\n *\n * @member {PIXI.DisplayObject} PIXI.interaction.InteractionEvent#target\n */", "meta": { "range": [ 416, 681 ], "filename": "InteractionEvent.js", "lineno": 23, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "

The object which caused this event to be dispatched.
For listener callback see {@link PIXI.interaction.InteractionEvent.currentTarget}.

", "kind": "member", "name": "target", "type": { "names": [ "PIXI.DisplayObject" ] }, "memberof": "PIXI.interaction.InteractionEvent", "longname": "PIXI.interaction.InteractionEvent#target", "scope": "instance", "___id": "T000002R012618", "___s": true, "skip": true, "slug": "PIXI.interaction.InteractionEventtarget", "filepath": "interaction\\InteractionEvent.js" }, { "comment": "/**\n * The object whose event listener’s callback is currently being invoked.\n *\n * @member {PIXI.DisplayObject} PIXI.interaction.InteractionEvent#currentTarget\n */", "meta": { "range": [ 719, 915 ], "filename": "InteractionEvent.js", "lineno": 31, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\interaction", "code": {} }, "description": "

The object whose event listener’s callback is currently being invoked.