Class ComponentDespawnEvent<RoomType>

Emitted when a component is despawned.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

BasicEvent
- ComponentDespawnEvent

Implements

NetworkedObjectEvent<RoomType>

Index

Constructors

Properties

component eventName room eventName

Constructors

constructor

new ComponentDespawnEvent<RoomType extends StatefulRoom<any>>(
room: RoomType,
component: NetworkedObject<RoomType>,
): ComponentDespawnEvent<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- component: NetworkedObject<RoomType>
Returns ComponentDespawnEvent<RoomType>
Overrides BasicEvent.constructor
- Defined in packages/core/lib/events/networkedobject/Despawn.ts:14

Properties

`Readonly`component

component: NetworkedObject<RoomType>

The component that this event is for.

eventName

eventName: "component.despawn" = ...

`Readonly`room

The room or client that the event came from.

`Static`eventName

eventName: "component.despawn" = ...