This module implements a basic pipeline that can be used for managing the flow of a set of functions, effects, sounds, and macros.

• JB2A - Jules&Ben's Animated Assets (Full paid version here)
• Jack Kerouac's Animated Spell Effects
• Jack Kerouac's Animated Cartoon Spell Effets

https://github.com/FantasyCalendar/FoundryVTT-Sequencer/releases/latest/download/module.json

Click the link above to go to the documentation where each feature is listed.

First you have to define a sequence:

let sequence = new Sequence()

Then, you can add functions and effects to it.

let sequence = new Sequence()

sequence.thenDo(function(){
    do_something();
})

sequence.wait(200)

sequence.thenDo(async function(){
    do_something_else();
})

The Sequencer uses a method-chaining fluent interface, meaning you can continuously call functions on the sequence object, like so:

let sequence = new Sequence()
    .thenDo(function(){
        do_something();
    })
    .wait(200)
    .thenDo(async function(){
        do_something_else();
    })

To start the sequence off, you simply call play() on the sequence.

⬇️ Go to advanced examples ⬇️

To getEntry the following result:

• Plays an effect on a token's location
• Wait for 400 milliseconds
• Play a sound
• Wait for 600 milliseconds
• Play another effect pointing towards 500px to the left of the token
• Wait for 100 milliseconds
• Teleport the token 500px to the left
• Play another effect on the token's location

Uses Jack Kerouac's Animated Cartoon Spell Effets

You'd have to write something like this (with FXMaster installed):

async function wait(ms){
    return new Promise(resolve => {
        setTimeout(resolve, ms);
    });
}

const token = canvas.tokens.controlled[0];

let data = {
    file: "modules/animated-spell-effects-cartoon/spell-effects/cartoon/electricity/electrivity_blast_CIRCLE.webm",
    position: token.center,
    anchor: {
        x: 0.5,
        y: 0.5
    },
    scale: {
        x: 0.35,
        y: 0.35
    }
};

game.socket.emit("module.fxmaster", data);
canvas.fxmaster.playVideo(data);

await wait(400);

AudioHelper.play({
    src: ["Music/Sound_Effects/teleport.wav"],
    volume: 0.8,
    autoplay: true,
    loop: false
}, true);

await wait(600);

let to_location = {
    x: token.center.x+500,
    y: token.center.y
}

let ray = new Ray(token.center, this._to);

data = {
    file: "modules/animated-spell-effects-cartoon/spell-effects/cartoon/electricity/lightning_bolt_RECTANGLE_05.webm",
    position: token.center,
    anchor: {
        x: 0.5,
        y: 0.5
    },
    scale: {
        x: 0.2,
        y: 0.2
    },
    rotation: ray.angle,
    width: ray.distance
};

game.socket.emit("module.fxmaster", data);
canvas.fxmaster.playVideo(data);

await wait(100);

await token.update({ x: token.position.x+500, y: token.position.y }, { animate: false });

data = {
    file: "modules/animated-spell-effects-cartoon/spell-effects/cartoon/electricity/electric_ball_CIRCLE_06.webm",
    position: token.center,
    anchor: {
        x: 0.5,
        y: 0.5
    },
    scale: {
        x: 0.5,
        y: 0.5
    }
};

game.socket.emit("module.fxmaster", data);
canvas.fxmaster.playVideo(data);

Here's an example using the Sequencer instead:

let tokenD = canvas.tokens.controlled[0];
let sequence = new Sequence()
    .effect()
        .file("modules/animated-spell-effects-cartoon/spell-effects/cartoon/electricity/electrivity_blast_CIRCLE.webm")
        .atLocation(tokenD)
        .scale(0.35)
    .wait(1000)
        .effect()
        .file("modules/animated-spell-effects-cartoon/spell-effects/cartoon/electricity/lightning_bolt_RECTANGLE_05.webm")
        .atLocation(tokenD)
        .reachTowards({
            x: tokenD.center.x + canvas.grid.size*4,
            y: tokenD.center.y
        })
    .wait(100)
    .animation()
        .on(tokenD)
        .teleportTo({
            x: tokenD.x + canvas.grid.size*4,
            y: tokenD.y
        })
        .waitUntilFinished()
    .effect()
        .file("modules/animated-spell-effects-cartoon/spell-effects/cartoon/electricity/electric_ball_CIRCLE_06.webm")
        .atLocation(tokenD)
        .scale(0.5)

