Skip to main content

Scene.EmitPath

A path to a component's emit property

Extends: Scene.PathBase

Properties
Methods

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(eventPath: Scene.EventPath): void

Bind this path to an EventPath.

ParameterType
eventPathScene.EventPath

disable​

disable(): void

Disable this.emit and the associated Component's notify

emit​

emit(payload: T): void

Emit the event associated with this path. This is similar to IComponent.notify

ParameterType
payloadT

enable​

enable(): void

Enable this.emit and the associated Component's ability to notify