ApiEffectProfile
Class Description
Section titled “Class Description”A visual effect composition: which layers, in what order, blended how, plus how it arrives and leaves and what it shakes.
Get an editable copy of one the client already has with API.VisualEffects.GetProfile, or start
from nothing with API.VisualEffects.NewProfile. Either way it is yours: nothing a script passes
is ever saved, and editing this after API.VisualEffects.Start cannot reach the running effect.
Properties
Section titled “Properties”Type: string
Only ever used in log messages for a script-built composition.
FullScreen
Section titled “FullScreen”Type: bool
Whether this covers the whole window rather than the game world alone. Governs both halves of
scope: which pass draws the layers, and which rectangle Shake displaces.
Leave it off unless the effect really is meant to cover the gumps and the cursor - doing so makes the UI hard to use for as long as the effect lasts.
Layers
Section titled “Layers”Type: IList<ApiProfileLayer>
Back to front: index 0 is drawn first and ends up underneath. At most 4.
Type: ApiFadeSpec?
How the effect arrives and leaves. Starts at the client’s own timing.
Type: ApiShakeSpec?
Screen shake the effect includes, fired once on arrival, or null for a purely
visual one. Build one with API.VisualEffects.NewShakeSpec.
No fields found.
No enums found.
Methods
Section titled “Methods”AddLayer
Section titled “AddLayer”(effect, blend)
Appends a layer, which is the usual way to build a composition up. At most 4, and each one is a
full-screen pass per frame while the effect runs.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
effect | ApiLayerEffect | ❌ No | The layer to draw. |
blend | ApiVisualEffects.OverlayBlend | ✅ Yes | How it composites against what is already beneath it. |
Return Type: ApiProfileLayer - The wrapper that was added, so the blend can be changed later.