Skip to content
On this page

Athena.systems.sound

Interfaces

Functions

override

Usage

Athena.systems.sound.override(functionName, callback): any

Used to override sound trigger functions.

Parameters

NameType
functionName"playSound"
callback(player: Player, soundInfo: CustomSoundInfo) => any

Returns

any

Defined in

server/systems/sound.ts:129

Usage

Athena.systems.sound.override(functionName, callback): any

Used to override sound trigger functions.

Parameters

NameType
functionName"playSoundInDimension"
callback(dimension: number, soundInfo: Omit<CustomSoundInfo, "pos">) => any

Returns

any

Defined in

server/systems/sound.ts:130

Usage

Athena.systems.sound.override(functionName, callback): any

Used to override sound trigger functions.

Parameters

NameType
functionName"playSoundInArea"
callback(soundInfo: Required<Omit<CustomSoundInfo, "volume" | "target">>) => any

Returns

any

Defined in

server/systems/sound.ts:131


playSound

Usage

Athena.systems.sound.playSound(player, soundInfo): any

Play a single sound for a player.

Static

Parameters

NameTypeDescription
playerPlayerAn alt:V Player Entity
soundInfoCustomSoundInfo

Returns

any

Defined in

server/systems/sound.ts:51


playSoundInArea

Usage

Athena.systems.sound.playSoundInArea(soundInfo): any

Play a custom sound in a 3D position for all players in the area.

Static

Parameters

NameType
soundInfoRequired<Omit<CustomSoundInfo, "volume" | "target">>

Returns

any

Defined in

server/systems/sound.ts:100


playSoundInDimension

Usage

Athena.systems.sound.playSoundInDimension(dimension, soundInfo): any

Play a custom non-frontend sound in a dimension. Specify an entity to make the sound play from that specific entity.

Static

Parameters

NameType
dimensionnumber
soundInfoOmit<CustomSoundInfo, "pos">

Returns

any

Defined in

server/systems/sound.ts:73

Created by Stuyk | Est. 2020