Skip to main content

Type Alias: AuralAlertDefinition

AuralAlertDefinition = object

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

A sound packet that can be played by SoundServer.

Properties​

continuous​

continuous: boolean

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

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.

priority​

priority: number

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

The priority of the alert within its queue. If two alerts in the same queue become active at the same time, the alert with the higher priority will play first. However, alerts cannot interrupt other alerts that are already playing, regardless of their relative priorities.

queue​

queue: string

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

The name of the queue to which the alert belongs. Only one alert from each queue can play simultaneously unless they are on different tracks (see the documentation for track for more information).

queuedLifetime?​

optional queuedLifetime: number

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

The amount of time, in milliseconds, that the alert can remain in the queue before it is automatically removed from the queue. Defaults to Infinity.

repeat​

repeat: boolean

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

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.

sequence​

sequence: string | readonly string[]

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

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.

timeout?​

optional timeout: number

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

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. Defaults to 10000 milliseconds.

track?​

optional track: string

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

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 alert will play on the default track (with name equal to '').

uuid​

uuid: string

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

The ID of the alert.