LibCustomGlow

https://github.com/stanzilla/libcustomglow
Admin
LibCustomGlow is a World of Warcraft addon library that provides customizable glow effects for UI...
Tokens:6,160
Snippets:36
Trust Score:9.9
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start Button Glow

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Initializes a Blizzard-style action button glow. Supports custom colors and animation frequency adjustments.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Basic button glow with default golden color
LCG.ButtonGlow_Start(MyButton)

-- Custom colored button glow (red alert)
LCG.ButtonGlow_Start(MyButton, {1, 0.2, 0.2, 1})

-- Full customization with faster animation
LCG.ButtonGlow_Start(
    MyButton,           -- frame: target frame to glow
    {0.2, 0.8, 1, 1},   -- color: {r, g, b, a} or nil for default white
    0.25                -- frequency: animation speed for marching ants (default: 0.125)
)

-- High-visibility green proc alert
LCG.ButtonGlow_Start(ActionButton1, {0.3, 1, 0.3, 1}, 0.2)
```

--------------------------------

### Start Proc Glow

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Creates a modern flipbook-style proc glow. Supports unique keys to manage multiple concurrent glow effects on a single frame.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Basic proc glow with default options
LCG.ProcGlow_Start(MyButton)

-- Proc glow with custom options table
LCG.ProcGlow_Start(MyButton, {
    color = {1, 0.5, 0, 1},    -- Orange color
    startAnim = true,          -- Play intro animation (default: true)
    duration = 0.8,            -- Loop duration in seconds (default: 1)
    key = "proc1"              -- Unique key for multiple glows
})

-- Full options example
LCG.ProcGlow_Start(MyButton, {
    frameLevel = 8,            -- Frame strata offset (default: 8)
    color = nil,               -- nil for default white/gold color
    startAnim = false,         -- Skip intro, go straight to loop
    xOffset = 0,               -- Horizontal offset
    yOffset = 0,               -- Vertical offset
    duration = 1.2,            -- Slower animation loop
    key = "mainProc"           -- Identifier key
})

-- Multiple proc glows with different keys
LCG.ProcGlow_Start(MyButton, { color = {1, 0, 0, 1}, key = "fire" })
LCG.ProcGlow_Start(MyButton, { color = {0, 0.5, 1, 1}, key = "frost", startAnim = false })
```

--------------------------------

### Start Pixel Glow Effect

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Initializes an animated border glow around a frame. Use the key parameter to manage multiple concurrent glows on the same frame.

```lua
-- Get the library
local LCG = LibStub("LibCustomGlow-1.0")

-- Basic pixel glow with default yellow color
LCG.PixelGlow_Start(MyButton)

-- Custom red glow with 12 lines
LCG.PixelGlow_Start(MyButton, {1, 0, 0, 1}, 12)

-- Full customization: blue glow, 8 lines, fast animation, custom length and thickness
LCG.PixelGlow_Start(
    MyButton,           -- frame: target frame to glow
    {0, 0.5, 1, 1},     -- color: {r, g, b, a} values from 0 to 1
    8,                  -- N: number of lines (default: 8)
    0.5,                -- frequency: animation speed, negative reverses direction (default: 0.25)
    10,                 -- length: line length in pixels (default: auto-calculated)
    2,                  -- th: line thickness (default: 2)
    2,                  -- xOffset: horizontal offset from frame border
    2,                  -- yOffset: vertical offset from frame border
    true,               -- border: show dark background border (default: true)
    "myGlow"            -- key: unique identifier for multiple glows on same frame
)

-- Multiple glows on the same frame using different keys
LCG.PixelGlow_Start(MyButton, {1, 0, 0, 1}, 8, 0.25, nil, 2, 0, 0, true, "alert")
LCG.PixelGlow_Start(MyButton, {0, 1, 0, 1}, 4, -0.5, nil, 1, 4, 4, false, "secondary")
```

--------------------------------

### Start AutoCast Glow Effect

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Creates a particle-based orbiting glow effect. Supports customization of particle groups, rotation speed, and scale.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Basic autocast glow with default settings
LCG.AutoCastGlow_Start(MyButton)

-- Purple autocast glow with more particles
LCG.AutoCastGlow_Start(MyButton, {0.8, 0.2, 1, 1}, 6)

