Skip to main content

UserInterface

UI related methods.

Package Attribute Value
__singleton false
__domain local

Functions​

constrainText​

</>
UserInterface.constrainText(
object: GuiObject,
idealSize: number,
anchor: number
) → ()

Dynamically constrain text based on the AbsoluteSize.Y of any GuiObject with the Text property.

typeWrite​

</>
UserInterface.typeWrite(
instance: GuiObject,
text: string,
step: number?
) → ()

Perform a typewrite effect on any GuiObject with the Text property. This method overrides the previous effect if active.

Show raw api
{
    "functions": [
        {
            "name": "constrainText",
            "desc": "Dynamically constrain text based on the `AbsoluteSize.Y` of any [GuiObject] with the `Text` property.",
            "params": [
                {
                    "name": "object",
                    "desc": "",
                    "lua_type": "GuiObject"
                },
                {
                    "name": "idealSize",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "anchor",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 20,
                "path": "src/essentials/UserInterface.lua"
            }
        },
        {
            "name": "typeWrite",
            "desc": "Perform a typewrite effect on any [GuiObject] with the `Text` property. This method overrides the previous effect if active.",
            "params": [
                {
                    "name": "instance",
                    "desc": "",
                    "lua_type": "GuiObject"
                },
                {
                    "name": "text",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "step",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 34,
                "path": "src/essentials/UserInterface.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "UserInterface",
    "desc": "UI related methods.\n\n| Package Attribute | Value |\n| --- | --- |\n| __singleton | false |\n| __domain | local |",
    "source": {
        "line": 76,
        "path": "src/essentials/UserInterface.lua"
    }
}