Skip to main content

Grid

Properties​

GuiElement​

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

SlotElements​

This item is read only and cannot be modified. Read Only
</>
Grid.SlotElements: {GuiObject}

GridSize​

This item is read only and cannot be modified. Read Only
</>
Grid.GridSize: Vector2

SlotAspectRatio​

This item is read only and cannot be modified. Read Only
</>
Grid.SlotAspectRatio: number

Items​

This item is read only and cannot be modified. Read Only
</>
Grid.Items: {ItemObject}

ItemAdded​

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

An event signal that fires every time a new Item is added to the Grid.

ItemRemoved​

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

An event signal that fires every time an Item is removed from the Grid.

Functions​

new​

</>
Grid.new(properties: Types.GridProperties) → Types.GridObject

Create a new Grid ItemManager object.

GetSizeScale​

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

Gets the AbsoluteSize of one slot.

GetAbsoluteSizeFromItemSize​

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

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

GetItemManagerPositionFromAbsolutePosition​

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

Converts an AbsolutePosition to a ItemManager position.

GetNextFreePositionForItem​

</>
Grid:GetNextFreePositionForItem(item: Types.ItemObject) → Vector2?

Gets the next position in a Grid where the item doesn't collide with anything.

GetItemsInRegion​

</>
Grid:GetItemsInRegion(
position: Vector2,
size: Vector2,
rotation: number,
ignoredItems: {Types.ItemObject}
) → {Types.ItemObject}

Gets all of the Items in the secified region.

IsColliding​

ItemManager Override
</>
Grid:IsColliding(
item: Types.ItemObject,
ignoredItems: {Types.ItemObject},
at: Vector2?,
withRotation: number?
) → 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.

IsRegionInBounds​

</>
Grid:IsRegionInBounds(
position: Vector2,
size: Vector2,
rotation: number
) → boolean

Checks if a region is in the bounds of the Grid.

SortItemsByVolume​

</>
Grid:SortItemsByVolume() → ()

Sorts all of the items by volume (Volume = Size.X * Size.Y).

AddItem​

</>
Grid:AddItem(
item: Types.ItemObject,
at: Vector2?,
useTween: boolean?
) → ()

Adds an item to the grid. Use optional at parameter for overriding the Item's position.

RemoveItem​

ItemManager Override
</>
Grid:RemoveItem(item: Types.ItemObject) → ()

Removes an item from the Grid.

ClearItems​

</>
Grid:ClearItems(destroyItems: boolean?) → ()

Removes all of the Items in the grid.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Create a new Grid ItemManager object.",
            "params": [
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "Types.GridProperties"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.GridObject\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "_createGuiElement",
            "desc": "Creates a new Grid GUI element.",
            "params": [
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "Types.GridProperties"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CanvasGroup"
                },
                {
                    "desc": "",
                    "lua_type": "{ CanvasGroup }"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 104,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "_updateGuiGrid",
            "desc": "Updates all slot GUI elements in the grid.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 149,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "GetSizeScale",
            "desc": "Gets the AbsoluteSize of one slot.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 176,
                "path": "src/ItemManager/Grid.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": 186,
                "path": "src/ItemManager/Grid.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": 198,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "GetNextFreePositionForItem",
            "desc": "Gets the next position in a Grid where the item doesn't collide with anything.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2?\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 222,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "GetItemsInRegion",
            "desc": "Gets all of the Items in the secified region.",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "size",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "rotation",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "ignoredItems",
                    "desc": "",
                    "lua_type": "{ Types.ItemObject }"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Types.ItemObject }\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 242,
                "path": "src/ItemManager/Grid.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?"
                },
                {
                    "name": "withRotation",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 276,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "IsRegionInBounds",
            "desc": "Checks if a region is in the bounds of the Grid.",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "size",
                    "desc": "",
                    "lua_type": "Vector2"
                },
                {
                    "name": "rotation",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 286,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "SortItemsByVolume",
            "desc": "Sorts all of the items by volume (Volume = Size.X * Size.Y).",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 306,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "AddItem",
            "desc": "Adds an item to the grid. Use optional `at` parameter for overriding the Item's position.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                },
                {
                    "name": "at",
                    "desc": "",
                    "lua_type": "Vector2?"
                },
                {
                    "name": "useTween",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 332,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "RemoveItem",
            "desc": "Removes an item from the Grid.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "ItemManager Override"
            ],
            "source": {
                "line": 351,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "ClearItems",
            "desc": "Removes all of the Items in the grid.",
            "params": [
                {
                    "name": "destroyItems",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 368,
                "path": "src/ItemManager/Grid.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "GuiElement",
            "desc": "",
            "lua_type": "GuiObject",
            "readonly": true,
            "source": {
                "line": 25,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "SlotElements",
            "desc": "",
            "lua_type": "{ GuiObject }",
            "readonly": true,
            "source": {
                "line": 30,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "GridSize",
            "desc": "",
            "lua_type": "Vector2",
            "readonly": true,
            "source": {
                "line": 35,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "SlotAspectRatio",
            "desc": "",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 40,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "Items",
            "desc": "",
            "lua_type": "{ ItemObject }",
            "readonly": true,
            "source": {
                "line": 45,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "ItemAdded",
            "desc": "An event signal that fires every time a new Item is added to the Grid.",
            "lua_type": "RBXScriptSignal",
            "tags": [
                "Signal"
            ],
            "readonly": true,
            "source": {
                "line": 53,
                "path": "src/ItemManager/Grid.lua"
            }
        },
        {
            "name": "ItemRemoved",
            "desc": "An event signal that fires every time an Item is removed from the Grid.",
            "lua_type": "RBXScriptSignal",
            "tags": [
                "Signal"
            ],
            "readonly": true,
            "source": {
                "line": 61,
                "path": "src/ItemManager/Grid.lua"
            }
        }
    ],
    "types": [],
    "name": "Grid",
    "desc": "",
    "source": {
        "line": 20,
        "path": "src/ItemManager/Grid.lua"
    }
}