---

Quick example on how to use:

local TextEffects = require(...)

-- uiInstance: GuiObject, effectType: string, speed: number?, size: number?, saveInstanceObjects: boolean?, customColor: ColorSequence | Color3?, customTransparency: NumberSequence | number?, resumesOnVisible: boolean?

-- uiInstance: the object to apply the effect to
-- effectType: the preset to apply
-- speed: the speed of the effect
-- size: the size of the effect
-- saveInstanceObjects: you can keep your own strokes and gradients in your instance by setting this to true, this module will delete them but it will save them and reapply them if :Destroy() is called, default is false
-- customColor: the color of the effect (if needed)
-- customTransparency: the transparency of the effect (if needed)
-- resumesOnVisible: Because of obvious reasons, when an effect is not being shown, it is paused. This boolean decides whether to resume the effect when the uiInstance is shown (if not provided, it will resume on visible)

-- Initializing an effect on an object
local Label = ...
local Effect = TextEffects.new(Label, "RainbowStroke", 0.3, 6)

-- Destroying the Effect
Effect:Destroy()

How to use the Gradient class

local TextEffects = require(...)
local Gradient = TextEffects.Gradient.new(instance, color, transparency);
-- Then we can use the gradient to apply it to an object
Gradient:SetOffsetSpeed(number)
Gradient:SetTransparencyOffsetSpeed(number)
Gradient:SetColor(color)
Gradient:SetTransparencySequence(number or NumberSequence, acceleration)
Gradient:SetRotation(number, acceleration)
Gradient:SetRotationSpeed(number, acceleration)

How to use the Stroke class

local TextEffects = require(...)
local Stroke = TextEffects.Stroke.new(instance, size);
-- Then we can use the stroke to apply it to an object
local StrokeGradient = TextEffects.Gradient.new(Stroke.Instance, color, transparency);
StrokeGradient:SetOffsetSpeed(number)
StrokeGradient:SetTransparencyOffsetSpeed(number)
StrokeGradient:SetTransparency(number, acceleration)
StrokeGradient:SetSize(number, acceleration)
StrokeGradient:SetColor(color, acceleration)

Presets

• RainbowStroke (Applies rainbow and stroke effect)
• Rainbow (Applies rainbow effect)
• Bubblegum (Applies bubblegum effect)
• ChromeStroke (Applies chrome and stroke effect)
• Ghost (Applies ghost effect)
• GhostStroke (Applies ghost and stroke effect)
• Gold (Applies gold effect)
• GoldStroke (Applies gold and stroke effect)
• Lava (Applies lava effect)
• LavaStroke (Applies lava and stroke effect)
• OceanicStroke (Applies oceanic and stroke effect)
• Silver (Applies silver effect)
• SilverStroke (Applies silver and stroke effect)
• Zebra (Applies zebra effect)
• ShineOutline (Applies a shine outline effect)
• More to come...