Attributes

Used by the plugin & module as custom properties that specify how the VFX should play

Name	Definition
Effect	Beam, Trail, Particle, Lights, ..
VFXContainer	BasePart, Folder, Attachment, ..

Global attributes (used on all types):

Attribute	Type	Description
EmitDelay	number|NumberRange	The delay which after, the vfx emits (plays)
EmitDuration	number|NumberRange	When emitted, the vfx gets enabled for this duration
ResetOnFinish	boolean	Tells add-ons & module to reset VFX when finished
Clone	boolean	Will clone the vfx and emit/enable the clone instead
EmitRepeat	number|NumberRange	Number of repeats when VFX is emitted (-1 = inf)
EmitRepeatDelay	number|NumberRange	The delay between repeats (can be random)

Tween attributes (only on effects)

Attribute	Type	Description
TweenIn	number|NumberRange	TweenIn time when an Effect is enabled
TweenOut	number|NumberRange	TweenIn time when an Effect is disabled
TweenProperties	string?	The properties to tween seperated by a ,

Tween attributes cause an Effect to be .enable()d when emitted just like EmitDuration

How to use

Attributes are normally applied to Effects, but they can also be applied to VFXContainers- by disabling the setting Set descendants' attributes or pressing Y to easily switch modes

Color Attribute

Attributes named Color on any VFX instance will be recolored automatically by .recolor and sliders This will be useful in cases like making an emittable script with a Color attribute like this Vignette

https://cdn.discordapp.com/attachments/1454585621376012288/1454585622416068693/Vignette.mp4?ex=69563d2d&hm=ee66c01ebf86a66ac3c0ae1eda34e812576bee62dc557c733805f2a68a08fd02&is=6954ebadcdn.discordapp.com

This vignette script is open-source and can be found in the discord server

Loops

Loops happen when EmitRepeat is -1 which will make the VFX repeat until .disable()'d As you can see in the vignette video above, the script has -1 repeat and is enabled, Thats why it keeps emitting (executing) the script every EmitRepeatDelay (until disabled)

Randomizing

Most of these attributes can be randomized by typing min-max (from min to max) This will turn them into a NumberRange which the module uses to randomize attributes

Custom Attributes

You can make and use custom attributes in 2 ways

1

Add-ons

Add-ons can make their own attributes and make a UI for it using the UI-Library - Learn more at Create Add-ons

2

Emittable scripts

Emittable scripts can use attributes with script:GetAttributes() or using the cached table

EmittableScriptExample

local Service = game:GetService("WhateverService") -- dependencies

return function(attributes, isRepeating)
     Vignette.ImageColor = attributes.Color
end -- returning a function is required if the script emits more than once