Skip to main content

Fade

Collection of fading utilities

Properties​

delay​

</>
Fade.delay: number

Get/Set the time delay between different iterations of a fade

Functions​

time​

</>
Fade.time(
duration: number,--

duration of fade (s)

event: (t: number) → bool,--

fading function

time_func: () → number | nil--

optional time function

) → ()

Fade a function over time

Guaranteed to end with t=0.

Fade.time(1, function(t)
    Player.health = 1 - t
end)

scale​

experimental
</>
Fade.scale(
scale: () → number,--

scaling function

event: (t: number) → bool--

fading function

) → ()

Fades a function over a scaling function

Show raw api
{
    "functions": [
        {
            "name": "time",
            "desc": "Fade a function over time\n\nGuaranteed to end with `t=0`.\n\n```lua\nFade.time(1, function(t)\n    Player.health = 1 - t\nend)\n```",
            "params": [
                {
                    "name": "duration",
                    "desc": "duration of fade (s)",
                    "lua_type": "number"
                },
                {
                    "name": "event",
                    "desc": "fading function",
                    "lua_type": "(t: number) -> bool"
                },
                {
                    "name": "time_func",
                    "desc": "optional time function",
                    "lua_type": "() -> number | nil"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 28,
                "path": "../../res/data/script/lib/env/fade.lua"
            }
        },
        {
            "name": "scale",
            "desc": "Fades a function over a scaling function",
            "params": [
                {
                    "name": "scale",
                    "desc": "scaling function",
                    "lua_type": "() -> number"
                },
                {
                    "name": "event",
                    "desc": "fading function",
                    "lua_type": "(t: number) -> bool"
                }
            ],
            "returns": [],
            "function_type": "static",
            "tags": [
                "experimental"
            ],
            "source": {
                "line": 66,
                "path": "../../res/data/script/lib/env/fade.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "delay",
            "desc": "Get/Set the time delay between different iterations of a fade",
            "lua_type": "number",
            "source": {
                "line": 12,
                "path": "../../res/data/script/lib/env/fade.lua"
            }
        }
    ],
    "types": [],
    "name": "Fade",
    "desc": "Collection of fading utilities",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/env/fade.lua"
    }
}