Class EntityEventWrapper<T>

Helper class used to wrap all event API for a single event name.

Type Parameters

T

Index

Constructors

Properties

onAnyEventReceived onEventReceived onRemoteEventReceived

Methods

Constructors

constructor

new EntityEventWrapper<T>(
messageWrapper: NetworkMessageWrapper<T>,
eventName: string,
): EntityEventWrapper<T>
Type Parameters
- T
Parameters
- messageWrapper: NetworkMessageWrapper<T>
- eventName: string
Returns EntityEventWrapper<T>

Properties

onAnyEventReceived

onAnyEventReceived: EventWrapper<[NetworkMessage<unknown>]>

Deprecated

Event triggered when a network event is received.

onEventReceived

onEventReceived: EventWrapper<[NetworkMessage<unknown>]>

Event triggered when a network event is received.

onRemoteEventReceived

onRemoteEventReceived: EventWrapper<[NetworkMessage<unknown>]>

Event triggered when a network event is received, but only from remote users.

Methods

send

send(data?: T, onlySendRemote?: boolean): void
Send this event.
Parameters
- Optionaldata: T
  Optional data object to send
- OptionalonlySendRemote: boolean
  Optional boolean, if true, this event won't be received by the local SyncEntity that sent it
Returns void