confetti ‐ Beautiful Confetti Animation - cobocombo/Scriptit-Core GitHub Wiki

Module for presenting a confetti animation over the current content.

Properties

• isPaused: Flag that returns if the animation is currently paused or not.
• isRunning: Flag that returns if the animation is currently running or not.

Methods

• pause: Method to pause the animation.
• remove: Method to remove the animation.
• resume: Method to resume the animation that was previously paused.
• start ({ timeout }): Method to start a confetti animation with the option of adding a timeout in milliseconds.
• stop: Method to stop the animation.

Usage

Confetti with 3 second timer:

confetti.start({ timeout: 3000 });

Other methods:

confetti.pause();
confetti.resume();
confetti.stop();
confetti.remove();