Skip to main content

guiObjectFadeUtil

A utility which implements fading in and out without dealing with issues like having an object specific transparency value rather than 0 - 1.

Functions​

fadeIn​

</>
guiObjectFadeUtil.fadeIn(
guiObject: GuiObject,
fadeTime: number
) → ()

Fades in the given guiObject.

fadeOut​

</>
guiObjectFadeUtil.fadeOut(
guiObject: GuiObject,
fadeTime: number,
override: number?
) → ()

Fades out the given guiObject.

Show raw api
{
    "functions": [
        {
            "name": "fadeIn",
            "desc": " \nFades in the given `guiObject`.",
            "params": [
                {
                    "name": "guiObject",
                    "desc": "",
                    "lua_type": "GuiObject"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 47,
                "path": "src/guiObjectFadeUtil/init.luau"
            }
        },
        {
            "name": "fadeOut",
            "desc": " \nFades out the given `guiObject`.",
            "params": [
                {
                    "name": "guiObject",
                    "desc": "",
                    "lua_type": "GuiObject"
                },
                {
                    "name": "fadeTime",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "override",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 127,
                "path": "src/guiObjectFadeUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "guiObjectFadeUtil",
    "desc": "A utility which implements fading in and out without dealing with issues like having an object\nspecific transparency value rather than `0` - `1`.",
    "source": {
        "line": 7,
        "path": "src/guiObjectFadeUtil/init.luau"
    }
}