Skip to main content

TransferLink

Used to connect ItemManagers together so that Items are draggable between them.

Properties​

ConnectedItemMangers​

This item is read only and cannot be modified. Read Only
</>
TransferLink.ConnectedItemMangers: {ItemManagerObject}

All of the ItemManagers that the TranferLink has linked together. Should not be edited and only read from. To connect an ItemManager to a TransferLink use: ItemManager:ConnectTransferLink(TransferLink)

Functions​

new​

</>
TransferLink.new(properties: Types.TransferLinkProperties) → Types.TransferLinkObject

Create a new TransferLink object.

GetItemOverlappingItemManagers​

</>
TransferLink:GetItemOverlappingItemManagers(item: Types.ItemObject) → {Types.ItemManagerObject}

Get the ItemManagers that the Item is hovering over.

GetClosestItemOverlappingItemManagers​

</>
TransferLink:GetClosestItemOverlappingItemManagers(item: Types.ItemObject) → {Types.ItemManagerObject}

Same as TransferLink:GetItemOverlappingItemManagers() but sorts the ItemManagers by distance from nearest to furthest.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Create a new TransferLink object.",
            "params": [
                {
                    "name": "properties",
                    "desc": "",
                    "lua_type": "Types.TransferLinkProperties"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Types.TransferLinkObject\r\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/TransferLink.lua"
            }
        },
        {
            "name": "GetItemOverlappingItemManagers",
            "desc": "Get the ItemManagers that the Item is hovering over.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Types.ItemManagerObject }\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 57,
                "path": "src/TransferLink.lua"
            }
        },
        {
            "name": "GetClosestItemOverlappingItemManagers",
            "desc": "Same as `TransferLink:GetItemOverlappingItemManagers()` but sorts the ItemManagers by distance from nearest to furthest.",
            "params": [
                {
                    "name": "item",
                    "desc": "",
                    "lua_type": "Types.ItemObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ Types.ItemManagerObject }\r\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 83,
                "path": "src/TransferLink.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "ConnectedItemMangers",
            "desc": "All of the ItemManagers that the TranferLink has linked together. Should not be edited and only read from. To connect an ItemManager to a TransferLink use: `ItemManager:ConnectTransferLink(TransferLink)`",
            "lua_type": "{ ItemManagerObject }",
            "readonly": true,
            "source": {
                "line": 26,
                "path": "src/TransferLink.lua"
            }
        }
    ],
    "types": [],
    "name": "TransferLink",
    "desc": "Used to connect ItemManagers together so that Items are draggable between them.",
    "source": {
        "line": 19,
        "path": "src/TransferLink.lua"
    }
}