Skip to content
On this page

AthenaClient.systems.alarm

Functions

loadAlarm

Usage

AthenaClient.systems.alarm.loadAlarm(name, count?): Promise<boolean>

Attempts to load an alarm multiple times before returning false.

Parameters

NameTypeDefault valueDescription
namestringundefinedThe name of the alarm.
count?number0Do not modify this. Leave it as zero.

Returns

Promise<boolean>

Defined in

client/systems/alarm.ts:17


startAlarm

Usage

AthenaClient.systems.alarm.startAlarm(name): Promise<void>

Play an alarm for the local player.

Parameters

NameTypeDescription
namestringThe name of the alarm.

Returns

Promise<void>

Defined in

client/systems/alarm.ts:50


stopAlarm

Usage

AthenaClient.systems.alarm.stopAlarm(name): Promise<void>

Stop an alarm for the local player.

Parameters

NameTypeDescription
namestringThe name of the alarm.

Returns

Promise<void>

Defined in

client/systems/alarm.ts:73


stopAllAlarms

Usage

AthenaClient.systems.alarm.stopAllAlarms(): Promise<void>

Stop all alarms for the local player.

Returns

Promise<void>

Defined in

client/systems/alarm.ts:86

Created by Stuyk | Est. 2020