Command:
Play looping SE
Script:
$gameSystem.playLoopingSe(name, volume, pitch, pan);
Script arguments:
- name - filename in audio/se/ folder without extension
- volume - volume from 0 to 100. Optional argument. Default value - 100.
- pitch - tempo from 0 to 100. Optional argument. Default value - 100.
- pan - pan from -100 to 100. Optional argument. Default value - 0.
Description:
The command plays a sound in a loop, similar to BGM or BGS. The difference from BGS is that there can be multiple sounds (However, in the current implementation only one sound can be looped).
Command:
Play looping SE safely
Script:
$gameSystem.playLoopingSeSafe(name, volume, pitch, pan);
Script arguments:
Same as "Play looping SE" command
Description:
Same as "Play looping SE" command, but if there is already any looping sound, the new one won't play.
Command:
Stop playing looping SE
Script:
$gameSystem.stopPlayingLoopingSe();
Description:
Stops all looping SE.
Command:
Modify BGM
Script:
$gameSystem.modifyBgm(value);
Script arguments:
- value - value from 0.00 to 1.00
Description:
Multiplies BGM volume by value during playback. The value is saved in the save file and restored when loading the game. Unlike regular sound volume settings, this value is not controlled by the player and is saved in the local save file, not the global config.
Command:
Modify BGS
Script:
$gameSystem.modifyBgs(value);
Script arguments:
- value - value from 0.00 to 1.00
Description:
Same as "Modify BGM" command, but for BGS.
Command:
Modify BGM gradually
Script:
$gameSystem.modifyBgmGradually(value, frames);
Script arguments:
- value - value from 0.00 to 1.00
- frames - positive integer.
Description:
Same as "Modify BGM" command, but the value changes gradually over the specified number of frames.
Command:
Modify BGS gradually
Script:
$gameSystem.modifyBgsGradually(value, frames);
Script arguments:
- value - value from 0.00 to 1.00
- frames - positive integer.
Description:
Same as "Modify BGM gradually" command, but for BGS.
Command:
Launch a playlist
Script:
$gameSystem.launchPlaylist(files, random, loop, volume, pitch, pan);
Script arguments:
- files - an array of files in the audio/bgm/ folder without extension
- random - whether to shuffle the list: true or false
- loop - whether to loop the list: true or false
- volume - volume from 0 to 100. Optional argument. Default value - 100.
- pitch - tempo from 0 to 100. Optional argument. Default value - 100.
- pan - pan from -100 to 100. Optional argument. Default value - 0.
Description:
Reproduces the specified files one after the other.
Command:
Launch a playlist (from dir)
Script:
$gameSystem.launchPlaylistFromDir(dir, random, loop, volume, pitch, pan);
Script arguments:
- dir - the path to the subfolder in audio/bgm/
- random - whether to shuffle the list: true or false
- loop - whether to loop the list: true or false
- volume - volume from 0 to 100. Optional argument. Default value - 100.
- pitch - tempo from 0 to 100. Optional argument. Default value - 100.
- pan - pan from -100 to 100. Optional argument. Default value - 0.
Description:
Plays files from the specified audio/bgm/ subfolder one after the other.
The Phileas_FileManager plugin is required to execute this command!
Command:
Stop the playlist
Script:
$gameSystem.stopPlaylist();
Description:
Stops the current playlist.
