Skip to main content

SingleSlot

Properties​

GuiElement​

This item is read only and cannot be modified. Read Only
</>
SingleSlot.GuiElement: GuiObject

The SingleSlot's GUI element.

Item​

This item is read only and cannot be modified. Read Only
</>
SingleSlot.Item: ItemObject

The current Item in the SingleSlot.

ItemChanged​

This item is read only and cannot be modified. Read OnlySignal
</>
SingleSlot.ItemChanged: RBXScriptSignal

An event signal that fires every time a new Item replaces the old Item.

Functions​

new​

</>
SingleSlot.new(properties: Types.SingleSlotProperties) → Types.SingleSlotObject

Creates a new SingleSlot ItemManager object.

GetOffset​

ItemManager Override
</>
SingleSlot:GetOffset(itemRotation: number) → Vector2

Gets the AbsolutePosition property from the ItemManager's GUI element.

GetSizeScale​

ItemManager Override
</>
SingleSlot:GetSizeScale() → Vector2

Gets the AbsoluteSize of the slot.

GetAbsoluteSizeFromItemSize​

ItemManager Override
</>
SingleSlot:GetAbsoluteSizeFromItemSize(
itemSize: Vector2,
itemRotation: number
) → Vector2

Gets the AbsoluteSize of an Item with the ItemManager's size scale.

GetItemManagerPositionFromAbsolutePosition​

ItemManager Override
</>
SingleSlot:GetItemManagerPositionFromAbsolutePosition(
absolutePosition: Vector2,
itemSize: Vector2,
itemRotation: number
) → Vector2

Converts an AbsolutePosition to a ItemManager position.

IsColliding​

ItemManager Override
</>
SingleSlot:IsColliding(
item: Types.ItemObject,
ignoredItems: {Types.ItemObject},
) → boolean

Checks if an Item is colliding. Use the at parameter to override the collision check position, else it will use the Item's position.

ChangeItem​

ItemManager Override
</>
SingleSlot:ChangeItem(item: Types.ItemObject) → ()

Changes the current item in the SingleSlot.

RemoveItem​

ItemManager Override
</>
SingleSlot:RemoveItem() → ()

Removes the item from the SingleSlot.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new SingleSlot ItemManager object.",
            "params": [
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "Types.SingleSlotProperties"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.SingleSlotObject\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 48,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "_createGuiElement",
            "desc": "Creates a new SingleSlot GUI element.",
            "params": [
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "Types.SingleSlotProperties"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ GuiObject }\r\n"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 72,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "GetOffset",
            "desc": "Gets the AbsolutePosition property from the ItemManager's GUI element.",
            "params": [
                {
                    "name": "itemRotation",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 93,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "GetSizeScale",
            "desc": "Gets the AbsoluteSize of the slot.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 108,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "GetAbsoluteSizeFromItemSize",
            "desc": "Gets the AbsoluteSize of an Item with the ItemManager's size scale.",
            "params": [
                {
                    "name": "itemSize",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "itemRotation",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 118,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "GetItemManagerPositionFromAbsolutePosition",
            "desc": "Converts an AbsolutePosition to a ItemManager position.",
            "params": [
                {
                    "name": "absolutePosition",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "itemSize",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "itemRotation",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 132,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "IsColliding",
            "desc": "Checks if an Item is colliding. Use the `at` parameter to override the collision check position, else it will use the Item's position.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                },
                {
                    "name": "ignoredItems",
                    "desc": "",
                    "lua_type": "{ Types.ItemObject }"
                },
                {
                    "name": "at",
                    "desc": "",
                    "lua_type": "Vector2?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 147,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "ChangeItem",
            "desc": "Changes the current item in the SingleSlot.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 161,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "RemoveItem",
            "desc": "Removes the item from the SingleSlot.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 180,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "GuiElement",
            "desc": "The SingleSlot's GUI element.",
            "lua_type": "GuiObject",
            "readonly": true,
            "source": {
                "line": 27,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "Item",
            "desc": "The current Item in the SingleSlot.",
            "lua_type": "ItemObject",
            "readonly": true,
            "source": {
                "line": 34,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        },
        {
            "name": "ItemChanged",
            "desc": "An event signal that fires every time a new Item replaces the old Item.",
            "lua_type": "RBXScriptSignal",
            "tags": [
                "Signal"
            ],
            "readonly": true,
            "source": {
                "line": 42,
                "path": "src/ItemManager/SingleSlot.lua"
            }
        }
    ],
    "types": [],
    "name": "SingleSlot",
    "desc": "",
    "source": {
        "line": 20,
        "path": "src/ItemManager/SingleSlot.lua"
    }
}