Feather FrameworkFeather = exports['feather-inventory'].initiate()Feather = exports['feather-inventory'].initiate()Registers a Inventory Foreign Key for your script to utilize custom inventories. (This must be run on server startup)
| Parameter | Description |
|---|---|
| tableName | This must be the exact name of your table where the inventory owner will be. (e.g. stables) |
| foreignKeyType | The data type used in your tables primary key. (e.g. BIGINT UNSIGNED, VARCHAR(255), INT) |
| primaryKeyName | The name of your primary key. (e.g. id) |
Example Usage:
Feather.Inventory.RegisterForeignKey('stables', 'BIGINT UNSIGNED', 'id')Feather.Inventory.RegisterForeignKey('stables', 'BIGINT UNSIGNED', 'id')Registers a custom inventory for an entity.
| Parameter | Description |
|---|---|
| tableName | This must be the exact name of your table where the inventory owner will be. (e.g. stables) |
| id | The Owners ID from the database (e.g. the database ID of the horse) |
| maxWeight | Override the max weight for the inventory. (Pass nil to use config value) |
| restrictedItems | Table of item names from the DB that you'd like to be restricted (Pass nil to no restrict) |
| ignoreItemLimits | true to ignore the max quantity of the item or false to adhear |
| displayName | A custom name for the inventory (shows on top of inventory) |
Example Usage:
-- Accept all defaults
Feather.Inventory.RegisterInventory('stables', 6)
-- Override defaults
Feather.Inventory.RegisterInventory('stables', 6, 2500, {'apple', 'haycube'}, true)
-- No Restrictions
Feather.Inventory.RegisterInventory('stables', 6, 2500, nil, true)
-- Adhear to item limits. And don't restrict items
Feather.Inventory.RegisterInventory('stables', 6, 2500, nil, false)-- Accept all defaults
Feather.Inventory.RegisterInventory('stables', 6)
-- Override defaults
Feather.Inventory.RegisterInventory('stables', 6, 2500, {'apple', 'haycube'}, true)
-- No Restrictions
Feather.Inventory.RegisterInventory('stables', 6, 2500, nil, true)
-- Adhear to item limits. And don't restrict items
Feather.Inventory.RegisterInventory('stables', 6, 2500, nil, false)Verifies that the inventory you're attempting to put items in to can hold the specified items and quantity.
| Parameter | Description |
|---|---|
| items | Table of item names and quanity you're trying to add |
| inventoryId | UUID of the inventory you are trying to add to |
Return Value:
This will return a table with the response from the API letting you know why it didn't work.
-- Failed Example
local returnValue = {
status = false,
-- One of the following messages.
reason = 'Item is restricted.' -- First check
reason = 'Max quantity exceeded.' -- Second check
reason = 'Max weight exceeded.' -- Third check
}
-- Successful Example
local returnValue = {
status = true,
reason = ''
}-- Failed Example
local returnValue = {
status = false,
-- One of the following messages.
reason = 'Item is restricted.' -- First check
reason = 'Max quantity exceeded.' -- Second check
reason = 'Max weight exceeded.' -- Third check
}
-- Successful Example
local returnValue = {
status = true,
reason = ''
}Example Usage:
local items = {
{
item = "fangs",
quantity = 5
},
{
item = "meat",
quantity = 10
}
}
Feather.Inventory.InventoryCanHold(items, 'c770bc77-3a77-11ee-b67f-18c04d04db03')local items = {
{
item = "fangs",
quantity = 5
},
{
item = "meat",
quantity = 10
}
}
Feather.Inventory.InventoryCanHold(items, 'c770bc77-3a77-11ee-b67f-18c04d04db03')Add an item to a given inventory.
| Parameter | Description |
|---|---|
| itemName | The name of the item from the database. |
| quantity | The quantity of the item you'd like to add. |
| metadata | Any metadata you'd like to add to the item. Can be nil |
| inventoryId | The UUID of the inventory you are adding the item to. If adding to the active player, give this field src |
Example Usage:
-- Add 6 apples to my inventory
Feather.Inventory.AddItem('item_apple', 6, nil, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
local metadata = { quality = 'poor', durability = 50, maxDurability = 100 }
Feather.Inventory.AddItem('item_apple', 6, metadata, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
-- This adds to the active players inventory
Feather.Inventory.AddItem('item_apple', 6, nil, src)-- Add 6 apples to my inventory
Feather.Inventory.AddItem('item_apple', 6, nil, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
local metadata = { quality = 'poor', durability = 50, maxDurability = 100 }
Feather.Inventory.AddItem('item_apple', 6, metadata, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
-- This adds to the active players inventory
Feather.Inventory.AddItem('item_apple', 6, nil, src)Remove an item from a given inventory by name.
| Parameter | Description |
|---|---|
| itemName | The name of the item from the database. |
| quantity | The quantity of the item you'd like to remove. |
| inventoryId | The UUID of the inventory you are removing the item to. If removing from the active player, give this field src or nil |
Example Usage:
Feather.Inventory.RemoveItemByName('item_apple', 6)Feather.Inventory.RemoveItemByName('item_apple', 6)Remove an item by its inventory ID. Only supports a single item as its targeting the primary key of the table. If you need to remove multiple items use RemoveItemByName.
| Parameter | Description |
|---|---|
| id | The ID of the item from the players inventory |
Example Usage:
Feather.Inventory.RemoveItemById(6)Feather.Inventory.RemoveItemById(6)Sets the metadata for a given item.
| Parameter | Description |
|---|---|
| id | The ID of the item from the players inventory. |
| metadata | Table of key/value pairs to set |
Example Usage:
local metadata = {
display = 'Something to display under the item description',
quality = 'poor',
durability = 50,
maxDurability = 100
}
Feather.Inventory.SetMetadata(6, metadata)local metadata = {
display = 'Something to display under the item description',
quality = 'poor',
durability = 50,
maxDurability = 100
}
Feather.Inventory.SetMetadata(6, metadata)Gets an item from the Inventory Items Table
| Parameter | Description |
|---|---|
| id | The ID of the item from the players inventory. |
Example Usage:
Feather.Inventory.GetItem(6)Feather.Inventory.GetItem(6)Retrieves the amount of a specific item a player has. Returns the quantity.
| Parameter | Description |
|---|---|
| itemName | The name of the item you are looking for. |
| inventoryId | ID of the inventory, you can also feed in the src of a player instead of inventoryID |
Example Usage:
Feather.Inventory.GetItemCount('item_train_ticket', 'c770bc77-3a77-11ee-b67f-18c04d04db03')Feather.Inventory.GetItemCount('item_train_ticket', 'c770bc77-3a77-11ee-b67f-18c04d04db03')Checks if an item exists in the DB.
| Parameter | Description |
|---|---|
| itemName | The name of the item you are looking for. |
Example Usage:
Feather.Inventory.ItemExists('item_train_ticket')Feather.Inventory.ItemExists('item_train_ticket')Checks to see if a player has a specific item or items.
| Parameter | Description |
|---|---|
| items | A table of items you wish to check for. See below for an example of a properly formatted item table. |
| inventory | The inventory ID you're checking to see if it has items against. You can also feed in the src of a player instead of inventoryID |
Example Usage:
local itemsToCheckFor = {
{
name = 'apple',
quantity = 5
},
{
name = 'jars',
quantity = 2
}
}
Feather.Inventory.PlayerHasItems(itemsToCheckFor, 'c770bc77-3a77-11ee-b67f-18c04d04db03')local itemsToCheckFor = {
{
name = 'apple',
quantity = 5
},
{
name = 'jars',
quantity = 2
}
}
Feather.Inventory.PlayerHasItems(itemsToCheckFor, 'c770bc77-3a77-11ee-b67f-18c04d04db03')Registers a usable item with Feather Inventory
| Parameter | Description |
|---|---|
| itemName | The name of the item you are registering a call back for. |
| callback | A closure with the logic you will be using upon use of the item |
Example Usage:
Feather.Inventory.RegisterUsableItem('item_apple', function (item)
print('You ate an apple!')
end)Feather.Inventory.RegisterUsableItem('item_apple', function (item)
print('You ate an apple!')
end)Check to see if a player can store an item
| Parameter | Description |
|---|---|
| items | Table of items and their quantity. e.g. { {item="apple", quantity=5}, {item="matches", quantity=10} } |
| inventoryId | Player Source or Inventory UUID |
local canHold = Feather.Inventory.InventoryCanHold({ {item="apple", quantity=5}, {item="matches", quantity=10} }, src)
-- Success response { status = true, message = '' }
-- Failed response { status = false, message = 'Max Quantity Exceeded.' }local canHold = Feather.Inventory.InventoryCanHold({ {item="apple", quantity=5}, {item="matches", quantity=10} }, src)
-- Success response { status = true, message = '' }
-- Failed response { status = false, message = 'Max Quantity Exceeded.' }Open an inventory (This is built into inventory with keypress, but if you would like to do so programatically)
-- Open player inventory
Feather.Inventory.OpenInventory(src, nil, 'player')
-- Open secondary/custom inventory
Feather.Inventory.OpenInventory(src, 'c770bc77-3a77-11ee-b67f-18c04d04db03')-- Open player inventory
Feather.Inventory.OpenInventory(src, nil, 'player')
-- Open secondary/custom inventory
Feather.Inventory.OpenInventory(src, 'c770bc77-3a77-11ee-b67f-18c04d04db03')Close an inventory (This is built into inventory with keypress, but if you would like to do so programatically)
Feather.Inventory.CloseInventory(src)Feather.Inventory.CloseInventory(src)Open an inventory (This is built into inventory with keypress, but if you would like to do so programatically)
Feather.Inventory.Open(nil, "player")
-- or
Feather.Inventory.Open('5ab95e93-c590-11ee-a5cf-40b07640984b')Feather.Inventory.Open(nil, "player")
-- or
Feather.Inventory.Open('5ab95e93-c590-11ee-a5cf-40b07640984b')Close an inventory (This is built into inventory with keypress, but if you would like to do so programatically)
Feather.Inventory.Close()Feather.Inventory.Close()Get contents of a a players inventory
| Parameter | Description |
|---|---|
| key | the key used when registering the inventory |
| inventoryId | Player Source or Inventory UUID |
Returns: id, uuid, max_weight, ignore_item_limit
local _, groundInventoryID = InventoryAPI.GetInventory(src)local _, groundInventoryID = InventoryAPI.GetInventory(src)Get contents of a secondary/custom inventory
| Parameter | Description |
|---|---|
| key | the key used when registering the inventory |
| inventoryId | Inventory UUID |
Returns: id, uuid, max_weight, ignore_item_limit
local _, groundInventoryID = InventoryAPI.GetCustomInventory('stables', 'c770bc77-3a77-11ee-b67f-18c04d04db03')local _, groundInventoryID = InventoryAPI.GetCustomInventory('stables', 'c770bc77-3a77-11ee-b67f-18c04d04db03')Gets the items from a specified inventory
| Parameter | Description |
|---|---|
| inventoryId | Player Source or Inventory UUID |
InventoryAPI.GetInventoryItems('stables', 'c770bc77-3a77-11ee-b67f-18c04d04db03')InventoryAPI.GetInventoryItems('stables', 'c770bc77-3a77-11ee-b67f-18c04d04db03')