-- Full customization
LCG.AutoCastGlow_Start(
    MyButton,           -- frame: target frame to glow
    {0.95, 0.95, 0.32, 1}, -- color: {r, g, b, a} (default: yellow)
    4,                  -- N: number of particle groups, each has 4 particles (default: 4)
    0.125,              -- frequency: rotation speed, negative reverses (default: 0.125)
    1.5,                -- scale: particle size multiplier (default: 1)
    0,                  -- xOffset: horizontal offset from border
    0,                  -- yOffset: vertical offset from border
    "shine"             -- key: unique identifier for multiple glows
)

-- Large, slow-moving green particles
LCG.AutoCastGlow_Start(MyButton, {0, 1, 0.5, 0.8}, 8, 0.05, 2, 0, 0, "nature")
```

--------------------------------

### ProcGlow_Start

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Creates a modern flipbook-style proc glow effect using WoW's HUD action bar proc animations.

```APIDOC
## ProcGlow_Start

### Description
Displays an animated flipbook texture that loops continuously, with an optional dramatic start animation.

### Parameters
- **frame** (table) - Required - The target frame.
- **options** (table) - Optional - A table containing: color, startAnim (boolean), duration (number), key (string), frameLevel (number), xOffset (number), yOffset (number).

### Request Example
LCG.ProcGlow_Start(MyButton, { color = {1, 0.5, 0, 1}, duration = 0.8, key = "proc1" })
```

--------------------------------

### ButtonGlow_Start

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Creates a Blizzard-style action button glow effect with animated spark, inner glow, outer glow, and marching ants border.

```APIDOC
## ButtonGlow_Start

### Description
Creates a Blizzard-style action button glow effect with animated spark, inner glow, outer glow, and marching ants border. This replicates the spell activation overlay effect.

### Parameters
- **frame** (table) - Required - The target frame to apply the glow to.
- **color** (table) - Optional - A table containing {r, g, b, a} values. Defaults to white.
- **frequency** (number) - Optional - Animation speed for marching ants. Defaults to 0.125.

### Request Example
LCG.ButtonGlow_Start(MyButton, {0.2, 0.8, 1, 1}, 0.25)
```

--------------------------------

### ButtonGlow Functions

Source: https://github.com/stanzilla/libcustomglow/blob/master/README.md

Functions to initiate and terminate Blizzard-style button glow effects on a frame.

```lua
ButtonGlow_Start(frame[, color[, frequency]]])
```

```lua
ButtonGlow_Stop(frame)
```

--------------------------------

### Accessing Glow Types and Dynamic Control

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Iterate through available glow types and use the start/stop lists for dynamic effect management. Ensure the corresponding stop function is called to clean up resources.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Available glow types in lib.glowList:
-- "Pixel Glow", "Autocast Shine", "Action Button Glow", "Proc Glow"

-- Iterate available glow types for a dropdown menu
for _, glowName in ipairs(LCG.glowList) do
    print("Available glow type:", glowName)
end

-- Start a glow by name dynamically
local glowType = "Pixel Glow"  -- From user settings
local startFunc = LCG.startList[glowType]
local stopFunc = LCG.stopList[glowType]

if startFunc then
    startFunc(MyButton, {1, 0.8, 0, 1})  -- Start with color
end

-- Later, stop it
if stopFunc then
    stopFunc(MyButton)
end

-- Example: Configuration-driven glow system
local function ApplyGlow(frame, settings)
    local startFunc = LCG.startList[settings.glowType]
    if startFunc then
        if settings.glowType == "Proc Glow" then
            startFunc(frame, { color = settings.color, duration = settings.speed })
        else
            startFunc(frame, settings.color, settings.lines, settings.speed)
        end
    end
end
```

--------------------------------

### AutoCast Glow Functions

Source: https://github.com/stanzilla/libcustomglow/blob/master/README.md

Functions to initiate and terminate particle-based auto-cast glow effects on a frame.

```lua
AutoCastGlow_Start(frame[, color[, N[, frequency[, scale[, xOffset[, yOffset[, key]]]]]]])
```

```lua
AutoCastGlow_Stop(frame[, key])
```

--------------------------------

### Pixel Glow Functions

Source: https://github.com/stanzilla/libcustomglow/blob/master/README.md

Functions to initiate and terminate pixel-based glow effects on a frame.

```lua
PixelGlow_Start(frame[, color[, N[, frequency[, length[, th[, xOffset[, yOffset[, border[ ,key]]]]]]]]])
```

