Runtime API

Once the runtime module is planted at ReplicatedStorage.SineVFX, you drive effects from your game with three functions - the same emit / enable / disable verbs you use to preview in Studio.

Requiring the module

local VFX = require(game.ReplicatedStorage.SineVFX)

Do this from a client context (LocalScript or a module required by one) - effects render per-client. See client vs. server.

The runtime also registers itself on shared, so once the module has been required anywhere you can call it without holding the return value:

shared.sv.emit(target)
shared.sv.enable(target)
shared.sv.disable(target)

Both styles do the same thing; use whichever suits your code.

The three functions

You pass the instance that holds (or contains) your transformed effect(s). The module finds the tagged SineVFX effects under it and drives them.

VFX.emit(target)

Fire a one-shot play - a single burst over the effect's duration.

VFX.emit(workspace.Fireball.Explosion)

VFX.enable(target)

Turn the effect on and hold it - it keeps playing until you disable it. Use this for continuous effects (auras, persistent beams, ongoing shake).

VFX.enable(character.Aura)

VFX.disable(target)

Turn the effect off, with a short fade-out where it applies.

VFX.disable(character.Aura)

A minimal example

-- LocalScript
local VFX = require(game.ReplicatedStorage.SineVFX)

local effect = workspace:WaitForChild("Fireball"):WaitForChild("Explosion")

-- one-shot on impact
VFX.emit(effect)

-- or hold an aura while a state is active
VFX.enable(character.Aura)
task.wait(3)
VFX.disable(character.Aura)

Screen Effects

Screen Effects respond to the same three verbs. Point the API at the tagged Configuration (or an instance containing it) and it drives the shake, FOV, blur, colour grade, bloom and impact frames. They act on the client's view, so call it locally.

Lights, Highlights and Decals

Transformed Lights, Highlights and Decals work the same way: VFX.emit spawns a burst of copies, VFX.enable keeps spawning at their Rate, VFX.disable stops.

What a call reaches

VFX.emit(target) fires every SineVFX effect under target. Inside a 3D particle it fires everything except the RenderPart template, which fires per spawned particle instead.

Playing for all players

Because rendering is per-client, to show an effect to everyone:

1. On the server, fire a RemoteEvent to the relevant clients.
2. On each client, call VFX.emit(...) in the event handler.

Gotchas

• Call from the client. Calling emit / enable / disable from the server warns and won't render - rendering is client-side.
• Re-plant after edits. The module is a snapshot; re-plant it when you change effects so the runtime matches your latest authoring. See the runtime module.
• Wait for replication. Use WaitForChild for effects that may not have replicated to the client yet.