V5 DocsAthenaClient.systems.alarm ​
Functions ​
loadAlarm ​
Usage
AthenaClient.systems.alarm.loadAlarm(name, count?): Promise<boolean>
Attempts to load an alarm multiple times before returning false.
Parameters ​
| Name | Type | Default value | Description |
|---|---|---|---|
name | string | undefined | The name of the alarm. |
count? | number | 0 | Do not modify this. Leave it as zero. |
Returns ​
Promise<boolean>
Defined in ​
startAlarm ​
Usage
AthenaClient.systems.alarm.startAlarm(name): Promise<void>
Play an alarm for the local player.
Parameters ​
| Name | Type | Description |
|---|---|---|
name | string | The name of the alarm. |
Returns ​
Promise<void>
Defined in ​
stopAlarm ​
Usage
AthenaClient.systems.alarm.stopAlarm(name): Promise<void>
Stop an alarm for the local player.
Parameters ​
| Name | Type | Description |
|---|---|---|
name | string | The name of the alarm. |
Returns ​
Promise<void>
Defined in ​
stopAllAlarms ​
Usage
AthenaClient.systems.alarm.stopAllAlarms(): Promise<void>
Stop all alarms for the local player.
Returns ​
Promise<void>