Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Allows you to control playing music tracks.
Permission Level | Game Directors |
---|---|
Requires Cheats? | Yes |
Usage
Queue track
/music queue <trackName: string> [volume: float] [fadeSeconds: float] [repeatMode: MusicRepeatMode]
Queue a track name
with an optional volume
, fade seconds
, and repeat mode
.
Play track
/music play <trackName: string> [volume: float] [fadeSeconds: float] [repeatMode: MusicRepeatMode]
Play a track name
with an optional volume
, fade seconds
, and repeat mode
.
Stop music
/music stop [fadeSeconds: float]
Stop the music with optional fade seconds
value.
Adjust volume
/music volume <volume: float>
Adjust the volume with required volume
value.
Arguments
fadeSeconds
: float Afloat
number that specifies the duration the track fades in or out.repeatMode
: MusicRepeatMode Optional. Anenum
that specifies how the music is played. Must beplay_once
(default) orloop
.trackName
: string Required. Astring
to specify the track to play. Must be a single word such asrecord.cat
.volume
: float Afloat
number to specify the volume of the music track.
Enums
MusicRepeatMode
Enum of Music Repeat Modes
Values
play_once
Play Onceloop
Loop