User Tools

Site Tools


play_sound

This is an old revision of the document!


Play Sound


Plays the specified sound effect once.

Signature:

play_sound(sound_name)
ArgumentDescriptionTypeRequired
sound_nameName of the sound effect to play.StringYes

This function plays the sound at the game's current sound effect volume. For positional/spatial sounds, you can attach a sound effect to a model's animation in order for the sound level to adjust based on the distance from the player. The Sound FX Generator can be used to generate some basic 8-bit style sound effects.

Example:

play_sound("door_open")

Results: Plays the sound effect named “door_open” one time.

Use the Play Sound function to trigger a sound effect when the player opens a door or a treasure chest, or an event occurs that you'd like the player to hear regardless of their location.


Editor Node:

play_sound.1521218805.txt.gz · Last modified: 2018/03/16 09:46 by justin