Skip to main content

Type Alias: AuralAlertActivation

AuralAlertActivation = object

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:81

Data describing how to activate an alert.

Properties​

alias?​

optional alias: string

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:93

The alias to use to activate or trigger the alert instead of the alert's registered ID. The alias must be unique.

If an alias is defined, it will be used in place of the alert's registered ID when determining activation or trigger state. Alerts activated or triggered with multiple aliases will play once per alias. In effect, using an alias behaves as if a copy of the aliased alert were temporarily registered with the alias as its ID for as long as the alias is activated/triggered.

continuous?​

optional continuous: boolean

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:129

Whether the alert's sound sequence should loop from the beginning when it is finished playing. If true, then the alert effectively has an infinite duration, and once it starts playing it will never stop until forced to do so by a deactivate, untrigger, or kill command. If not defined, then the alert will loop if and only if it was defined to do so during registration.

queuedLifetime?​

optional queuedLifetime: number

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:150

The amount of time, in milliseconds, that the alert can remain in the queue before it is automatically removed from the queue. If not defined, then the lifetime defined when the alert was registered will be used.

repeat?​

optional repeat: boolean

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:136

Whether the alert should be requeued after it finishes playing if it is still active. If true, then the alert will play continuously while active as long as another alert of higher priority is not queued. If not defined, then the alert will repeat if and only if it was defined to do so during registration.

sequence?​

optional sequence: string | readonly string[]

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:121

The sequence of sound atoms to play for the alert, as either a single ID or an array of IDs. Each atom is a single sound file. If not defined, then the sequence defined when the alert was registered will be played.

suffix?​

optional suffix: string

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:107

The suffix to append to the alert's ID to activate or trigger the alert. Suffixing an alert ID will generate a suffixed ID in the form `${uuid}::${suffix}`. The suffixed ID must be unique.

If a suffix is defined, the suffixed ID will be used to determine activation/triggered state. An alert can be activated or triggered with multiple suffixes. However, it will still only be played once regardless of how many of its suffixes are active or triggered. An alert is considered deactivated or untriggered only when all of its suffixes are deactivated or untriggered.

If both an alias and a suffix are defined, the suffix will be appended to the alias instead of the alert's registered ID.

timeout?​

optional timeout: number

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:144

The amount of time, in milliseconds, after the alert starts playing at which to forcibly stop the alert. It is recommended to set this value to be at least several seconds longer than the expected length of the alert's entire sequence. If the alert is continuous, the timeout is reset with each loop. If not defined, then the timeout defined when the alert was registered will be used.

track?​

optional track: string

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:115

The name of the track on which to play the alert. Each queue has an arbitrary number of tracks. Alerts on different tracks can play at the same time. However, an alert will still wait until all other alerts in the same queue with higher priority are finished playing before it starts playing, even if the other alerts are playing on different tracks. If not defined, then the track defined when the alert was registered will be used.

uuid​

uuid: string

Defined in: src/sdk/utils/sound/AuralAlertSystem.ts:83

The ID of the alert to activate.