```lua
PixelGlow_Stop(frame[, key])
```

--------------------------------

### ButtonGlow Functions

Source: https://github.com/stanzilla/libcustomglow/blob/master/README.md

Functions to manage standard button glow effects.

```APIDOC
## ButtonGlow_Start

### Description
Starts a standard button glow effect over the target frame.

### Parameters
- **frame** (frame) - Required - Target frame to set glowing
- **color** (table) - Optional - {r,g,b,a} color and opacity (0-1). Default: {0.95, 0.95, 0.32, 1}
- **frequency** (number) - Optional - Frequency. Default: 0.125

## ButtonGlow_Stop

### Description
Stops the button glow effect on the target frame.

### Parameters
- **frame** (frame) - Required - Target frame
```

--------------------------------

### AutoCast Glow API

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Functions for creating and removing particle-based autocast glows.

```APIDOC
## AutoCast Glow Start

### Description
Creates a particle-based glow effect similar to the autocast shine animation on pet ability buttons. This effect displays multiple groups of particles that orbit around the frame perimeter at varying speeds, creating a shimmering border effect.

### Method
`LCG.AutoCastGlow_Start(frame, color, N, frequency, scale, xOffset, yOffset, key)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **frame** (frame) - Required - The target frame to apply the glow to.
- **color** (table) - Optional - {r, g, b, a} values from 0 to 1. Defaults to yellow.
- **N** (number) - Optional - Number of particle groups, each has 4 particles. Defaults to 4.
- **frequency** (number) - Optional - Rotation speed, negative reverses direction. Defaults to 0.125.
- **scale** (number) - Optional - Particle size multiplier. Defaults to 1.
- **xOffset** (number) - Optional - Horizontal offset from border. Defaults to 0.
- **yOffset** (number) - Optional - Vertical offset from border. Defaults to 0.
- **key** (string) - Optional - Unique identifier for multiple glows on the same frame.

### Request Example
```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Basic autocast glow with default settings
LCG.AutoCastGlow_Start(MyButton)

-- Purple autocast glow with more particles
LCG.AutoCastGlow_Start(MyButton, {0.8, 0.2, 1, 1}, 6)

-- Full customization
LCG.AutoCastGlow_Start(
    MyButton,           -- frame: target frame to glow
    {0.95, 0.95, 0.32, 1}, -- color: {r, g, b, a} (default: yellow)
    4,                  -- N: number of particle groups, each has 4 particles (default: 4)
    0.125,              -- frequency: rotation speed, negative reverses (default: 0.125)
    1.5,                -- scale: particle size multiplier (default: 1)
    0,                  -- xOffset: horizontal offset from border
    0,                  -- yOffset: vertical offset from border
    "shine"             -- key: unique identifier for multiple glows
)

-- Large, slow-moving green particles
LCG.AutoCastGlow_Start(MyButton, {0, 1, 0.5, 0.8}, 8, 0.05, 2, 0, 0, "nature")
```

## AutoCast Glow Stop

### Description
Stops and removes an autocast glow effect from a frame. Supports keyed glows for selective removal.

### Method
`LCG.AutoCastGlow_Stop(frame, key)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **frame** (frame) - Required - The target frame to remove the glow from.
- **key** (string) - Optional - The unique identifier of the glow to remove. If omitted, the default glow is removed.

### Request Example
```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Stop the default autocast glow
LCG.AutoCastGlow_Stop(MyButton)

-- Stop a specific keyed glow
LCG.AutoCastGlow_Stop(MyButton, "shine")
```
```

--------------------------------

### AutoCast Glow Functions

Source: https://github.com/stanzilla/libcustomglow/blob/master/README.md

Functions to manage AutoCast particle glow effects on UI frames.

```APIDOC
## AutoCastGlow_Start

### Description
Starts an AutoCast particle glow effect over the target frame.

### Parameters
- **frame** (frame) - Required - Target frame to set glowing
- **color** (table) - Optional - {r,g,b,a} color and opacity (0-1). Default: {0.95, 0.95, 0.32, 1}
- **N** (number) - Optional - Number of particle groups. Default: 4
- **frequency** (number) - Optional - Frequency of rotation. Default: 0.125
- **scale** (number) - Optional - Scale of particles
- **xOffset** (number) - Optional - X offset relative to border
- **yOffset** (number) - Optional - Y offset relative to border
- **key** (string) - Optional - Unique key for multiple glows

## AutoCastGlow_Stop

### Description
Stops a specific AutoCast glow effect on the target frame.

### Parameters
- **frame** (frame) - Required - Target frame
- **key** (string) - Optional - Key of the glow to stop
```

