Skip to main content

AdorneeBoundingBox

This utility class can observe the bounding box (size + position) of any Roblox instance effectively. It handles anchored + unanchored instances, and tries to do it in a performance friendly way.

Functions​

new​

</>
AdorneeBoundingBox.new(initialAdornee: Instance?) → AdorneeBoundingBox

Construct a new AdorneeBoundingBox

SetAdornee​

</>
AdorneeBoundingBox.SetAdornee(
adornee: Instance?
) → () → ()

Sets the Roblox instance that we're going to observe the bounding box of

ObserveBoundingBox​

</>
AdorneeBoundingBox.ObserveBoundingBox(self: AdorneeBoundingBox) → Observable<BoundingBoxData>

Observes the bounding box of the adornee

GetBoundingBox​

</>
AdorneeBoundingBox.GetBoundingBox(self: AdorneeBoundingBox) → BoundingBoxData?

Gets the bounding box of the adornee

ObserveCFrame​

</>
AdorneeBoundingBox.ObserveCFrame(self: AdorneeBoundingBox) → Observable<Vector3>

Observes the cframe of the adornee

GetCFrame​

</>
AdorneeBoundingBox.GetCFrame(self: AdorneeBoundingBox) → Vector3

Gets the CFrame of the adornee

ObserveSize​

</>
AdorneeBoundingBox.ObserveSize(self: AdorneeBoundingBox) → Observable<Vector3>

Observes the size of the adornee

GetSize​

</>
AdorneeBoundingBox.GetSize(self: AdorneeBoundingBox) → Vector3

Gets the size of the adornee

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Construct a new AdorneeBoundingBox",
            "params": [
                {
                    "name": "initialAdornee",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "SetAdornee",
            "desc": "Sets the Roblox instance that we're going to observe the bounding box of",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                },
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "() -> ()\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 66,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "ObserveBoundingBox",
            "desc": "Observes the bounding box of the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<BoundingBoxData>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 87,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "GetBoundingBox",
            "desc": "Gets the bounding box of the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BoundingBoxData?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 102,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "ObserveCFrame",
            "desc": "Observes the cframe of the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Vector3>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 120,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "GetCFrame",
            "desc": "Gets the CFrame of the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "ObserveSize",
            "desc": "Observes the size of the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Vector3>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 136,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        },
        {
            "name": "GetSize",
            "desc": "Gets the size of the adornee",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "AdorneeBoundingBox"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 144,
                "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AdorneeBoundingBox",
    "desc": "This utility class can observe the bounding box (size + position) of any Roblox instance effectively.\nIt handles anchored + unanchored instances, and tries to do it in a performance friendly way.",
    "source": {
        "line": 8,
        "path": "src/adorneeboundingbox/src/Shared/AdorneeBoundingBox.lua"
    }
}