User Tools

Site Tools


play_sound

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
play_sound [2017/04/26 14:59] justinplay_sound [2018/03/16 09:46] justin
Line 4: Line 4:
 Plays the specified sound effect once. Plays the specified sound effect once.
  
 +====Signature:====
 <code python> <code python>
 play_sound(sound_name) play_sound(sound_name)
Line 10: Line 11:
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
 |sound_name|Name of the sound effect to play.|[[String]]|Yes| |sound_name|Name of the sound effect to play.|[[String]]|Yes|
 +
 +<WRAP center round info 100%>
 +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.
 +</WRAP>
  
 ====Example:==== ====Example:====
Line 15: Line 20:
 play_sound("door_open") play_sound("door_open")
 </code> </code>
-//Results:// Plays the sound effect named "door_open".+//Results:// Plays the sound effect named "door_open" one time.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
play_sound.txt · Last modified: 2024/01/31 22:20 by justin