--------------------------------

### Pixel Glow API

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Functions for creating and removing animated pixel border glows.

```APIDOC
## Pixel Glow Start

### Description
Creates an animated border glow effect around a frame using rotating line segments. This glow style draws colored lines that animate around the perimeter of the target frame, creating a dynamic border effect. The function supports customization of line count, color, animation speed, thickness, and optional background border.

### Method
`LCG.PixelGlow_Start(frame, color, N, frequency, length, th, xOffset, yOffset, border, key)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **frame** (frame) - Required - The target frame to apply the glow to.
- **color** (table) - Optional - {r, g, b, a} values from 0 to 1. Defaults to yellow.
- **N** (number) - Optional - Number of lines. Defaults to 8.
- **frequency** (number) - Optional - Animation speed, negative reverses direction. Defaults to 0.25.
- **length** (number) - Optional - Line length in pixels. Defaults to auto-calculated.
- **th** (number) - Optional - Line thickness. Defaults to 2.
- **xOffset** (number) - Optional - Horizontal offset from frame border. Defaults to 0.
- **yOffset** (number) - Optional - Vertical offset from frame border. Defaults to 0.
- **border** (boolean) - Optional - Show dark background border. Defaults to true.
- **key** (string) - Optional - Unique identifier for multiple glows on the same frame.

### Request Example
```lua
-- Get the library
local LCG = LibStub("LibCustomGlow-1.0")

-- Basic pixel glow with default yellow color
LCG.PixelGlow_Start(MyButton)

-- Custom red glow with 12 lines
LCG.PixelGlow_Start(MyButton, {1, 0, 0, 1}, 12)

-- Full customization: blue glow, 8 lines, fast animation, custom length and thickness
LCG.PixelGlow_Start(
    MyButton,           -- frame: target frame to glow
    {0, 0.5, 1, 1},     -- color: {r, g, b, a} values from 0 to 1
    8,                  -- N: number of lines (default: 8)
    0.5,                -- frequency: animation speed, negative reverses direction (default: 0.25)
    10,                 -- length: line length in pixels (default: auto-calculated)
    2,                  -- th: line thickness (default: 2)
    2,                  -- xOffset: horizontal offset from frame border
    2,                  -- yOffset: vertical offset from frame border
    true,               -- border: show dark background border (default: true)
    "myGlow"            -- key: unique identifier for multiple glows on same frame
)

-- Multiple glows on the same frame using different keys
LCG.PixelGlow_Start(MyButton, {1, 0, 0, 1}, 8, 0.25, nil, 2, 0, 0, true, "alert")
LCG.PixelGlow_Start(MyButton, {0, 1, 0, 1}, 4, -0.5, nil, 1, 4, 4, false, "secondary")
```

## Pixel Glow Stop

### Description
Stops and removes a pixel glow effect from a frame. When called with a key, only removes the glow matching that key, allowing other glows on the same frame to continue.

### Method
`LCG.PixelGlow_Stop(frame, key)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **frame** (frame) - Required - The target frame to remove the glow from.
- **key** (string) - Optional - The unique identifier of the glow to remove. If omitted, the default glow is removed.

### Request Example
```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Stop the default pixel glow
LCG.PixelGlow_Stop(MyButton)

-- Stop a specific keyed glow
LCG.PixelGlow_Stop(MyButton, "alert")
LCG.PixelGlow_Stop(MyButton, "secondary")
```
```

--------------------------------

### Register Custom Textures

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Registers custom textures for use within glow effects. This allows for extending the library with custom assets.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Register a custom texture with an identifier
LCG.RegisterTextures([[Interface\AddOns\MyAddon\Textures\CustomGlow]], "myCustomTex")

-- The library uses these built-in textures:
-- "empty" - Interface\AdventureMap\BrokenIsles\AM_29
-- "white" - Interface\BUTTONS\WHITE8X8
-- "shine" - Interface\ItemSocketingFrame\UI-ItemSockets (or Artifacts texture on retail)
```

--------------------------------

### Pixel Glow Functions

Source: https://github.com/stanzilla/libcustomglow/blob/master/README.md

Functions to manage Pixel Glow effects on UI frames.

```APIDOC
## PixelGlow_Start

