Skip to main content

gui.vol

gui.vol controls the game volume.

Security Level​

FULLSEC

Syntax​

CLI​

gui.vol { bgm: 5, sfx: 5 }

Script​

Cannot be called as a subscript.

Parameters​

At least one argument is required. If no arguments are provided, gui.vol will return a Failure object and usage instructions. All argument values are numbers ranging from 0 to 11. The default values are 11.

bgm​

The 'bgm' argument specifies the music volume.

sfx​

The 'sfx' argument specifies the sound effects volume.

Return​

Returns a Success or Failure object.

CLI​

>>gui.vol { bgm: 5, sfx: 5 }
Success

Script​

Cannot be called as a subscript.