sm.audio
The audio manager is used to play sound effects in the game.
Note: This manager does only produce sound for the local client. This is useful for small sound effects such as for GUI. For more information about sound and particle effects that affect all players, see sm.effect.
Constants
| Name | Type | Description |
|---|---|---|
soundList |
table | The table of sound names. {string, ...} |
soundList
Value type: table
Deprecated: Audio is deprecated, use Effect instead
A table with all the names of available sounds in the game.
Note: Values are not included in the source documentation.
Client-only
getGlobalParameter
sm.audio.getGlobalParameter( name )
Gets a named global parameter value from FMOD.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The name. |
Returns:
| Type | Description |
|---|---|
| number | The parameter value. |
play
sm.audio.play( sound, position )
Plays a sound.
If position is specified, the sound will play at the given coordinates in the world. Otherwise, the sound will play normally.
For a list of available sounds to play, see sm.audio.soundList.
Parameters:
| Name | Type | Description |
|---|---|---|
sound |
string | The sound to play. |
position (optional) |
Vec3 | The world position of the sound. (Optional) |
setGlobalParameter
sm.audio.setGlobalParameter( name, value )
Sets a named global parameter value in FMOD.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | The name. |
value |
number | The parameter value. |