Skip to main content

Util

Important utilities for UI development.

Properties​

Colors​

This item is read only and cannot be modified. Read Only
</>
Util.Colors: table

Colors imported from TailwindCSS's color palette.

Functions​

EnsureValue​

</>
Util.EnsureValue(
Scope: Fusion.Scope<any>,
Value: Fusion.UsedAs<any>
) → Fusion.Value<Fusion.Scope<any>,any>

Converts the Value argument to a Fusion.Value object, if it is not one already.

Emphasize​

</>
Util.Emphasize(
Color: Color3,
Emphasis: number
) → Color3

Lightens/darkens the given color, with respect to "true" (perceived) brightness.

Check out ColorUtils for a more comprehensive set of color utilities.

Fallback​

</>
Util.Fallback(
Value: Fusion.UsedAs<any>,
Fallback: any
) → any

Defaults the given Value to Fallback if nil.

CombineProps​

</>
Util.CombineProps(
Source: Fusion.PropertyTable,
Target: Fusion.PropertyTable,
ExcludedKeys: {any}?
) → Fusion.PropertyTable

Combines two sets of props for easy passthrough, adding Source's props to Target. If a prop is already in Target, it will be overridden.

Vector2​

</>
Util.Vector2(
Scope: Fusion.Scope(typeof(Fusion)),
X: Fusion.UsedAs<number>,
Y: Fusion.UsedAs<number>
) → Fusion.Computed<Vector2>

UDim​

</>
Util.UDim(
Scope: Fusion.Scope<typeof(Fusion)>,
Scale: Fusion.UsedAs<number>,
Offset: Fusion.UsedAs<number>
) → Fusion.Computed<UDim>

UDim2​

</>
Util.UDim2(
Scope: Fusion.Scope<typeof(Fusion)>,
XScale: Fusion.UsedAs<number>,
XOffset: Fusion.UsedAs<number>,
YScale: Fusion.UsedAs<number>,
YOffset: Fusion.UsedAs<number>
) → Fusion.Computed<UDim2>

UDim2Offset​

</>
Util.UDim2Offset(
Scope: Fusion.Scope<typeof(Fusion)>,
X: Fusion.UsedAs<number>,
Y: Fusion.UsedAs<number>
) → Fusion.Computed<UDim2>

UDim2Scale​

</>
Util.UDim2Scale(
Scope: Fusion.Scope<typeof(Fusion)>,
X: Fusion.UsedAs<number>,
Y: Fusion.UsedAs<number>
) → Fusion.Computed<UDim2>

Font​

</>
Util.Font(
Scope: Fusion.Scope<typeof(Fusion)>,
X: Fusion.UsedAs<number>,
Y: Fusion.UsedAs<number>
) → Fusion.Computed<UDim2>
Show raw api
{
    "functions": [
        {
            "name": "EnsureValue",
            "desc": "Converts the `Value` argument to a `Fusion.Value` object, if it is not one already.",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope<any>"
                },
                {
                    "name": "Value",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<any>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Value<Fusion.Scope<any>, any>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 11,
                "path": "src/Util/EnsureValue.luau"
            }
        },
        {
            "name": "Emphasize",
            "desc": "Lightens/darkens the given color, with respect to \"true\" (perceived) brightness.\n\nCheck out [ColorUtils](https://github.com/cxmeel/colour-utils) for a more comprehensive set of color utilities.",
            "params": [
                {
                    "name": "Color",
                    "desc": "",
                    "lua_type": "Color3"
                },
                {
                    "name": "Emphasis",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Color3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 13,
                "path": "src/Util/Emphasize.luau"
            }
        },
        {
            "name": "Fallback",
            "desc": "Defaults the given `Value` to `Fallback` if nil.",
            "params": [
                {
                    "name": "Value",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<any>"
                },
                {
                    "name": "Fallback",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 11,
                "path": "src/Util/Fallback.luau"
            }
        },
        {
            "name": "CombineProps",
            "desc": "Combines two sets of props for easy passthrough, adding `Source`'s props to `Target`. If a prop is already in `Target`, it will be overridden.",
            "params": [
                {
                    "name": "Source",
                    "desc": "",
                    "lua_type": "Fusion.PropertyTable"
                },
                {
                    "name": "Target",
                    "desc": "",
                    "lua_type": "Fusion.PropertyTable"
                },
                {
                    "name": "ExcludedKeys",
                    "desc": "",
                    "lua_type": "{ any }?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.PropertyTable"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 12,
                "path": "src/Util/CombineProps.luau"
            }
        },
        {
            "name": "Vector2",
            "desc": "",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope(typeof(Fusion))"
                },
                {
                    "name": "X",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "Y",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Computed<Vector2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 15,
                "path": "src/Util/Unit.luau"
            }
        },
        {
            "name": "UDim",
            "desc": "",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope<typeof(Fusion)>"
                },
                {
                    "name": "Scale",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "Offset",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Computed<UDim>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 34,
                "path": "src/Util/Unit.luau"
            }
        },
        {
            "name": "UDim2",
            "desc": "",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope<typeof(Fusion)>"
                },
                {
                    "name": "XScale",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "XOffset",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "YScale",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "YOffset",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Computed<UDim2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/Util/Unit.luau"
            }
        },
        {
            "name": "UDim2Offset",
            "desc": "",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope<typeof(Fusion)>"
                },
                {
                    "name": "X",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "Y",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Computed<UDim2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 76,
                "path": "src/Util/Unit.luau"
            }
        },
        {
            "name": "UDim2Scale",
            "desc": "",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope<typeof(Fusion)>"
                },
                {
                    "name": "X",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "Y",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Computed<UDim2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 93,
                "path": "src/Util/Unit.luau"
            }
        },
        {
            "name": "Font",
            "desc": "",
            "params": [
                {
                    "name": "Scope",
                    "desc": "",
                    "lua_type": "Fusion.Scope<typeof(Fusion)>"
                },
                {
                    "name": "X",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                },
                {
                    "name": "Y",
                    "desc": "",
                    "lua_type": "Fusion.UsedAs<number>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Fusion.Computed<UDim2>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 110,
                "path": "src/Util/Unit.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Colors",
            "desc": "Colors imported from [TailwindCSS's color palette](https://tailwindcss.com/docs/customizing-colors#default-color-palette).",
            "lua_type": "table",
            "readonly": true,
            "source": {
                "line": 8,
                "path": "src/Util/Colors.luau"
            }
        }
    ],
    "types": [],
    "name": "Util",
    "desc": "Important utilities for UI development.",
    "source": {
        "line": 6,
        "path": "src/Util/init.luau"
    }
}