Skip to content

Play BGM

Overview

Used to play specified background music (BGM) in a particular scene or interaction node. It helps build atmosphere and emotion. Playing BGM is executed immediately and does not block subsequent script execution.

Syntax

play bgm <music name>

Parameters

ParameterRequiredExampleDescription
Music nameYesmain_themeIdentifier of the BGM file to play

Code Examples

play bgm main_theme
play bgm peaceful_morning
play bgm tension_theme

Released under BSD3-Clause License.