SlateUI
DocsComponentsGitHub
Install SlateUI Plugin
SlateUI
DocsComponentsGitHub
Install SlateUI Plugin

Components

  • installation
  • components
  • button
  • inputs
  • notification
  • progressbar
  • loading
  • proximity
  • router
  • cutscene
  • effects
  • subtitles
  • cameraplus
Component

ScreenEffectsModule

A powerful screen effects system. Apply blurs, glitches, camera shakes, and color tints with single function calls.

Overview

The Effects module dynamically creates necessary GUI elements (like full-screen frames and ImageLabels) and Lighting instances (BlurEffects) on the fly. It is entirely client-side and automatically handles Z-indexing and cleanup.

Setup

No manual GUI setup is required! The module automatically constructs a ScreenEffectsGui inside the LocalPlayer's PlayerGui the first time an effect is called. It uses RunService.RenderStepped for high-performance visual loops.

Basic Usage

luau
1
2
3
4
5
6
7
8
9
local Effects = require(game.ReplicatedStorage.Effects.ScreenEffectsModule)
 
-- Fade out to black over 2 seconds
Effects:FadeIn(2)
 
task.wait(2)
 
-- Fade back to clear over 2 seconds
Effects:FadeOut(2)

Advanced Usage — Combining Effects

luau
1
2
3
4
5
6
7
8
9
10
11
12
13
local Effects = require(game.ReplicatedStorage.Effects.ScreenEffectsModule)
 
-- Taking damage effect
local function onDamageTaken()
-- Flash red quickly
Effects:Strobe(0.5, Color3.fromRGB(255, 0, 0), 0.1)
-- Shake the screen intensely for 0.3 seconds
Effects:Shake(0.3, 15)
-- Add a short glitch overlay to disorient the player
Effects:Glitch(0.4, 8)
end

API Methods

PropTypeDefaultDescription
Effects:FadeIn(duration)Methodduration: 1Tweens a full-screen black overlay from transparent to opaque.
Effects:FadeOut(duration)Methodduration: 1Tweens the full-screen black overlay from opaque to transparent.
Effects:Blink(duration, color)Methoddur: 1, col: WhiteQuickly fades a colored overlay in and out over the specified duration.
Effects:Glitch(duration, intensity)Methoddur: 0.5, int: 5Overlays a jittering noise texture (rbxassetid://13754189844) over the screen.
Effects:Shake(duration, intensity)Methoddur: 0.5, int: 10Shakes the UI overlay layer randomly. Note: This simulates screen shake via 2D GUI offset, making it safe to use alongside locked 3D cameras.
Effects:Tint(color, duration, intensity)Methoddur: 1, int: 0.5Applies a persistent translucent colored overlay over the screen.
Effects:Flicker(duration, min, max, speed)Methodmin: 0.3, max: 0.7, spd: 0.05Randomly modulates the transparency of a black overlay to simulate a flickering light/camera.
Effects:Strobe(duration, color, speed)Methoddur: 1, col: Red, spd: 0.1Harshly flashes a solid color on and off at a fixed interval. Great for alarms/warnings.
Effects:Blur(intensity, duration)Methodint: 24, dur: 1Tweens a Lighting BlurEffect. Set intensity to 0 to remove the blur.