Skip to main content

GameScalingHelper

Functions

SetAbsoluteSize

GameScalingHelper.SetAbsoluteSize(
absoluteSizeVector2 | _Observable.Observable<Vector2>
) → () → ()

Sets the absolute size of the screen

SetScreenGui

GameScalingHelper.SetScreenGui(
screenGuiScreenGui
) → () → ()

Sets the screenGui to observe the absolute size from

Show raw api
{
    "functions": [
        {
            "name": "SetAbsoluteSize",
            "desc": "Sets the absolute size of the screen",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameScalingHelper"
                },
                {
                    "name": "absoluteSize",
                    "desc": "",
                    "lua_type": "Vector2 | _Observable.Observable<Vector2>\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 91,
                "path": "src/gamescalingutils/src/Client/GameScalingHelper.lua"
            }
        },
        {
            "name": "SetScreenGui",
            "desc": "Sets the screenGui to observe the absolute size from",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "GameScalingHelper"
                },
                {
                    "name": "screenGui",
                    "desc": "",
                    "lua_type": "ScreenGui"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 102,
                "path": "src/gamescalingutils/src/Client/GameScalingHelper.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "GameScalingHelper",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/gamescalingutils/src/Client/GameScalingHelper.lua"
    }
}