📝 Code Templates

Copy-paste ready code snippets for common tasks. Each template includes placeholders and comments to help you customize it for your needs.

Server Templates

Backend code for extending inventory functionality

⚙

Server Operation

Template for creating new inventory operations

Luau

💬

Hook Preset

Template for client-side hook configurations

Luau

🎨

GUI Skin Config

Template for Settings.DifferentUIs configuration

Luau

Usage

How to use these templates

Download or Copy

Click the template link to download, or copy the code directly from the page.

Customize Placeholders

Replace all {{PLACEHOLDER}} values with your specific code:

{{OperationName}} - Your operation name (e.g., "Craft")
{{param1}} - First parameter
{{param2}} - Second parameter
{{resultFields}} - Result fields

Add to Your Project

Place the file in the appropriate location and wire it up per the guide.

See Add Server Features guide for complete instructions.

Quick Reference

Click any card to see full documentation. Click outside to close.

+ Add Item

InventoryService.AddItem(player, "itemId", 1, nil, true)

AddItem

Adds an item to the player's inventory. Follows hotbar-first, then storage logic.

Signature Luau

function InventoryService.AddItem(
    player: Player,
    itemId: string,
    amount: number,
    metadata: any?,
    REPLICATE: boolean
): AddResult

                                Parameters
                                Table
                            

                                ParamTypeDescription

                                playerPlayerThe target player
itemIdstringItem ID (must exist in ServerStorage.Tools)
amountnumberQuantity to add
metadataany?Optional item metadata
REPLICATEbooleanSync to client if true

                            

Param	Type	Description
player	Player	The target player
itemId	string	Item ID (must exist in ServerStorage.Tools)
amount	number	Quantity to add
metadata	any?	Optional item metadata
REPLICATE	boolean	Sync to client if true

Returns Luau

{
    success = boolean,
    reason = string?,
    addedItems = { { uuid, slotType, slot } }?,
    addedAmount = number,
    overflow = number
}

✖ Remove Item

InventoryService.RemoveItem(player, uuid, amount, true)

RemoveItem

Removes an item from the player's inventory by UUID.

Signature Luau

function InventoryService.RemoveItem(
    player: Player,
    uuid: string,
    amount: number?,
    REPLICATE: boolean
): RemoveResult

                                Parameters
                                Table
                            
                                ParamTypeDescription

                                playerPlayerThe target player
uuidstringItem UUID to remove
amountnumber?Amount to remove (nil = all)
REPLICATEbooleanSync to client if true

Param	Type	Description
player	Player	The target player
uuid	string	Item UUID to remove
amount	number?	Amount to remove (nil = all)
REPLICATE	boolean	Sync to client if true

⇆ Swap Slots

InventoryService.SwapSlots(player, "Hotbar", 1, "Storage", 5, true)

SwapSlots

Swaps items between any two slots (Hotbar/Storage combinations).

Signature Luau

function InventoryService.SwapSlots(
    player: Player,
    fromType: string,
    fromSlot: number,
    toType: string,
    toSlot: number,
    REPLICATE: boolean
): SwapResult

                                Parameters
                                Table
                            

                                ParamTypeDescription

                                fromTypestring"Hotbar" or "Storage"
fromSlotnumberSource slot index (1-based)
toTypestring"Hotbar" or "Storage"
toSlotnumberTarget slot index (1-based)
REPLICATEbooleanSync to client if true

                            

Param	Type	Description
fromType	string	"Hotbar" or "Storage"
fromSlot	number	Source slot index (1-based)
toType	string	"Hotbar" or "Storage"
toSlot	number	Target slot index (1-based)
REPLICATE	boolean	Sync to client if true

⛏ Equip Item

InventoryService.EquipSlot(player, "Hotbar", 1, true)

EquipSlot

Equips an item from a slot, making it the active tool.

Signature Luau

function InventoryService.EquipSlot(
    player: Player,
    slotType: string,
    slot: number,
    REPLICATE: boolean
): EquipResult

                                Parameters
                                Table
                            
                                ParamTypeDescription

                                playerPlayerThe target player
slotTypestring"Hotbar" or "Storage"
slotnumberSlot index (1-based)
REPLICATEbooleanSync to client if true

Param	Type	Description
player	Player	The target player
slotType	string	"Hotbar" or "Storage"
slot	number	Slot index (1-based)
REPLICATE	boolean	Sync to client if true

🗑 Drop Item

InventoryService.DropItem(player, "Hotbar", 1, 1, true)

DropItem

Drops an item from a slot into the world as a pickup.

Signature Luau

function InventoryService.DropItem(
    player: Player,
    slotType: string,
    slot: number,
    amount: number?,
    REPLICATE: boolean
): DropResult

                                Parameters
                                Table
                            

                                ParamTypeDescription

                                playerPlayerThe target player
slotTypestring"Hotbar" or "Storage"
slotnumberSlot index
amountnumber?Amount to drop (nil = all)
REPLICATEbooleanSync to client if true

                            

Param	Type	Description
player	Player	The target player
slotType	string	"Hotbar" or "Storage"
slot	number	Slot index
amount	number?	Amount to drop (nil = all)
REPLICATE	boolean	Sync to client if true

🔍 Get State

InventoryService.GetState(player)

GetState

Returns the player's inventory state for direct access.

Signature Luau

function InventoryService.GetState(player: Player): InventoryStateType?

Returns Luau

InventoryStateType {
    Items: { [uuid] = ItemInstance },
    ItemsByID: { [itemId] = { uuid } },
    Hotbar: { [slot] = uuid? },
    Storage: { uuid },
    EquippedItemUUID: string?,
    Weight: number,
    Settings: PlayerSettings
}

Add Server Features

Step-by-step guide

💻

API Reference

Complete API docs

⚙

Settings Guide

Configuration patterns

📝 Code Templates

Server Templates

Server Operation

Hook Preset

GUI Skin Config

Usage

Download or Copy

Customize Placeholders

Add to Your Project

Quick Reference

+ Add Item

AddItem

✖ Remove Item

RemoveItem

⇆ Swap Slots

SwapSlots

⛏ Equip Item

EquipSlot

🗑 Drop Item

DropItem

🔍 Get State

GetState

Related

Add Server Features

API Reference

Settings Guide