Skip to content
On this page

AthenaClient.systems.sound

Functions

frontend

Usage

AthenaClient.systems.sound.frontend(audioName, ref): void

Play a sound in the frontend.

https://altv.stuyk.com/docs/articles/tables/frontend-sounds.html

Parameters

NameTypeDescription
audioNamestringThe name of the audio file to play.
refstringThe name of the sound you want to play.

Returns

void

None

Defined in

client/systems/sound.ts:21


handlePlayAudioPositional

Usage

AthenaClient.systems.sound.handlePlayAudioPositional(pos, soundName, soundInstantID?): void

Handle play audio positional

Parameters

NameType
posVector3
soundNamestring
soundInstantID?string

Returns

void

Defined in

client/systems/sound.ts:31


play2d

Usage

AthenaClient.systems.sound.play2d(soundName, volume?, soundInstantID?): void

Play a 2D sound.

Parameters

NameTypeDefault valueDescription
soundNamestringundefinedThe name of the sound to play.
volumenumber0.35The volume of the sound.
soundInstantID?stringundefined-

Returns

void

None

Defined in

client/systems/sound.ts:110


play3d

Usage

AthenaClient.systems.sound.play3d(entity, soundName, soundInstantID?): void

Really basic 3D audio. Does not update after first play. Simply plays the audio based on your position.

Parameters

NameType
entityEntity
soundNamestring
soundInstantID?string

Returns

void

Defined in

client/systems/sound.ts:66


stopAudio

Usage

AthenaClient.systems.sound.stopAudio(soundInstantID?): void

Stop audio.

Parameters

NameType
soundInstantID?string

Returns

void

None

Defined in

client/systems/sound.ts:120

Created by Stuyk | Est. 2020