Skip to main content

Interface: AuralAlertControlEvents

Events used to send commands to AuralAlertSystem.

Properties​

aural_alert_activate​

• aural_alert_activate: string | Readonly<AuralAlertActivation>

Activates an aural alert. The event data should be the unique ID of the alert or an activation data object that contains the unique ID and optional override parameters. If no override parameters are provided, then the alert will play as it was defined during registration.

Once activated, the alert will be queued to play once all higher-priority alerts that are playing or queued have finished playing. If the alert is already active, then this command has no effect.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:170

aural_alert_deactivate​

• aural_alert_deactivate: string

Deactivates an aural alert. The event data should be an (optionally suffixed) alert ID. An alert is considered deactivated only when all of its suffixes are deactivated (the un-suffixed ID also counts as a suffix).

Deactivating an alert will clear any queued activated instances of the alert. If the activated alert is already playing, it will finish playing but will not loop if it is continuous.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:179

aural_alert_deactivate_all​

• aural_alert_deactivate_all: void

Deactivates all aural alerts.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:211

aural_alert_kill​

• aural_alert_kill: string

Kills an aural alert. The event data should be an (optionally suffixed) alert ID.

Killing an alert will deactivate and untrigger the alert. If the alert is already playing, it will be stopped at the earliest opportunity.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:208

aural_alert_kill_all​

• aural_alert_kill_all: void

Kills all aural alerts.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:217

aural_alert_register​

• aural_alert_register: Readonly<AuralAlertDefinition>

Registers an aural alert. Alerts must be registered before they can be activated.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:160

aural_alert_trigger​

• aural_alert_trigger: string | Readonly<AuralAlertActivation>

Triggers an aural alert. The event data should be the unique ID of the alert or an activation data object that contains the unique ID and optional override parameters. If no override parameters are provided, then the alert will play as it was defined during registration.

Once triggered, the alert will be queued to play once all higher-priority alerts that are playing or queued have finished playing. A triggered alert is not considered active. Triggering an alert while an existing triggered instance is queued will replace the existing instance with the new instance. Triggered alerts automatically revert to an untriggered state after they are finished playing.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:191

aural_alert_untrigger​

• aural_alert_untrigger: string

Untriggers an aural alert. The event data should be an (optionally suffixed) alert ID. An alert is considered untriggered only when all of its suffixes are deactivated (the un-suffixed ID also counts as a suffix).

Untriggering an alert will clear any queued triggered instances of the alert. If the triggered alert is already playing, it will finish playing but will not loop if it is continuous.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:200

aural_alert_untrigger_all​

• aural_alert_untrigger_all: void

Untriggers all aural alerts.

Defined in​

src/sdk/utils/sound/AuralAlertSystem.ts:214