Skip to main content

basePartSizeUtil

A utility module for resizing base parts on specific axes.

Functions​

resizeOnXAxis​

</>
basePartSizeUtil.resizeOnXAxis(
basePart: BasePart,
newSizeX: number,
tweenInfo: TweenInfo?
) → Promise?

Resizes the given basePart's Size's X to newSizeX. If tweenInfo is specified, then a promise is returned which is resolved once the operation is successful.

resizeOnYAxis​

</>
basePartSizeUtil.resizeOnYAxis(
basePart: BasePart,
newSizeY: number,
tweenInfo: TweenInfo?
) → Promise?

Resizes the given basePart's Size's Y to newSizeY. If tweenInfo is specified, then a promise is returned which is resolved once the operation is successful.

resizeOnZAxis​

</>
basePartSizeUtil.resizeOnZAxis(
basePart: BasePart,
newSizeZ: number,
tweenInfo: TweenInfo?
) → Promise?

Resizes the given basePart's Size's Z to newSizeZ. If tweenInfo is specified, then a promise is returned which is resolved once the operation is successful.

Show raw api
{
    "functions": [
        {
            "name": "resizeOnXAxis",
            "desc": "Resizes the given `basePart`'s `Size`'s `X` to `newSizeX`. If `tweenInfo` is specified, then a promise \nis returned which is resolved once the operation is  successful.",
            "params": [
                {
                    "name": "basePart",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "newSizeX",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "tweenInfo",
                    "desc": "",
                    "lua_type": "TweenInfo?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 70,
                "path": "src/basePartSizeUtil/init.luau"
            }
        },
        {
            "name": "resizeOnYAxis",
            "desc": "Resizes the given `basePart`'s `Size`'s `Y` to `newSizeY`. If `tweenInfo` is specified, then a promise \nis returned which is resolved once the operation is  successful.",
            "params": [
                {
                    "name": "basePart",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "newSizeY",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "tweenInfo",
                    "desc": "",
                    "lua_type": "TweenInfo?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 85,
                "path": "src/basePartSizeUtil/init.luau"
            }
        },
        {
            "name": "resizeOnZAxis",
            "desc": "Resizes the given `basePart`'s `Size`'s `Z` to `newSizeZ`. If `tweenInfo` is specified, then a promise \nis returned which is resolved once the operation is  successful.",
            "params": [
                {
                    "name": "basePart",
                    "desc": "",
                    "lua_type": "BasePart"
                },
                {
                    "name": "newSizeZ",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "tweenInfo",
                    "desc": "",
                    "lua_type": "TweenInfo?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 100,
                "path": "src/basePartSizeUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "basePartSizeUtil",
    "desc": " \n\nA utility module for resizing base parts on specific axes.",
    "source": {
        "line": 6,
        "path": "src/basePartSizeUtil/init.luau"
    }
}