Create effect

Let's create our first effect by using a function called CreateEffect, exported by the refx module.

Luau

myEffect.lua

local refx = require(path.to.refx)
local myEffect = refx.CreateEffect("myEffect")

function myEffect:OnStart()
    print("myEffect just started! 😅")
end

return myEffect

TypeScript

note

Just like WCS TypeScript implementation of myEffect is done via classes.

myEffect.ts

import { BaseEffect, VisualEffectDecorator } from "@rbxts/refx";

@VisualEffectDecorator
export class myEffect extends BaseEffect {
    public override OnStart() {
        print("myEffect just started! 😅");
    }
}

As you can see, we're overriding one of the built-in special methods provided by refx - OnStart.
This method fires whenever your effect starts. You can view list of all special methods in the api.

Constructor Arguments

You can also accept arguments in OnStart() and pass them to .new() or .locally(), when you start your effect later on:

Luau

myEffect.lua

local refx = require(path.to.refx)
local myEffect = refx.CreateEffect("myEffect")

function myEffect:OnStart(someArg)
    print("myEffect just started! 😅", someArg)
end

return myEffect

TypeScript

myEffect.ts

import { BaseEffect, VisualEffectDecorator } from "@rbxts/refx";

@VisualEffectDecorator
export class myEffect extends BaseEffect<[number]> {
    public override OnStart(someArg: number) {
        print("myEffect just started! 😅", someArg);
    }
}

Luau

somewhere.lua

local myEffect = require(path.to.effect)
local effect = myEffect.new(10)

TypeScript

somewhere.ts

import { myEffect } from "./myEffect";
const effect = new myEffect(10);