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/021f812224eb530131b459e128a4b209e6384bb8).

  * [ 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 Apr 7, 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
PlaybackState: [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState) | This read-only property will return [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

### 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

### PlaybackState

This read-only property will return [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

This property is updated when the playback of the Shimmer is updated. This can be caused by a method changing the Shimmer, the Shimmer finishing, etc.

As PlaybackState is read only it can not be used to change the playback of the Shimmer.

#### Code Samples

This code sample contains demonstrates when the Shimmer.PlaybackState property is updated and how to utilize it.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The PlaybackState property is then printed to the output.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.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.PlaybackState == Enum.PlaybackState.Playing then
            -- Pause the shimmer and print PlaybackState
            shimmer:Pause()
            print("shimmer.PlaybackState: " .. tostring(shimmer.PlaybackState))
        elseif shimmer.PlaybackState == Enum.PlaybackState.== Enum.PlaybackState.Playing then
            -- Play the shimmer and print PlaybackState
            shimmer:Play()
            print("shimmer.PlaybackState: " .. tostring(shimmer.PlaybackState))
        end
    end

## Methods

### Stop

Stops the `Shimmer`. Sets `Shimmer.PlaybackState` to [`Enum.PlaybackState.Cancelled`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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.PlaybackState` to [`Enum.PlaybackState.Paused`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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.PlaybackState` to [`Enum.PlaybackState.Playing`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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/e31f7111c01dcdb3e00d62b72018e46b6104896b).

  * [ 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 Apr 7, 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
PlaybackState: [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState) | This read-only property will return [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

### Methods

GetFrame(): [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame)
The GetFrame function returns the [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect. This frame can be customized after the shimmer is created.
GetGradient(): [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient)
The GetGradient function returns the [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect. This gradient can be customized after the shimmer is created.
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

### PlaybackState

This read-only property will return [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

This property is updated when the playback of the Shimmer is updated. This can be caused by a method changing the Shimmer, the Shimmer finishing, etc.

As PlaybackState is read only it can not be used to change the playback of the Shimmer.

#### Code Samples

This code sample contains demonstrates when the Shimmer.PlaybackState property is updated and how to utilize it.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The PlaybackState property is then printed to the output.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.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.PlaybackState == Enum.PlaybackState.Playing then
            -- Pause the shimmer and print PlaybackState
            shimmer:Pause()
            print("shimmer.PlaybackState: " .. tostring(shimmer.PlaybackState))
        elseif shimmer.PlaybackState == Enum.PlaybackState.== Enum.PlaybackState.Playing then
            -- Play the shimmer and print PlaybackState
            shimmer:Play()
            print("shimmer.PlaybackState: " .. tostring(shimmer.PlaybackState))
        end
    end

## Methods

### GetFrame

The GetFrame function returns the [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect. This frame can be customized after the shimmer is created.

#### Returns

    Frame

#### Code Samples

This code sample contains demonstrates how to customize the [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect.

A shimmer is created and played. The [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect is then customized.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.Shime)

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

    -- Customize the Frame that creates the shimmer effect
    local shimmerFrame = shimmer:GetFrame()
    shimmerFrame.BackgroundTransparency = 0.5

### GetGradient

The GetGradient function returns the [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect. This gradient can be customized after the shimmer is created.

#### Returns

    UIGradient

#### Code Samples

This code sample contains demonstrates how to customize the [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect.

A shimmer is created and played. The [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect is then customized.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.Shime)

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

    -- Customize the UIGradient that creates the shimmer effect
    local shimmerGradient = shimmer:GetGradient()
    shimmerGradient.Rotation = 90

### Stop

Stops the `Shimmer`. Sets `Shimmer.PlaybackState` to [`Enum.PlaybackState.Cancelled`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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.PlaybackState` to [`Enum.PlaybackState.Paused`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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.PlaybackState` to [`Enum.PlaybackState.Playing`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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/853949e4a1dd4c23f5a8e02b29d215e74080534a).

  * [ 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/2542d6f8fef985b89f908f76d10ab217b072a837).

  * [ 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)

# Doumentation

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/d711c08789ddcf23c689281dcd20992d129cb152).

  * [ 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 Apr 8, 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
PlaybackState: [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState) | This read-only property will return [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

### Methods

GetFrame(): [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame)
The GetFrame function returns the [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect. This frame can be customized after the shimmer is created.
GetGradient(): [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient)
The GetGradient function returns the [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect. This gradient can be customized after the shimmer is created.
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

### PlaybackState

This read-only property will return [`Enum.PlaybackState`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

This property is updated when the playback of the Shimmer is updated. This can be caused by a method changing the Shimmer, the Shimmer finishing, etc.

As PlaybackState is read only it can not be used to change the playback of the Shimmer.

#### Code Samples

This code sample contains demonstrates when the Shimmer.PlaybackState property is updated and how to utilize it.

A shimmer is created and played. Every 1 second the shimmer is paused then played again. The PlaybackState property is then printed to the output.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.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.PlaybackState == Enum.PlaybackState.Playing then
            -- Pause the shimmer and print PlaybackState
            shimmer:Pause()
            print("shimmer.PlaybackState: " .. tostring(shimmer.PlaybackState))
        elseif shimmer.PlaybackState == Enum.PlaybackState.== Enum.PlaybackState.Playing then
            -- Play the shimmer and print PlaybackState
            shimmer:Play()
            print("shimmer.PlaybackState: " .. tostring(shimmer.PlaybackState))
        end
    end

## Methods

### GetFrame

The GetFrame function returns the [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect. This frame can be customized after the shimmer is created.

#### Returns

    Frame

#### Code Samples

This code sample contains demonstrates how to customize the [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect.

A shimmer is created and played. The [`Frame`](https://create.roblox.com/docs/reference/engine/classes/Frame) that is used to create the shimmer effect is then customized.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.Shime)

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

    -- Customize the Frame that creates the shimmer effect
    local shimmerFrame = shimmer:GetFrame()
    shimmerFrame.BackgroundTransparency = 0.5

### GetGradient

The GetGradient function returns the [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect. This gradient can be customized after the shimmer is created.

#### Returns

    UIGradient

#### Code Samples

This code sample contains demonstrates how to customize the [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect.

A shimmer is created and played. The [`UIGradient`](https://create.roblox.com/docs/reference/engine/classes/UIGradient) that is used to create the shimmer effect is then customized.

    -- Require the Shime module
    local Shime = require(game.ReplicatedStorage.Shime)

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

    -- Customize the UIGradient that creates the shimmer effect
    local shimmerGradient = shimmer:GetGradient()
    shimmerGradient.Rotation = 90

### Stop

Stops the `Shimmer`. Sets `Shimmer.PlaybackState` to [`Enum.PlaybackState.Cancelled`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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.PlaybackState` to [`Enum.PlaybackState.Paused`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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.PlaybackState` to [`Enum.PlaybackState.Playing`](https://create.roblox.com/docs/reference/engine/enums/PlaybackState).

#### 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(game.ReplicatedStorage.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/8e669e6f050b4ff5ba0a2d9ab5f9f93797d98a4d).

  * [ 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)

## 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/be97d661d6f1cc28c4b9b86d372200645d49c184).

  * [ 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 Apr 1, 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(12958292783)

    -- 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(12958292783)

    -- 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(12958292783)

    -- 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(12958292783)

    -- 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(12958292783)

    -- 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(12958292783)

    -- 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/_history).

  * [ 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)

# History

## Revisions

Compare revisions

  * Updated Getting Started (markdown)

[ devbyeagle ](https://github.com/devbyeagle) committed May 22, 2024

4bfc927

  * Updated _Footer (markdown)

[ devbyeagle ](https://github.com/devbyeagle) committed May 22, 2024

f2a4e44

  * Updated _Sidebar (markdown)

[ devbyeagle ](https://github.com/devbyeagle) committed Apr 25, 2024

59a0e6c

  * Replaced Usage with Getting Started.

[ FloofyProtoBomb ](https://github.com/FloofyProtoBomb) committed Mar 16, 2024

8b54c51

  * Fix broken links.

[ FloofyProtoBomb ](https://github.com/FloofyProtoBomb) committed Mar 16, 2024

6b5e24d

  * Fix link

[ ryanlua ](https://github.com/ryanlua) committed Dec 21, 2023

550c5f1

  * Updated Home (markdown)

[ ryanlua ](https://github.com/ryanlua) committed May 21, 2023

e26e9e1

  * Updated Home (markdown)

[ ryanlua ](https://github.com/ryanlua) committed May 6, 2023

5e523c2

  * Updated _Footer (markdown)

[ ryanlua ](https://github.com/ryanlua) committed Apr 23, 2023

ac05ea1

  * Updated Documentation (markdown)

[ ryanlua ](https://github.com/ryanlua) committed Apr 8, 2023

d711c08

  * Updated _Sidebar (markdown)

[ ryanlua ](https://github.com/ryanlua) committed Apr 7, 2023

438856f

  * Add new methods and property

[ ryanlua ](https://github.com/ryanlua) committed Apr 7, 2023

6d583db

  * Add new methods

[ ryanlua ](https://github.com/ryanlua) committed Apr 7, 2023

e31f711

  * Add new methods

[ ryanlua ](https://github.com/ryanlua) committed Apr 7, 2023

021f812

  * Update installation

[ ryanlua ](https://github.com/ryanlua) committed Apr 4, 2023

9d7d481

  * Update installation

[ ryanlua ](https://github.com/ryanlua) committed Apr 4, 2023

00db334

  * Updated to open beta

[ ryanlua ](https://github.com/ryanlua) committed Apr 2, 2023

b29c671

  * Updated Home (markdown)

[ ryanlua ](https://github.com/ryanlua) committed Apr 2, 2023

410eb31

  * Fixed typo

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

9e24cb3

  * Add images

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

3deb1d3

  * Minor changes

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

7214bce

  * Fixed spacing

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

e4db4e1

  * Added new pages

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

75e309c

  * Added images

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

b9e26a0

  * Updated code samples

[ ryanlua ](https://github.com/ryanlua) committed Apr 1, 2023

be97d66

  * Updated Usage (markdown)

[ ryanlua ](https://github.com/ryanlua) committed Mar 29, 2023

da413b6

  * Added usage and installation

[ ryanlua ](https://github.com/ryanlua) committed Mar 27, 2023

0bac255

  * Updated to add Shime home

[ ryanlua ](https://github.com/ryanlua) committed Mar 27, 2023

4d5bbf9

  * Change parameter name for constructor

[ ryanlua ](https://github.com/ryanlua) committed Mar 27, 2023

a4fc972

  * Updated _Sidebar (markdown)

[ ryanlua ](https://github.com/ryanlua) committed Mar 24, 2023

32977c5