V5 DocsAthena.systems.sound ​
Interfaces ​
Functions ​
override ​
Usage
Athena.systems.sound.override(functionName, callback): any
Used to override sound trigger functions.
Parameters ​
| Name | Type |
|---|---|
functionName | "playSound" |
callback | (player: Player, soundInfo: CustomSoundInfo) => any |
Returns ​
any
Defined in ​
Usage
Athena.systems.sound.override(functionName, callback): any
Used to override sound trigger functions.
Parameters ​
| Name | Type |
|---|---|
functionName | "playSoundInDimension" |
callback | (dimension: number, soundInfo: Omit<CustomSoundInfo, "pos">) => any |
Returns ​
any
Defined in ​
Usage
Athena.systems.sound.override(functionName, callback): any
Used to override sound trigger functions.
Parameters ​
| Name | Type |
|---|---|
functionName | "playSoundInArea" |
callback | (soundInfo: Required<Omit<CustomSoundInfo, "volume" | "target">>) => any |
Returns ​
any
Defined in ​
playSound ​
Usage
Athena.systems.sound.playSound(player, soundInfo): any
Play a single sound for a player.
Static
Parameters ​
| Name | Type | Description |
|---|---|---|
player | Player | An alt:V Player Entity |
soundInfo | CustomSoundInfo |
Returns ​
any
Defined in ​
playSoundInArea ​
Usage
Athena.systems.sound.playSoundInArea(soundInfo): any
Play a custom sound in a 3D position for all players in the area.
Static
Parameters ​
| Name | Type |
|---|---|
soundInfo | Required<Omit<CustomSoundInfo, "volume" | "target">> |
Returns ​
any
Defined in ​
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 ​
| Name | Type |
|---|---|
dimension | number |
soundInfo | Omit<CustomSoundInfo, "pos"> |
Returns ​
any