Configuration

You can configure your custom methods by using built-in function called Configure. Let's configure our custom method to use an unreliable remote event under the hood, so we can safely fire it a lot of times.

Luau

myEffect.lua

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

function myEffect:OnConstruct()
    self.DestroyOnEnd = false -- so our effect don't get destroyed instantly.
    self.MaxLifetime = 10
end

function myEffect:DoSomething(arg) -- our custom method
    print(arg)
end

refx.Configure(myEffect.DoSomething, { -- configuring to use an unreliable remote
    Unreliable = true,
})

return myEffect

TypeScript

myEffect.ts

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

@VisualEffectDecorator
export class myEffect extends BaseEffect {
    protected readonly DestroyOnEnd = false; // so our effect don't get destroyed instantly.
    protected readonly MaxLifetime = 10;

    @Config({ Unreliable: true }) // configuring to use an unreliable remote
    public DoSomething(arg: number) { // our custom method
        print(arg);
    }
}