Class default

Component that allows an entity to emit and listen for local events.

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

Methods

emit off on onAttach?

Constructors

constructor

new default(): default
Returns default
Inherited from default.constructor

Properties

`Optional`gameObject

gameObject?: default

Reference to the GameObject this component is attached to.

Methods

emit

emit(type: string, detail?: unknown): void
Emits a local event on this entity.
Parameters
- type: string
  The event type.
- Optionaldetail: unknown
  Optional data to pass with the event.
Returns void
- Defined in packages/dino-ge/src/components/EventBusComponent.ts:32

off

off(type: string, callback: (event: CustomEvent) => void): void
Stops listening for a local event.
Parameters
- type: string
  The event type.
- callback: (event: CustomEvent) => void
  The function to remove.
Returns void
- Defined in packages/dino-ge/src/components/EventBusComponent.ts:23

on

on(type: string, callback: (event: CustomEvent) => void): void
Listens for a local event on this entity.
Parameters
- type: string
  The event type.
- callback: (event: CustomEvent) => void
  The function to run when the event occurs.
Returns void
- Defined in packages/dino-ge/src/components/EventBusComponent.ts:14

`Optional`onAttach

onAttach?(): void
Optional lifecycle hook called when the component is added to a GameObject.

Returns void
Inherited from default.onAttach
- Defined in packages/dino-ge/src/core/Component.ts:12