Skip to main content

RotatingLabel

A text label with most general properties of a textlabel, except when text is set, it rotates uniformly like an old clock, animating in a satisfying way

``lua RotatingLabelBuilder.new(Template):Create()


:::warning
This API surface is pretty old and probably should not be used.
:::

Properties

Text

RotatingLabel.Text: string

Sets the text label, which it will automatically update

Width

RotatingLabel.Width: number

Sets the general width of each character

Transparency

RotatingLabel.Transparency: number

Sets the transparency

Damper

RotatingLabel.Damper: number

Sets the damper of the underlying spring model

Speed

RotatingLabel.Speed: number

Sets the speed of the underlying spring model

TextXAlignment

RotatingLabel.TextXAlignment: TextXAlignment

Sets the alignment on the X axis. Cannot be Center.

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "Text",
            "desc": "Sets the text label, which it will automatically update",
            "lua_type": "string",
            "source": {
                "line": 117,
                "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
            }
        },
        {
            "name": "Width",
            "desc": "Sets the general width of each character",
            "lua_type": "number",
            "source": {
                "line": 122,
                "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
            }
        },
        {
            "name": "Transparency",
            "desc": "Sets the transparency",
            "lua_type": "number",
            "source": {
                "line": 127,
                "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
            }
        },
        {
            "name": "Damper",
            "desc": "Sets the damper of the underlying spring model",
            "lua_type": "number",
            "source": {
                "line": 132,
                "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
            }
        },
        {
            "name": "Speed",
            "desc": "Sets the speed of the underlying spring model",
            "lua_type": "number",
            "source": {
                "line": 137,
                "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
            }
        },
        {
            "name": "TextXAlignment",
            "desc": "Sets the alignment on the X axis. Cannot be Center.",
            "lua_type": "TextXAlignment",
            "source": {
                "line": 142,
                "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
            }
        }
    ],
    "types": [],
    "name": "RotatingLabel",
    "desc": "A text label with most general properties of a textlabel, except when text is set,\nit rotates uniformly like an old clock, animating in a satisfying way\n\n``lua\nRotatingLabelBuilder.new(Template):Create()\n```\n\n:::warning\nThis API surface is pretty old and probably should not be used.\n:::",
    "source": {
        "line": 15,
        "path": "src/rotatinglabel/src/Client/RotatingLabel.lua"
    }
}