Phaser Editor scripts for playback audio.
MIT License
Warning: This project is deprecated. It is now part of the @phaserjs/editor-scripts-quick library.
This project contains a few Phaser Editor scripts for playing Phaser audios.
These script nodes are very basic and may fit on any Phaser Editor project.
The scripts are coded in TypeScript with ES modules.
This package depends on the following packages:
@phaserjs/editor-scripts-core
To install this in your game you have to install dependencies too:
npm install @phaserjs/editor-scripts-core
npm install @phaserjs/editor-scripts-audio
Also, you should add this package to the phasereditor2d.config.json
file in your project, in the scripts
section:
{
"scripts": [
"@phaserjs/editor-scripts-core",
"@phaserjs/editor-scripts-audio",
]
}
script
tag to the index.html
file to load the lib/phasereditor2d_scripts_core.js
file.This library provides a couple of actions for playback audio files. As a reminder, an action is executed by an event script or another action.
It also contains user components for configuring the actions.
The actions:
The user components:
Class: PlayAudioActionScript
This action plays the audio you set in the Audio Key property. You can add the Audio Loop Config and Audio Volume Config components to this script for configuring the sound.
Class: StopAudioActionScript
This action stops the audio with the given Audio Key.
Class: StopAllSoundsActionScript
This action stops all playing audios.
Class: PauseAllSoundsActionScript
This action pauses all playing sounds.
Class: ResumeAllSoundsActionScript
This action resumes all paused audios.