This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Documentation/42a4239b50f6490e7458761dfb74588c8bd61af8).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Documentation

Jump to bottom

Ryan edited this page Mar 23, 2023 · [10 revisions](https://github.com/ryanlua/Shime/wiki/Documentation/_history)

# Shime

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject. It behaves similarly to CoreGui's Shimmer module.

## Summary

### Constructors

new(parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject))
Returns a [`table`](https://create.roblox.com/docs/reference/engine/libraries/table) containing `Shimmer`'s metatable. Shimmers using default parameters.
new(parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject), time: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?, style: [`EasingStyle`](https://create.roblox.com/docs/reference/engine/enums/EasingStyle), direction: [`EasingDirection`](https://create.roblox.com/docs/reference/engine/enums/EasingDirection)?, repeatCount: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?, reverses: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans)?, delay: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?)
Returns a [`table`](https://create.roblox.com/docs/reference/engine/libraries/table) containing `Shimmer`'s metatable. Shimmers using specified parameters.

### Properties

Property | Details
IsCompleted: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` has completed.
IsPaused: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` is not playing.
IsPlaying: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` is playing.

### Methods

Stop(): `void`
The Stop function halts `Shimmer`. If `Shimmer:Play()` is called again the `Shimmer` will resume interpolating towards their destination but take the full length of the time to do so.
Pause(): `void`
The Pause function halts `Shimmer`. If you call `Shimmer:Play()` again, the shimmer resumes playback from the moment it was paused.
Play(): `void`
The Play function starts `Shimmer`. Note that if a shimmer has already begun calling Play will have no effect unless the shimmer has finished or has been stopped (either by `Shimmer:Stop()` or `Shimmer:Pause()`).

## Constructors

### new

Creates a new `Shimmer` from the provided parameters.

#### Parameters

Parameter | Details
parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject) |
time: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Default Value: "1"
style: [`EasingStyle`](https://create.roblox.com/docs/reference/engine/enums/EasingStyle) | Default Value: "EasingStyle.Linear"
direction: [`EasingDirection`](https://create.roblox.com/docs/reference/engine/enums/EasingDirection) | Default Value: "EasingDirection.In"
repeatCount: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Default Value: "-1"
reverses: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | Default Value: "false"
delay: [`number`](https://create.roblox.com/docs/scripting/luau/numbers) | Default Value: "0"

## Properties

### IsCompleted [boolean](https://create.roblox.com/docs/scripting/luau/booleans)

`HIDDEN` `READ ONLY` `NOT REPLICATED` `READ PARALLEL`

This read-only property will return true when the `Shimmer` has completed.

This property can only be true when `Shimmer.IsPlaying` is false.

As IsCompleted is read only it can not be used to stop the Shimmer, `Shimmer.Stop()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

### IsPaused [boolean](https://create.roblox.com/docs/scripting/luau/booleans)

`HIDDEN` `READ ONLY` `NOT REPLICATED` `READ PARALLEL`

This read-only property will return true when the `Shimmer` is not playing.

This property can only be true when `Shimmer.IsPlaying` is false.

As IsPaused is read only it can not be used to pause the Shimmer, `Shimmer.Pause()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

### IsPlaying [boolean](https://create.roblox.com/docs/scripting/luau/booleans)

`HIDDEN` `READ ONLY` `NOT REPLICATED` `READ PARALLEL`

This read-only property will return true when the `Shimmer` is playing.

This property can only be true when `Shimmer.IsPaused` is false.

As IsPlaying is read only it can not be used to play the Shimmer, `Shimmer.Play()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

## Methods

### Stop void

Stops the `Shimmer`. Sets `Shimmer.IsPlaying` to false.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

### Pause void

Pauses the `Shimmer`. Sets `Shimmer.IsPlaying` to false.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

### Play void

Plays the `Shimmer`. Sets `Shimmer.IsPlaying` to true.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Documentation/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Documentation/b74bb715f0bddc547ef960e5c7bb6d7b59bf9544).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Documentation

Jump to bottom

Ryan edited this page Mar 24, 2023 · [10 revisions](https://github.com/ryanlua/Shime/wiki/Documentation/_history)

Documentation for the Shime module. Shime is a class that allows you to create a shimmer effect on any GuiObject on Roblox. Based off of Roblox's Shimmer module from CoreGui.

## Summary

### Constructors

new(parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject))
Returns a [`table`](https://create.roblox.com/docs/reference/engine/libraries/table) containing `Shimmer`'s metatable. Shimmers using default parameters.
new(parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject), time: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?, style: [`EasingStyle`](https://create.roblox.com/docs/reference/engine/enums/EasingStyle)?, direction: [`EasingDirection`](https://create.roblox.com/docs/reference/engine/enums/EasingDirection)?, repeatCount: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?, reverses: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans)?, delay: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?)
Returns a [`table`](https://create.roblox.com/docs/reference/engine/libraries/table) containing `Shimmer`'s metatable. Shimmers using specified parameters.

### Properties

Property | Details
IsCompleted: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` has completed.
IsPaused: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` is not playing.
IsPlaying: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` is playing.

### Methods

Stop(): `void`
The Stop function halts `Shimmer`. If `Shimmer:Play()` is called again the `Shimmer` will resume interpolating towards their destination but take the full length of the time to do so.
Pause(): `void`
The Pause function halts `Shimmer`. If you call `Shimmer:Play()` again, the shimmer resumes playback from the moment it was paused.
Play(): `void`
The Play function starts `Shimmer`. Note that if a shimmer has already begun calling Play will have no effect unless the shimmer has finished or has been stopped (either by `Shimmer:Stop()` or `Shimmer:Pause()`).

## Constructors

### new

Creates a new `Shimmer` from the provided parameters.

#### Parameters

Parameter | Details
parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject) |
time: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)? | Default Value: "1"
style: [`EasingStyle`](https://create.roblox.com/docs/reference/engine/enums/EasingStyle)? | Default Value: "EasingStyle.Linear"
direction: [`EasingDirection`](https://create.roblox.com/docs/reference/engine/enums/EasingDirection)? | Default Value: "EasingDirection.In"
repeatCount: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)? | Default Value: "-1"
reverses: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans)? | Default Value: "false"
delay: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)? | Default Value: "0"

## Properties

### IsCompleted

This read-only property will return true when the `Shimmer` has completed.

This property can only be true when `Shimmer.IsPlaying` is false.

As IsCompleted is read only it can not be used to stop the Shimmer, `Shimmer.Stop()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

### IsPaused

This read-only property will return true when the `Shimmer` is not playing.

This property can only be true when `Shimmer.IsPlaying` is false.

As IsPaused is read only it can not be used to pause the Shimmer, `Shimmer.Pause()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

### IsPlaying

This read-only property will return true when the `Shimmer` is playing.

This property can only be true when `Shimmer.IsPaused` is false.

As IsPlaying is read only it can not be used to play the Shimmer, `Shimmer.Play()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

## Methods

### Stop

Stops the `Shimmer`. Sets `Shimmer.IsPlaying` to false.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

### Pause

Pauses the `Shimmer`. Sets `Shimmer.IsPlaying` to false.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

### Play

Plays the `Shimmer`. Sets `Shimmer.IsPlaying` to true.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Documentation/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Documentation/a4fc972d42a30fe97770f61662dd4144a91977c0).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Documentation

Jump to bottom

Ryan edited this page Mar 27, 2023 · [10 revisions](https://github.com/ryanlua/Shime/wiki/Documentation/_history)

Documentation for the Shime module. Shime is a class that allows you to create a shimmer effect on any GuiObject on Roblox. Based off of Roblox's Shimmer module from CoreGui.

## Summary

### Constructors

new(parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject))
Returns a [`table`](https://create.roblox.com/docs/reference/engine/libraries/table) containing `Shimmer`'s metatable. Shimmers using default parameters.
new(parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject), time: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?, style: [`EasingStyle`](https://create.roblox.com/docs/reference/engine/enums/EasingStyle)?, direction: [`EasingDirection`](https://create.roblox.com/docs/reference/engine/enums/EasingDirection)?, repeatCount: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?, reverses: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans)?, delayTime: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)?)
Returns a [`table`](https://create.roblox.com/docs/reference/engine/libraries/table) containing `Shimmer`'s metatable. Shimmers using specified parameters.

### Properties

Property | Details
IsCompleted: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` has completed.
IsPaused: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` is not playing.
IsPlaying: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans) | This read-only property will return true when the `Shimmer` is playing.

### Methods

Stop(): `void`
The Stop function halts `Shimmer`. If `Shimmer:Play()` is called again the `Shimmer` will resume interpolating towards their destination but take the full length of the time to do so.
Pause(): `void`
The Pause function halts `Shimmer`. If you call `Shimmer:Play()` again, the shimmer resumes playback from the moment it was paused.
Play(): `void`
The Play function starts `Shimmer`. Note that if a shimmer has already begun calling Play will have no effect unless the shimmer has finished or has been stopped (either by `Shimmer:Stop()` or `Shimmer:Pause()`).

## Constructors

### new

Creates a new `Shimmer` from the provided parameters.

#### Parameters

Parameter | Details
parent: [`GuiObject`](https://create.roblox.com/docs/reference/engine/classes/GuiObject) |
time: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)? | Default Value: "1"
style: [`EasingStyle`](https://create.roblox.com/docs/reference/engine/enums/EasingStyle)? | Default Value: "EasingStyle.Linear"
direction: [`EasingDirection`](https://create.roblox.com/docs/reference/engine/enums/EasingDirection)? | Default Value: "EasingDirection.In"
repeatCount: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)? | Default Value: "-1"
reverses: [`boolean`](https://create.roblox.com/docs/scripting/luau/booleans)? | Default Value: "false"
delay: [`number`](https://create.roblox.com/docs/scripting/luau/numbers)? | Default Value: "0"

## Properties

### IsCompleted

This read-only property will return true when the `Shimmer` has completed.

This property can only be true when `Shimmer.IsPlaying` is false.

As IsCompleted is read only it can not be used to stop the Shimmer, `Shimmer.Stop()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

### IsPaused

This read-only property will return true when the `Shimmer` is not playing.

This property can only be true when `Shimmer.IsPlaying` is false.

As IsPaused is read only it can not be used to pause the Shimmer, `Shimmer.Pause()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

### IsPlaying

This read-only property will return true when the `Shimmer` is playing.

This property can only be true when `Shimmer.IsPaused` is false.

As IsPlaying is read only it can not be used to play the Shimmer, `Shimmer.Play()` must be used instead.

#### Code Samples

This code sample contains demonstrates when the Shimmer.IsPlaying and Shimmer.IsPaused properties will be true or false.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The IsPlaying and IsPaused properties are then printed to the output.

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Loop shimmers play and pause every 1 second
    while true do
        task.wait(1)
        if shimmer.IsPlaying then
            -- Pause the shimmer and print IsPaused
            shimmer:Pause()
            print("shimmer.IsPaused: " .. tostring(shimmer.IsPaused))
        elseif shimmer.IsPaused then
            -- Play the shimmer and print IsPlaying
            shimmer:Play()
            print("shimmer.IsPlaying: " .. tostring(shimmer.IsPlaying))
        end
    end

## Methods

### Stop

Stops the `Shimmer`. Sets `Shimmer.IsPlaying` to false.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

### Pause

Pauses the `Shimmer`. Sets `Shimmer.IsPlaying` to false.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

### Play

Plays the `Shimmer`. Sets `Shimmer.IsPlaying` to true.

#### Returns

    void

#### Code Samples

This sample gives a simple demonstration of what each of the Shimmer functions (Shimmer.Play, Shimmer.Stop and Shimmer.Pause).

    -- Require the Shime module
    local Shime = require(script.Parent.Shime)

    -- Create a new Shimmer and play it
    local shimmer = Shime.new(script.Parent)
    shimmer:Play()

    -- Pause the Shimmer when the mouse enters the GuiObject
    script.Parent.MouseEnter:Connect(function()
        shimmer:Pause()
    end)

    -- Stop the Shimmer when the mouse leaves the GuiObject
    script.Parent.MouseButton1Click:Connect(function()
        shimmer:Stop()
    end)

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Documentation/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Documentation/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Documentation/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Documentation/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/6b5e24dee25683caafc2fc763821747854d99004).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

FloofyProtoBomb edited this page Mar 16, 2024 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** allows you to easily create a shimmer effect on any GuiObject on Roblox like the example below.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Usage](https://github.com/RyanLua/Shime/wiki/Getting-Started#usage) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/RyanLua/Shime/wiki/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

## Getting Started

You can get started by clicking the links in the sidebar.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/4d5bbf91b0ea15851f485950a96e177fae3e21ad).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page Mar 27, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** is a module that allows you to easily create a shimmer effect on any GuiObject. Shime is used to create a **Shimmer** class that can be used to create a shimmer effect on any GuiObject.

Shimmer may also be used to describe the Roblox's CoreGui Shimmer module.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Usage](https://github.com/ryanlua/Shime/wiki/Home/Usage) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/3deb1d3bf9b50e1966c1dfa5a0c4067f31d32c48).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page Apr 1, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** is a module that allows you to easily create a shimmer effect on any GuiObject. Shime is used to create a **Shimmer** class that can be used to create a shimmer effect on any GuiObject.

Shimmer may also be used to describe the Roblox's CoreGui Shimmer module.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Usage](https://github.com/ryanlua/Shime/wiki/Home/Usage) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/e26e9e1357dba07dad806d7d1a5b095451071045).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page May 21, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** allows you to easily create a shimmer effect on any GuiObject on Roblox like the example below.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Usage](https://github.com/ryanlua/Shime/wiki/Home/Usage) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

## Getting Started

You can get started by clicking the links in the sidebar.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/50971363d1e66e340af7037822d7cdd4422aa17a).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page Mar 21, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the ShimmerClass wiki!

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/8b54c512d73aec766a2aa1995b7f870f5e2d7c43).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

FloofyProtoBomb edited this page Mar 16, 2024 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** allows you to easily create a shimmer effect on any GuiObject on Roblox like the example below.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Getting Started](https://github.com/RyanLua/Shime/wiki/Getting-Started) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/RyanLua/Shime/wiki/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

## Getting Started

You can get started by clicking the links in the sidebar.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/5e523c286b41e05a4ab2cc06a612a8b6245421e1).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page May 6, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** allows you to easily create a shimmer effect on any GuiObject on Roblox.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Usage](https://github.com/ryanlua/Shime/wiki/Home/Usage) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/b297e047be4ebe35660f799f86f5e29f9b2bb19b).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page Mar 23, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki!

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally


This repository was archived by the owner on Aug 20, 2024. It is now read-only.

[ ryanlua ](https://github.com/ryanlua) / ** [Shime](https://github.com/ryanlua/Shime) ** Public archive

  * ### Uh oh!

There was an error while loading. [Please reload this page](https://github.com/ryanlua/Shime/wiki/Home/410eb314e84301f4e5dc9978fbe731adac836120).

  * [ Notifications ](https://github.com/login?return_to=%2Fryanlua%2FShime) You must be signed in to change notification settings
  * [ Fork 1 ](https://github.com/login?return_to=%2Fryanlua%2FShime)
  * [ Star  29 ](https://github.com/login?return_to=%2Fryanlua%2FShime)

# Home

Jump to bottom

Ryan edited this page Apr 2, 2023 · [9 revisions](https://github.com/ryanlua/Shime/wiki/Home/_history)

Welcome to the Shime wiki! Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject just like how Roblox does.

## What is Shime and Shimmer?

**Shime** is a module that allows you to easily create a shimmer effect on any GuiObject. Shime is used to create a **Shimmer** class that can be used to create a shimmer effect on any GuiObject.

Shimmer may also be used to describe the Roblox's CoreGui Shimmer module.

## Why should I use Shime?

Shime is lightweight and opened-sourced, so you can easily modify it to your liking. It also has familar methods such as `Shimmer:Play()` and `Shimmer:Pause()` to control the playback state of the Shimmer, based off the [TweenBase](https://create.roblox.com/docs/reference/engine/classes/TweenBase) class.

Shimmer from Roblox is locked to only CoreGui meaning that normal script can't access it. Shime allows you to create a Shimmer on any GuiObject from any script without needing Roblox Script Security privileges.

## How do I use Shime?

To use Shime, you can visit the [Usage](https://github.com/ryanlua/Shime/wiki/Home/Usage) page to learn how to install Shime. It contains a guide on how to install Shime from GitHub or Roblox and how to use Shime in your scripts. You can also visit the [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation) page to learn more about the Shime and it's constructors, methods, and properties.

# 🎉 Shime is officially released!

Shime has officially been released.

Shime development will be split between normal releases and long term support (LTS) releases. For those seeking stable builds with minor API changes or not worrying about having to update Shime as frequently you can choose the LTS release which will be specifically marked with LTS. For those seeking the lastest stable changes and occasional API changes you can select the normal release.

Shime has added new methods in it's first release from pre-release. These methods include `:GetFrame()` and `:GetGradient()` which will return their respective Instances. Seek documentation for more details.

# Shime Wiki

Shimmer is a class required from the Shime module that allows you to easily create a shimmer effect on any GuiObject based off of CoreGui's Shimmer module.

## [Home](https://github.com/ryanlua/Shime/wiki/Home/Home)

  * [What is Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#what-is-shime)
  * [Why use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#why-use-shime)
  * [How to use Shime?](https://github.com/ryanlua/Shime/wiki/Home/Home#how-to-use-shime)

## [Getting Started](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started)

  * [Installation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#installation)
    * [Install from Roblox](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-roblox)
    * [Install from GitHub](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#install-from-github)
  * [Usage](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#usage)
    * [Creating a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer)
    * [Creating a Shimmer with a Custom Animation](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-animation)
    * [Pausing & Stopping a Shimmer](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#pausing--stopping-a-shimmer)
    * [Reading Shimmer Properties](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#reading-shimmer-properties)
    * [Creating a Shimmer with a Custom Frame and Gradient](https://github.com/ryanlua/Shime/wiki/Home/Getting-Started#creating-a-shimmer-with-a-custom-frame-and-gradient)

## [Documentation](https://github.com/ryanlua/Shime/wiki/Home/Documentation)

  * [Summary](https://github.com/ryanlua/Shime/wiki/Home/Documentation#summary)
    * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors)
    * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties)
    * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods)
  * [Constructors](https://github.com/ryanlua/Shime/wiki/Home/Documentation#constructors-1)
    * [new](https://github.com/ryanlua/Shime/wiki/Home/Documentation#new)
  * [Properties](https://github.com/ryanlua/Shime/wiki/Home/Documentation#properties-1)
    * [PlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#playbackstate)
  * [Methods](https://github.com/ryanlua/Shime/wiki/Home/Documentation#methods-1)
    * [GetFrame](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getframe)
    * [GetPlaybackState](https://github.com/ryanlua/Shime/wiki/Home/Documentation#getplaybackstate)
    * [Stop](https://github.com/ryanlua/Shime/wiki/Home/Documentation#stop)
    * [Pause](https://github.com/ryanlua/Shime/wiki/Home/Documentation#pause)
    * [Play](https://github.com/ryanlua/Shime/wiki/Home/Documentation#play)

### Clone this wiki locally