Skip to main content

CEIVE

Root class for all the gizmos.

Functions​

GetPoolSize​

</>
CEIVE.GetPoolSize() → number

PushProperty​

</>
CEIVE.PushProperty(
Property: string,
Value: any
) → ()

Push Property sets the value of a property.

PopProperty​

</>
CEIVE.PopProperty(Property: string) → any

Pop Property returns the property value.

SetStyle​

</>
CEIVE.SetStyle(
Color: Color3?,
Transparency: number?,
AlwaysOnTop: boolean?
) → ()

Sets the style of all properties.

DoCleaning​

</>
CEIVE.DoCleaning() → ()

ScheduleCleaning​

</>
CEIVE.ScheduleCleaning() → ()

AddDebrisInSeconds​

</>
CEIVE.AddDebrisInSeconds(
Seconds: number,
Callback: function
) → ()

Acts as a wrapper for your code that runs for a provided amount of seconds.

AddDebrisInFrames​

</>
CEIVE.AddDebrisInFrames(
Frames: number,
Callback: function
) → ()

Acts as a wrapper for your code that runs for a provided amount of frames.

TweenProperties​

</>
CEIVE.TweenProperties(
Properties: table,
Goal: table,
TweenInfo: TweenInfo
) → CancelFunction

Tweens the property table to the goal with the provided TweenInfo, returns a function which can be used to cancel.

Init​

</>
CEIVE.Init() → ()

SetEnabled​

</>
CEIVE.SetEnabled(Value: boolean) → ()

RemoveAdornments​

</>
CEIVE.RemoveAdornments() → ()

Removes adornments, will be added back next frame if Ceive is enabled

Show raw api
{
    "functions": [
        {
            "name": "GetPoolSize",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 539,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "PushProperty",
            "desc": "Push Property sets the value of a property.",
            "params": [
                {
                    "name": "Property",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "Value",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 554,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "PopProperty",
            "desc": "Pop Property returns the property value.",
            "params": [
                {
                    "name": "Property",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 572,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "SetStyle",
            "desc": "Sets the style of all properties.",
            "params": [
                {
                    "name": "Color",
                    "desc": "",
                    "lua_type": "Color3?"
                },
                {
                    "name": "Transparency",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "AlwaysOnTop",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 586,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "DoCleaning",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 602,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "ScheduleCleaning",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 618,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "AddDebrisInSeconds",
            "desc": "Acts as a wrapper for your code that runs for a provided amount of seconds.",
            "params": [
                {
                    "name": "Seconds",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "Callback",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 637,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "AddDebrisInFrames",
            "desc": "Acts as a wrapper for your code that runs for a provided amount of frames.",
            "params": [
                {
                    "name": "Frames",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "Callback",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 646,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "TweenProperties",
            "desc": "Tweens the property table to the goal with the provided TweenInfo, returns a function which can be used to cancel.",
            "params": [
                {
                    "name": "Properties",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "Goal",
                    "desc": "",
                    "lua_type": "table"
                },
                {
                    "name": "TweenInfo",
                    "desc": "",
                    "lua_type": "TweenInfo"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CancelFunction"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 657,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "Init",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 678,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "SetEnabled",
            "desc": "",
            "params": [
                {
                    "name": "Value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 785,
                "path": "src/CeiveImGizmo/init.luau"
            }
        },
        {
            "name": "RemoveAdornments",
            "desc": "Removes adornments, will be added back next frame if Ceive is enabled\r",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 796,
                "path": "src/CeiveImGizmo/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "CEIVE",
    "desc": "Root class for all the gizmos.\r",
    "source": {
        "line": 518,
        "path": "src/CeiveImGizmo/init.luau"
    }
}