Skip to main content

UIPaddingUtils

Utility functions for UI padding

Functions​

fromUDim​

</>
UIPaddingUtils.fromUDim(udim: UDim) → UIPadding

Constructs a new UIPadding from a UDim

getTotalPadding​

</>
UIPaddingUtils.getTotalPadding(uiPadding: UIPadding) → UDim2

Compute the total padding for the UIPadding

getTotalAbsolutePadding​

</>
UIPaddingUtils.getTotalAbsolutePadding(
uiPadding: UIPadding,
absoluteSize: Vector2
) → Vector2

Computes the total absolute padding for a UIPadding

getHorizontalPadding​

</>
UIPaddingUtils.getHorizontalPadding(uiPadding: UIPadding) → UDim

Compute the horizontal Padding

Show raw api
{
    "functions": [
        {
            "name": "fromUDim",
            "desc": "Constructs a new UIPadding from a UDim",
            "params": [
                {
                    "name": "udim",
                    "desc": "",
                    "lua_type": "UDim"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "UIPadding\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 12,
                "path": "src/uiobjectutils/src/Client/UIPaddingUtils.lua"
            }
        },
        {
            "name": "getTotalPadding",
            "desc": "Compute the total padding for the UIPadding",
            "params": [
                {
                    "name": "uiPadding",
                    "desc": "",
                    "lua_type": "UIPadding"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "UDim2\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/uiobjectutils/src/Client/UIPaddingUtils.lua"
            }
        },
        {
            "name": "getTotalAbsolutePadding",
            "desc": "Computes the total absolute padding for a UIPadding",
            "params": [
                {
                    "name": "uiPadding",
                    "desc": "",
                    "lua_type": "UIPadding"
                },
                {
                    "name": "absoluteSize",
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/uiobjectutils/src/Client/UIPaddingUtils.lua"
            }
        },
        {
            "name": "getHorizontalPadding",
            "desc": "Compute the horizontal Padding",
            "params": [
                {
                    "name": "uiPadding",
                    "desc": "",
                    "lua_type": "UIPadding"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "UDim\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 43,
                "path": "src/uiobjectutils/src/Client/UIPaddingUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "UIPaddingUtils",
    "desc": "Utility functions for UI padding",
    "source": {
        "line": 6,
        "path": "src/uiobjectutils/src/Client/UIPaddingUtils.lua"
    }
}