Skip to main content

colorSequenceUtil

A simple utility module for working with color sequences.

Functions​

colorFromKeyPointsPercentage​

</>
colorSequenceUtil.colorFromKeyPointsPercentage(
percentage: number,
colorSequenceKeyPoints: {ColorSequenceKeypoint}
) → ()

Returns a color based on where the percentage lies in the specified color sequence key points. (Credits; ToldFable)

Show raw api
{
    "functions": [
        {
            "name": "colorFromKeyPointsPercentage",
            "desc": " \nReturns a color based on where the percentage lies in the specified color sequence key points.\n(Credits; ToldFable)",
            "params": [
                {
                    "name": "percentage",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "colorSequenceKeyPoints",
                    "desc": "",
                    "lua_type": "{ ColorSequenceKeypoint }\n"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 13,
                "path": "src/colorSequenceUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "colorSequenceUtil",
    "desc": " \n\nA simple utility module for working with color sequences.",
    "source": {
        "line": 6,
        "path": "src/colorSequenceUtil/init.luau"
    }
}