Skip to main content

AdorneeUtils

Utilities involving an "Adornee" effectively, any Roblox instance. This is an extremely useful library to use as it lets you abstract applying effects to any Roblox instance instead of specifically switching for different Roblox types.

Functions​

getCenter​

</>
AdorneeUtils.getCenter(adornee: Instance) → Vector3?

Gets the center of the adornee

getBoundingBox​

</>
AdorneeUtils.getBoundingBox(adornee: Instance) → (
)

Gets the bounding box of the adornee

isPartOfAdornee​

</>
AdorneeUtils.isPartOfAdornee(
adornee: Instance,
part: BasePart
) → boolean

Returns whether a part is a part of an adornee

getParts​

</>
AdorneeUtils.getParts(adornee: Instance) → {BasePart}

Retrieves all parts of an adornee

getAlignedSize​

</>
AdorneeUtils.getAlignedSize(adornee: Instance) → Vector3?

Retrieves a size aligned the adornee's CFrame

getPartCFrame​

</>
AdorneeUtils.getPartCFrame(adornee: Instance) → CFrame

Retrieves this adornee's "part"'s CFrame.

getPartPosition​

</>
AdorneeUtils.getPartPosition(adornee: Instance) → Position

Retrieves this adornee's "part"'s position.

getPartVelocity​

</>
AdorneeUtils.getPartVelocity(adornee: Instance) → Vector3

Retrieves this adornee's "part"'s Velocity.

getPart​

</>
AdorneeUtils.getPart(adornee: Instance) → BasePart

Retrieves this adornee's part

getRenderAdornee​

</>
AdorneeUtils.getRenderAdornee(adornee: Instance) → Instance

Retrieves this adornee's part on which to attach a rendering instance to

Show raw api
{
    "functions": [
        {
            "name": "getCenter",
            "desc": "Gets the center of the adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getBoundingBox",
            "desc": "Gets the bounding box of the adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame?"
                },
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "isPartOfAdornee",
            "desc": "Returns whether a part is a part of an adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                },
                {
                    "name": "part",
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 73,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getParts",
            "desc": "Retrieves all parts of an adornee",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ BasePart }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 92,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getAlignedSize",
            "desc": "Retrieves a size aligned the adornee's CFrame",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 123,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getPartCFrame",
            "desc": "Retrieves this adornee's \"part\"'s CFrame.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CFrame"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 147,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getPartPosition",
            "desc": "Retrieves this adornee's \"part\"'s position.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Position"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 163,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getPartVelocity",
            "desc": "Retrieves this adornee's \"part\"'s Velocity.",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 179,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getPart",
            "desc": "Retrieves this adornee's part",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "BasePart"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 193,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        },
        {
            "name": "getRenderAdornee",
            "desc": "Retrieves this adornee's part on which to attach a rendering instance to",
            "params": [
                {
                    "name": "adornee",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 227,
                "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AdorneeUtils",
    "desc": "Utilities involving an \"Adornee\" effectively, any Roblox instance. This is an extremely\nuseful library to use as it lets you abstract applying effects to any Roblox instance\ninstead of specifically switching for different Roblox types.",
    "source": {
        "line": 8,
        "path": "src/adorneeutils/src/Shared/AdorneeUtils.lua"
    }
}