sequence.play();

new Sequence()
    .effect()
        .atLocation(canvas.tokens.controlled[0])
        .reachTowards(canvas.tokens.controlled[1])
        .baseFolder("Images/Effects/Magic_Missile")
        .startPoint(200)
        .endPoint(200)
        .setMustache({
            "color": () => {
                return ['Blue', 'Green', 'Purple', 'Yellow'][Math.floor(Math.random() * 4)]
            },
            "number": () => {
                return Math.floor(Math.random() * 9) + 1;
            }
        })
        .addOverride(
            async (effect, data) => {
                if(data.distance <= 1800){
                    data.file = "MagicMissile_01_Regular_{{color}}_30ft_0{{number}}_1600x400.webm";
                }else{
                    data.file = "MagicMissile_01_Regular_{{color}}_60ft_0{{number}}_2800x400.webm";
                }
                return data
            }
        )
        .repeats(3, 200, 300)
    .play();

Uses JB2A - Jules&Ben's Animated Assets

new Sequence()
    .effect()
        .file("modules/jb2a_patreon/Library/Generic/Magic_Signs/Abjuration_01_Blue_Circle_800x800.webm")
        .atLocation(canvas.tokens.controlled[0])
        .JB2A()
        .scale(0.5)
        .belowTokens()
        .fadeIn(1500, {ease: "easeOutCubic", delay: 500})
        .fadeOut(1500)
        .rotateIn(90, 2500, {ease: "easeInOutCubic"})
        .rotateOut(350, 1500, {ease: "easeInCubic"})
        .scaleIn(1, 2500, {ease: "easeInOutCubic"})
        .scaleOut(0, 1500, {ease: "easeInCubic"})
    .play()

Uses JB2A - Jules&Ben's Animated Assets

new Sequence()
    .effect()
        .atLocation(canvas.tokens.controlled[0])
        .file('Images/Effects/Lightning/LightningStrike_01{{letter}}_800x800.webm')
        .setMustache({
            // random letter between a to f
            "letter": String.fromCharCode(Math.floor(Math.random()*6)+1+64).toLowerCase()
        })
        .scale(2)
        .randomizeMirrorX()
    .play();

Uses JB2A - Jules&Ben's Animated Assets

new Sequence()
    .effect("modules/animated-spell-effects-cartoon/spell-effects/cartoon/water/acid_splash_CIRCLE_01.webm")
        .atLocation(canvas.tokens.controlled[0])
        .scale(0.3, 0.6)
        .randomRotation()
    .effect("modules/animated-spell-effects-cartoon/spell-effects/cartoon/water/acid_splash_CIRCLE_01.webm")
        .atLocation(canvas.tokens.controlled[1])
        .scale(0.3, 0.6)
        .randomRotation()
    .play();

Uses Jack Kerouac's Animated Cartoon Spell Effets

• Sequencer - Added animated space backgrounds (thanks to Keirsti on the Foundry VTT discord server)
• Sequencer - Fixed Hyperspace macro placing the hyperspace intro and out incorrectly

• Sequencer - Changed Effect Viewer icon to something less controversial

• Sequencer - Renamed .sequence() method on Sequences to .addSequence() due to internal code conflicts
• Effects - Added .filter() - was technically added in 1.0.0, but was left undocumented
• Effects - Fixed .size() being scaled to account for grid size differences - it should now set the exact width/height in pixels

• Sequencer - Added recent Sequencer tools to the menu in the top left - you can disable these in the module settings
• Sequencer - Added Sequencer.EffectManager to manage persistent effects - read more here
• Sequencer - Added the ability for you to implement your own Sequencer functions - read more here
• Sequencer - SequencerDatabase is deprecated, and is now accessible with Sequencer.Database - 1.1.0 will remove the old path entirely
• Sequencer - SequencerDatabaseViewer is deprecated, and is now accessible with Sequencer.DatabaseViewer - 1.1.0 will remove the old path entirely
• Sequencer - SequencerPreloader is deprecated, and is now accessible with Sequencer.Preloader - 1.1.0 will remove the old path entirely
• Sequencer - Fixed Documents sometimes not properly resolving to their PlaceableObject
• Sequencer - Fixed settings not being client side - whoops
• Effects - Added .attachTo() which causes the effect to be attached to a given object
• Effects - Added .persist() which causes the effect to become permanent on the canvas until removed
• Effects - Added .extraEndDuration() which allows .persist()-ed effects to stick around for a bit longer instead of end immediately
• Effects - Tweaked .missed() to hit an area only facing the origin of the effect, if it had an origin and target
• Effects & Sounds - Added support for wildcard paths, like modules/jb2a_patreon/Library/1st_Level/Bardic_Inspiration/BardicInspiration_01_*_400x400.webm

• Sequencer - Fixed an issue where the preloader would sometimes fail to preload
• Effects - Fixed effects not playing on hex grids

• Effects - Fixed rangefinding effects sometimes not picking the right distance

• Sequencer - Improved the search speed of the Database Viewer
• Sequencer - Fixed previewing static images through the Database Viewer
• Sequencer - Fixed bugs that caused the Database to sometimes fail registering new files
• Effects - Fixed issue where .delay() would incorrectly contribute towards the effect's .waitUntilFinished() duration

• Sequencer - Fixed the database sometimes failing to get the correct file

• Sequencer - Fixed database not correctly finding range-based effects

• Effects & Sounds - Fixed .locally() and .forUsers() sometimes erroneously remembering users between different effects & sounds
• Effects - Fixed .scaleIn() would not take a custom .size() into account
• Effects - Fixed static images sometimes not playing due to duration being set to 0ms

• Sequencer - Added support for preloading files based on database paths
• Effects & Sounds - Added .locally() and .forUsers(), which allow you to control which users will have the effect and sounds played for them
• Effects - Improved positional handling of Tiles and TileDocuments

• Sequencer - Updated Sequencer Database Viewer layout to be more user friendly
• Effects - Fixed bug with templates and raw positions not being respected

• Sequencer - Added Sequencer Database Viewer to the module settings, it allows you to preview effects and copy any files registered with Sequencer by other modules
• Sequencer - Added client-side settings for users to be able to turn off effects and sounds being played locally
• Effects & Sounds - Fixed effects and sounds playing on scenes they did not originate from
• Effects - Added .size(), which sets the width and height of the effect in pixels
• Effects - Added rotate option to .moveTowards(), which defaults to true. If set to false, the effect will not rotate towards the end location.
• Effects - Fixed duration of effects using .moveTowards() not being calculated correctly
• Effects - Fixed static image effects' durations also not being calculated correctly

• Effects - Fixed effects failing to play static images

• Sequencer - Further small fixes to how the database registers files

• Sequencer - Removed the need for .playIf() to have to be given a function or a boolean
• Sequencer - Fixed issues with the database when files were listed in arrays

Breaking:

• Effects - .JB2A() has been altered to set the gridsize to 200, as it was previously set to 100 - this will halve the size all JB2A on-the-spot effects, sorry!

Additions:

• Sequencer - Added SequencerPreloader - you can now preload images, effects, and sounds for your players, read more on the docs
• Sequencer - Added support for templates and time ranges in database structure, more info on the docs
• Effects - Added support for static images such as webp, pngs, jpgs, etc
• Effects & Sounds - Added .startTime(), .startTimePerc(), .endTime(), .endTimePerc(), and .timeRange(), more info on the docs
• Sounds - Added .addOverride(), .baseFolder(), and .setMustache() support to sounds

Updates & Fixes:

• Sequencer - .play() now reliably resolves its promise at the end of the entire sequence
• Effects - Vastly improved effect caching and loading speed of effects and sounds
• Effects - Improved object position handling slightly when providing non-foundry class objects to .atLocation() and alike
• Effects - Generally improved compatibility with TokenDocument and Foundry D&D 5E documents when getting their positions

• Effects - Added .addPostOverride() as an alternative to .addOverride(), which executes at the end of the effect data sanitation
• Effects - Fixed .gridSize(), .startPoint(), and .endPoint() not being respected and being overridden by internal logic

• Macros - Fixed macros throwing error when playing sequence

• Effects - Fixed templates sometimes not being found
• Effects - Re-added backwards compatibility with old macros that still use data._distance in overrides

• Sequencer - Added alpha version of the Sequencer Database Viewer
• Effects - Added .randomOffset() which can add a random offset similar to .missed(), but within the bounds of the target token / tile / other. Check out the docs!
• Effects - Fixed .waitUntilFinished() not being respected
• Effects - Fixed .offset() throwing an error about a missing function
• Effects - Fixed .repeats() throwing an error, because the entire function went missing in the last update >.>

• Effects - Fixed effects sometimes not playing

• Effects - Fixed melee attacks not picking the right JB2A template

• Sequencer - Added sound to the Hyperspeed Sample thanks to the wonderful AurelTristen over at HellScape Tabletop Assets (even though they're not specifically focused on sound effects)
• Effects - Fixed major issue with JB2A templates, causing effects to pick the wrong ranged attacks & other shenanigans
• Effects - Fixed effect scale inconsistencies across scenes with different grid sizes

• Sequencer - Removed support for Foundry Version 0.7.x
• Sequencer - Refactored animations into a dedicated animation engine
• Effects - Added support for static image effects (.jpeg, .png, etc)
• Effects - Fixed grid size sometimes not being taken into account when playing effects with .reachTowards()
• Sounds - Vastly improved and fixed sound implementation, big thanks to ghost#2000!
• Sounds - Removed support for .fadeIn() and .fadeOut() in Sounds

• Sequencer - Added two sample scenes with macros and accompanying art:
  • An animated Oujia board made by md-mention2reply
  • A Star Wars inspired hyperspeed scene-switching scene, effects, and macro
• Sequencer - Removed Token Ease as dependency until we can solve its conflicts with other modules
• Effects - Fixed effects not auto-centering on tokens
• Effects - Fixed effects not finding the proper location when a previous effect's .name() was given
• Animations - Fixed .rotate(), .opacity(), and .volume(), now they work even without having to use their respective in/out functions

• Sequencer - Module now depends on Token Ease
• Sequencer - Added the Sequencer Database to help content creators! Read more on the database documentation how to use it!
• Effects & Sounds - Added support for database entries to the .file() method - more info can be found in the docs
• Animations, Effects & Sounds - Added the following functions:
  • .audioVolume()
  • .fadeInAudio()
  • .fadeOutAudio()
• Effects - Added support for delays on these methods (e.g. a delay of -500 means it will finish 500ms before the end of the duration):
  • .rotateOut()
  • .fadeOut()
  • .scaleOut()
  • .fadeOutAudio()
• Animations - Fixed .rotateTowards() to properly rotate towards the target without having to add an offset to properly line them up
• Effects - Made effects more intelligent when determining locations when given partial object data with _id entries
• Effects - Fixed issues surrounding delays and fades
• Sounds - .fadeIn() and .fadeOut() will become deprecated in a future version, please switch to .fadeInAudio() and .fadeOutAudio()

• Effects - Fixed effects not playing on tokens on 0.7.10 and below

• Effects - Added .offset() so that you can offset the effect - an optional parameter allows you to offset in local or canvas space
• Animations - Added .snapToSquare(), which causes the given object to be snapped to the square it is moving or teleported towards
• Animations - Fixed .rotateIn() and .rotateOut() not properly calculating rotation
• Animations - Adjusted .rotateTowards() to instead consider the target position as the rotation origin, rather than the object's current position

• Animations - Added .animation() section - animate tokens and tiles! Check out the documentation how to use it!
• Effects - Added official support for tiles in .atLocation(), .moveTowards(), etc
• Effects - Tweaked how effects getEntry locations when dealing with raw template data
• Sequencer - Added .sequence() so you can combine multiple sequences into one
• Sequencer - Updated all sample macros to 0.8.x conventions

• Effects - Removed error catch in .file() when providing it with something else than string or array
• Effects - Fixed .belowTokens() and .belowTiles() throwing errors if no boolean was provided

• Effects - Added .rotate() which adds an offset to the effect's rotation
• Effects - Fixed .moveTowards() not respecting given easing

• Sequencer - Breaking Changes: Removed deprecated .then() method
• Sequencer - Tweaked .play() to now return a promise
• Sequencer - Reworked module class structure
• Sequencer - Added debug setting

• Sequencer - Renamed .then() to .thenDo() due to JavaScript reasons — .then() will be removed in 0.4.1
• Sequencer - Removed the requirement to pass true as a second argument to .then() (now .thenDo()) if the function was async, it will now wait for it to finish if it is an async function
• Effects - Added .mirrorX() and .mirrorY() to mirror the effect on that axis
• Effects - Improved .JB2A() to better handle melee weapon attacks
• Effects - Tweaked .belowTiles() and .belowTokens() to accept an optional boolean parameter whether the effect should play behind the respective element
• Effects - Tweaked effects to assume that .webms have a base 100px internal grid for size consistency

• Effects - Fixed ANOTHER bug with .belowTiles() sometimes not playing below tiles

• Effects - Added .opacity() which controls the alpha of the effect being played
• Effects - Fixed bug with .belowTiles() sometimes not playing below tiles

• Effects - Added .belowTiles() to play effects below tiles
• Effects - Implemented better order handling - the effects created first will always be on top, each subsequent effect will be played below the previous
• Effects - Added .zIndex() for you to have direct control over the order of effects
• Effects & Sounds - Added .duration() which can override the duration of an effect or sound
• Effects & Sounds - Tweaked .waitUntilFinished() to accept a single number parameter as a delay or to end the effect or sound earlier - read more in the documentation
• Sounds - Added support for .fadeIn() and .fadeOut() - easing sadly doesn't work for sounds yet

• Sequencer - Added macro pack containing examples of Sequencer usages
• Effects - Added the following animated functions:
  • .scaleIn()
  • .scaleOut()
  • .rotateIn()
  • .rotateOut()
  • All of these can utilize any of the easings listed here: https://easings.net/
  • Read the documentation how to use these
• Effects - Added better error reporting when something goes wrong in the sequence
• Effects - Fixed bug with scale sometimes overriding .reachTowards()

• Effects - Added .belowTokens() so you can now play effects, well, below tokens
• Effects - Fixed effects not replicating properly (AGAIN)
• Effects - Fixed effects not being able to use .name()d effects if they didn't miss - now any effect can be named and be used in future effects

• Effects - Fixed effects that were supposed to be once-off instead looping

• Effects - Added .moveTowards() and .moveSpeed() for missile-like behavior
• Effects - Tweaked the way the effects layer is applied to the canvas' layers
• Effects - Fixed major issue with the way effects that were using .missed() and .name() were cached
• Sequencer - Removed stray debug code

• Effects - Added .fadeIn() and .fadeOut() - you can now make your effects look slightly nicer!
• Effects - Added support for cone and line templates with .reachTowards() and .rotateTowards() - it now reaches towards the end point of the template
• Effects - Added .name() to effects - this will cause the effect's position to be stored and can then be used with .atLocation(), .reachTowards(), and .rotateTowards() to refer to previous effects' locations
  • Example: naming an impact effect with .name("hit_location") and making it miss with .missed(), and then have a subsequent effect use .rotateTowards("hit_location") to rotate towards the previous effect's calculated location
• Effects - Fixed .scale() bug that caused it to not properly set the scale and then cause an error upon calling .play()
• Effects - Removed .moves() for future implementation
• Sequencer - Tweaked .async() and .waitUntilFinished() handling
  • They now act the same on effect and sounds that only play once, but if it .repeats(), .async() causes the effect or sound to wait between each repetition, .waitUntilFinished() causes the sequencer to wait until the effect or sound has finished executing all of its repetitions, which may or may not wait for each effect or sound to play with .async()
• Sequencer - Calling .play() now returns the sequence
• Sequencer - Removed FXMaster dependency and implemented a custom canvas layer and effects class

• Sequencer - Fixed .wait() breaking due to the .async() and .waitUntilFinished() swap

• Effects - Fixed issue that caused the wrong scale to be applied when using .reachTowards()

• Effects - Added .playIf() (docs); this allows you to completely ignore playing an effect or sound, depending on a boolean or a function
• Sounds - Added support for .async() and .waitUntilFinished() for sounds - requires both to be true due to code weirdness, I'll be refactoring this in the future
• Effects - Refactored .scale() when it was provided with a minimum and maximum value, it now randomizes the scale of the effect when executed instead of when the method was called
• Effects & Sounds - Refactored .file() for both effects and sounds so that providing an array of files no longer immediately picks one from the array, but randomly picks a file each time the section is executed
• Effects & Sounds - Refactored how .delay() interacted with .repeats(), which should result in more consistent behavior
• Sequencer - Swapped the functionality of .async() and .waitUntilFinished(), and clarified in the docs
• Sequencer - Added support for random range within a .wait() block (like, .wait(500, 1000) etc)

• Effects - Added .playbackRate() to effects, you can now speed up the play rate of your effects
• Sequencer - Tweaked internal handling of .async() together with .waitUntilFinished() improved
• Sequencer - Tweaked to use ready instead of init to load module

• Effects - Refactored .randomizeMirror() into .randomizeMirrorX() and .randomizeMirrorY()
• Effects - Refactored scaling algorithm for .reachTowards()
• Sequencer - Added support for random .wait() interval

• Effects - Refactored .aimTowards() into .rotateTowards() and .reachTowards()
• Effects - Refactored how .missed() chooses the location to hit and now takes token size into account
• Effects - Added .JB2A() to automatically set the effect to handle their sprites in the best way possible
• Effects - Added .randomizeMirror() to randomly mirror sprites on the Y axis
• Effects - Added Mustache support in file names

• Sequencer - Added support for executing macros
• Sequencer - Added support for playing sounds
• Sequencer - Wrapped classes in proxies to simplify fluid interface (gets rid of .done() on effects and sounds)

• First implementation

• U-man over at FXMaster for his implementation of layers - Copyright © 2020 Emmanuel Ruaud
• Otigon with his Automated Animations for his work on handling standardized effects - Copyright © 2020 Otigon
• ghost (ghost#2000 on discord) for his fixes to the audio sections
• Kandashi (Kandashi#6698 on discord) for the inspiration and code of persistent effects
• League of Extraordinary FoundryVTT Developers for their ongoing support and suggestions
• Foundry VTT Core code for heaps of inspiration

• Code - Copyright © 2020 md-mention2reply
• Art - Copyright © 2020 Matheus Moreno Mota
• Sound - https://99sounds.org/license/
• Image - https://pixabay.com/service/license/

• Hyperdrive Animations - Copyright © 2020 Adam Oresten
• Sounds HellScape Tabletop Assets - Copyright © 2020 AurelTristen
• Sci-fi Cockpits - Copyright © 2020 Vattalus Assets
• Stellaris Animated Backgrounds - Copyright © 2021 Paradox Interactive

• Easing Functions Cheat Sheet (GitHub) - Copyright © 2020 Andrey Sitnik and Ivan Solovev