Skip to main content

UltrawideContainerUtils

Creates a 1920x1080 scaling container to handle ultrawide monitors and screens in a reasonable way. This helps keep UI centered and available for ultrawide screens.

Functions​

createContainer​

</>
UltrawideContainerUtils.createContainer(
parent: Instance?--

The parent of the container. If nil, it will be set to nil.

) → (
Frame,
UISizeConstraint
)--

The created frame and the UISizeConstraint.

Creates a new container for ultrawide screens. This is a frame with a UISizeConstraint that will scale the UI to 1920x1080.

scaleSizeConstraint​

</>
UltrawideContainerUtils.scaleSizeConstraint(
container: Frame,
uiSizeConstraint: UISizeConstraint,
scale: number
) → ()

Scales the size constraint of the container to the given scale.

Show raw api
{
    "functions": [
        {
            "name": "createContainer",
            "desc": "Creates a new container for ultrawide screens. This is a frame with a UISizeConstraint\nthat will scale the UI to 1920x1080.",
            "params": [
                {
                    "name": "parent",
                    "desc": "The parent of the container. If nil, it will be set to nil.",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "The created frame and the UISizeConstraint.",
                    "lua_type": "(Frame, UISizeConstraint)"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 17,
                "path": "src/ultrawidecontainerutils/src/Client/UltrawideContainerUtils.lua"
            }
        },
        {
            "name": "scaleSizeConstraint",
            "desc": "Scales the size constraint of the container to the given scale.",
            "params": [
                {
                    "name": "container",
                    "desc": "",
                    "lua_type": "Frame"
                },
                {
                    "name": "uiSizeConstraint",
                    "desc": "",
                    "lua_type": "UISizeConstraint"
                },
                {
                    "name": "scale",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/ultrawidecontainerutils/src/Client/UltrawideContainerUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "UltrawideContainerUtils",
    "desc": "Creates a 1920x1080 scaling container to handle ultrawide monitors and screens\nin a reasonable way. This helps keep UI centered and available for ultrawide screens.",
    "source": {
        "line": 7,
        "path": "src/ultrawidecontainerutils/src/Client/UltrawideContainerUtils.lua"
    }
}