[image: Banner]

Emit Module

This is a fork of the emit module provided by the VFX Forge Roblox plugin, made from zilibobi/forge-vfx after 2.4.0. It adds a playback rate, so every effect can be slowed down, sped up or frozen while it plays.

vfx.setRate(2) -- every effect, including ones already playing, runs twice as fast
vfx.setRate(0) -- every effect freezes where it is
vfx.track(workspace.Map) -- enabled emitters, beams, trails and sounds the engine runs by itself follow the rate too

The rate covers delays, durations, tweens, flipbooks, particles, beams, trails, sounds, camera shakes and debris. Particles can't run faster than a TimeScale of 1, so an emitter authored at a TimeScale of 0.25 can be sped up to 4x. Debris keeps its path at any rate by scaling its velocity and the gravity on it.

License

The emit module is licensed under a custom source-available copyleft license which only allows usage within Roblox games. This fork is under the same license.

Installation

Wally (Luau)

ForgeVFX = "josephh310/forge-vfx@1.0.1"

Usage

The module needs to be initialized before emitting any effects. After that it is also exposed inside shared.vfx.

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local vfx = require(ReplicatedStorage.ForgeVFX)

vfx.init()
vfx.emit(workspace.Effect)