RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Play Sound======
----

Plays the specified sound effect once.

<code python>
play_sound(sound_name)
</code>

^Argument^Description^Type^Required^
|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:====
<code python>
play_sound("door_open")
</code>
//Results:// Plays the sound effect named "door_open" one time.

<WRAP center round tip 100%>
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.
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:wiki:play_sound_node.png?nolink|}}
</WRAP>

<WRAP half column>
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation