Skip to main content

GlobalSettingsEvents

GlobalSettingsEvents = object

Event map type for GlobalSettings. This type defines the event signatures for global settings events.

Properties​

button​

button: (event: GlobalSettingButtonEvent) => void

Never emitted. Root does not support the button setting type: the Root clients don't show it, and your server never receives this event.

Parameters​

ParameterType
eventGlobalSettingButtonEvent

Returns​

void


update​

update: (event: GlobalSettingsUpdateEvent) => void

Emitted when a community member changes any setting value. The listener receives a GlobalSettingsUpdateEvent with both the previous and current settings.

Parameters​

ParameterType
eventGlobalSettingsUpdateEvent

Returns​

void