Skip to main content

Scene.EventPath

A path to a component's event property

Extends: Scene.PathBase

Properties

Properties

id

id: (readonly) string

The id of this path. Set to a random string, or the id provided when creating the path

object

object: (readonly) Scene.IObject

The object this path is associated with

Methods

bind

bind(emitPath: Scene.EmitPath): void

Bind this path to an EmitPath.

ParameterType
emitPathScene.EmitPath

disable

disable(): void

Disable this.emit and the associated Component's onEvent from being triggered

emit

emit(payload: T): void

Emit the event associated with this path. This is similar to calling IComponent.onEvent directly.

ParameterType
payloadT

enable

enable(): void

Enable this.emit and the associated Component's onEvent so it can receive the event again