### Description
Starts a pixel-style glow effect over the target frame.

### Parameters
- **frame** (frame) - Required - Target frame to set glowing
- **color** (table) - Optional - {r,g,b,a} color and opacity (0-1). Default: {0.95, 0.95, 0.32, 1}
- **N** (number) - Optional - Number of lines. Default: 8
- **frequency** (number) - Optional - Frequency of rotation. Default: 0.25
- **length** (number) - Optional - Length of lines
- **th** (number) - Optional - Thickness of lines. Default: 2
- **xOffset** (number) - Optional - X offset relative to border
- **yOffset** (number) - Optional - Y offset relative to border
- **border** (boolean) - Optional - Create border under lines
- **key** (string) - Optional - Unique key for multiple glows

## PixelGlow_Stop

### Description
Stops a specific pixel glow effect on the target frame.

### Parameters
- **frame** (frame) - Required - Target frame
- **key** (string) - Optional - Key of the glow to stop
```

--------------------------------

### RegisterTextures

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Registers a custom texture that can be used by glow effects.

```APIDOC
## RegisterTextures

### Description
Registers a custom texture path with an identifier to extend the library with custom assets.

### Parameters
- **path** (string) - Required - The file path to the texture.
- **identifier** (string) - Required - The name to register the texture under.

### Request Example
LCG.RegisterTextures([[Interface\AddOns\MyAddon\Textures\CustomGlow]], "myCustomTex")
```

--------------------------------

### Stop Proc Glow

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Removes a proc glow effect from a frame. Use the key parameter to target specific effects.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Stop default proc glow
LCG.ProcGlow_Stop(MyButton)

-- Stop specific keyed proc glow
LCG.ProcGlow_Stop(MyButton, "fire")
LCG.ProcGlow_Stop(MyButton, "frost")
```

--------------------------------

### Stop Pixel Glow Effect

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Removes a pixel glow effect from a frame. Specify a key to remove only a specific glow instance.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Stop the default pixel glow
LCG.PixelGlow_Stop(MyButton)

-- Stop a specific keyed glow
LCG.PixelGlow_Stop(MyButton, "alert")
LCG.PixelGlow_Stop(MyButton, "secondary")
```

--------------------------------

### ProcGlow_Stop

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Stops and removes a proc glow effect from a frame.

```APIDOC
## ProcGlow_Stop

### Description
Stops and removes a proc glow effect from a frame. Supports keyed glows for selective removal.

### Parameters
- **frame** (table) - Required - The target frame.
- **key** (string) - Optional - The unique identifier key for the specific glow to stop.

### Request Example
LCG.ProcGlow_Stop(MyButton, "fire")
```

--------------------------------

### Stop Button Glow

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Stops a button glow effect with a smooth fade-out. Note that button glows do not support multiple keys per frame.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Stop button glow with fade-out animation
LCG.ButtonGlow_Stop(MyButton)

-- Example: Toggle glow on button click
MyButton:SetScript("OnClick", function(self)
    if self.isGlowing then
        LCG.ButtonGlow_Stop(self)
        self.isGlowing = false
    else
        LCG.ButtonGlow_Start(self, {1, 0.8, 0, 1})
        self.isGlowing = true
    end
end)
```

--------------------------------

### ButtonGlow_Stop

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Stops a button glow effect with a smooth fade-out animation.

```APIDOC
## ButtonGlow_Stop

### Description
Stops a button glow effect with a smooth fade-out animation. Note: Button glow does not support multiple keys per frame.

### Parameters
- **frame** (table) - Required - The target frame to stop the glow on.

### Request Example
LCG.ButtonGlow_Stop(MyButton)
```

--------------------------------

### Stop AutoCast Glow Effect

Source: https://context7.com/stanzilla/libcustomglow/llms.txt

Removes an autocast glow effect from a frame. Use the key parameter to target specific effects.

```lua
local LCG = LibStub("LibCustomGlow-1.0")

-- Stop the default autocast glow
LCG.AutoCastGlow_Stop(MyButton)

-- Stop a specific keyed glow
LCG.AutoCastGlow_Stop(MyButton, "shine")
```
Tokens:
Raw