UiSyncEvent Class

UiSync Event class.

Extends

Methods

Name Description
constructor(): UiSyncEvent    

Inherited methods

Name Inherited from Description
addListener(listener: (args: UiSyncEventArgs) => void, scope?: any): () => void UiEvent<UiSyncEventArgs> Registers a Listener to be executed whenever this event is raised.
addOnce(listener: (args: UiSyncEventArgs) => void, scope?: any): () => void UiEvent<UiSyncEventArgs> Registers a callback function to be executed only once when the event is raised.
clear(): void UiEvent<UiSyncEventArgs> Clear all Listeners from this BeEvent.
emit(args: UiSyncEventArgs): void UiEvent<UiSyncEventArgs> Raises event with single strongly typed argument.
has(listener: (args: UiSyncEventArgs) => void, scope?: any): boolean UiEvent<UiSyncEventArgs> Determine whether this BeEvent has a specified listener registered.
raiseEvent(...args: [args]): void UiEvent<UiSyncEventArgs> Raises the event by calling each registered listener with the supplied arguments.
removeListener(listener: (args: UiSyncEventArgs) => void, scope?: any): boolean UiEvent<UiSyncEventArgs> Un-register a previously registered listener.

Inherited properties

Name Type Inherited from Description
numberOfListeners Accessor ReadOnly number UiEvent<UiSyncEventArgs> The number of listeners currently subscribed to the event.

Defined in

Last Updated: 20 June, 2023