Skip to main content

ImOverlay

Properties​

DefaultY​

</>
ImOverlay.DefaultY: number

TextSize​

</>
ImOverlay.TextSize: number

BackFrame​

</>
ImOverlay.BackFrame: Frame

ListLayout​

</>
ImOverlay.ListLayout: UIListLayout

DidUpdate​

</>
ImOverlay.DidUpdate: boolean

Functions​

new​

</>
ImOverlay.new(
DefaultY: number?,
TextSize: number?,
UseInset: number?
) → ()

Creates a new overlay object

Begin​

</>
ImOverlay.Begin(
Text: string,
BackgroundColor: Color3?,
TextColor: Color3?
) → ()

Adds text and indents

End​

</>
ImOverlay.End() → ()

Removes an indent

Text​

</>
ImOverlay.Text(
Text: string,
BackgroundColor: Color3?,
TextColor: Color3?
) → ()

Adds text

Render​

</>
ImOverlay.Render() → ()

Draws the current render group to the screen

Destroy​

</>
ImOverlay.Destroy() → ()
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new overlay object\r",
            "params": [
                {
                    "name": "DefaultY",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "TextSize",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "UseInset",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "Begin",
            "desc": "Adds text and indents\r",
            "params": [
                {
                    "name": "Text",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "BackgroundColor",
                    "desc": "",
                    "lua_type": "Color3?"
                },
                {
                    "name": "TextColor",
                    "desc": "",
                    "lua_type": "Color3?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "End",
            "desc": "Removes an indent\r",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 130,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "Text",
            "desc": "Adds text\r",
            "params": [
                {
                    "name": "Text",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "BackgroundColor",
                    "desc": "",
                    "lua_type": "Color3?"
                },
                {
                    "name": "TextColor",
                    "desc": "",
                    "lua_type": "Color3?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 145,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_Pool",
            "desc": "Pools all objects so they can be used again\r",
            "params": [],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 178,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_Cleanup",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 196,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_CreateLabel",
            "desc": "",
            "params": [
                {
                    "name": "Text",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "TextColor",
                    "desc": "",
                    "lua_type": "Color3"
                },
                {
                    "name": "BackgroundColor",
                    "desc": "",
                    "lua_type": "Color3"
                },
                {
                    "name": "Indent",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Frame"
                }
            ],
            "function_type": "static",
            "private": true,
            "source": {
                "line": 212,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "Render",
            "desc": "Draws the current render group to the screen\r",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 252,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 311,
                "path": "src/CeiveImOverlay.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "DefaultY",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 17,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "TextSize",
            "desc": "",
            "lua_type": "number",
            "source": {
                "line": 20,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "BackFrame",
            "desc": "",
            "lua_type": "Frame",
            "source": {
                "line": 23,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "ListLayout",
            "desc": "",
            "lua_type": "UIListLayout",
            "source": {
                "line": 26,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "DidUpdate",
            "desc": "",
            "lua_type": "boolean",
            "source": {
                "line": 29,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_Indent",
            "desc": "",
            "lua_type": "number",
            "private": true,
            "source": {
                "line": 33,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_State",
            "desc": "",
            "lua_type": "string",
            "private": true,
            "source": {
                "line": 37,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_PreviousState",
            "desc": "",
            "lua_type": "string",
            "private": true,
            "source": {
                "line": 41,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_RenderGroup",
            "desc": "",
            "lua_type": "table",
            "private": true,
            "source": {
                "line": 45,
                "path": "src/CeiveImOverlay.lua"
            }
        },
        {
            "name": "m_Pool",
            "desc": "",
            "lua_type": "table",
            "private": true,
            "source": {
                "line": 49,
                "path": "src/CeiveImOverlay.lua"
            }
        }
    ],
    "types": [],
    "name": "ImOverlay",
    "desc": "",
    "source": {
        "line": 14,
        "path": "src/CeiveImOverlay.lua"
    }
}