Init Events

Author: Musiker15

docs/inventory-v4/Events/inventory-closeinventory.md

@@ -0,0 +1,21 @@
+---
+description: Trigger to close the inventory
+sidebar_position: 3
+---
+
+# inventory:closeInventory
+
+You can also add a reason but this is optional.
+```lua
+TriggerEvent('inventory:closeInventory', reason)
+```
+
+### Clientside
+```lua
+TriggerEvent('inventory:closeInventory', "This is a reason Notify")
+```
+
+### Serverside
+```lua
+TriggerClientEvent('inventory:closeInventory', source, "This is a reason Notify")
+```

docs/inventory-v4/Events/inventory-lock.md

@@ -0,0 +1,23 @@
+---
+description: With this Event you can Lock the inventory to be opened again
+sidebar_position: 4
+---
+
+# inventory:lock
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**lock** - `boolean` - `(true / false)`
+
+```lua
+TriggerEvent('inventory:lock', lock)
+```
+
+### Clientside
+```lua
+TriggerEvent('inventory:lock', true)
+```
+
+### Serverside
+```lua
+TriggerClientEvent('inventory:lock', source, true)
+```

docs/inventory-v4/Events/inventory-lockinventory.md

@@ -0,0 +1,24 @@
+---
+description: With this Event you can Lock the inventory to be opened again for X seconds.
+sidebar_position: 5
+---
+
+# inventory:lockInventory
+
+You can also add a reason but this is optional.
+
+```lua
+TriggerEvent('inventory:lockInventory', miliseconds)
+```
+
+This example will lock the inventory for 1 second.
+
+### Clientside
+```lua
+TriggerEvent('inventory:lockInventory', 1000)
+```
+
+### Serverside
+```lua
+TriggerClientEvent('inventory:lockInventory', source, 1000)
+```

docs/inventory-v4/Events/inventory-notify.md

@@ -0,0 +1,39 @@
+---
+description: Notify the player with the inventory notification system
+sidebar_position: 1
+---
+
+# inventory:notify
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**message** - `string` - The message you want to send\
+**type** - `string` - There are 3 types `("info", "error", "success")`
+
+### Clientside
+```lua
+TriggerEvent("inventory:notify", "Hello FiveM!", "success")
+```
+
+### Serverside
+```lua
+TriggerClientEvent('inventory:notify', source, "Hello FiveM!", "success")
+```
+
+## inventory:openInventory
+
+This opens the own player inventory:
+```lua
+TriggerEvent('inventory:openInventory')
+```
+
+This opens a secondary inventory:
+```lua
+TriggerEvent('inventory:openInventory', {
+    type = "stash", -- "type" in database
+    id = "1", -- "identifier" in database
+    title = "Chezza's Stash", 
+    weight = 100, -- set to false for no weight,
+    delay = 100,
+    save = true -- save to database true or false
+})
+```

docs/inventory-v4/Events/inventory-opencrafting.md

@@ -0,0 +1,52 @@
+---
+description: Open the crafting inventory from a different script
+sidebar_position: 8
+---
+
+# inventory:openCrafting
+
+:::info
+clientside AND serverside
+:::
+
+:::warning
+`Config.Crafting` must be set to `true`
+:::
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**title** - `string` - Title of the crafting inventory\
+**items** - `array` - See below (Items Object)
+
+<span style={{color: 'yellow'}}>**Parameters (Items Object)**</span>\
+**type** - `string` - `item` or `weapon`\
+**name** - `string` - Name of the item\
+**count** - `number` - How many items you get after crafting\
+**time** - `number` - How long does it take to craft the specified item\
+**ingredients** - `array` - This are the items that you need to craft the specified item
+
+### Example
+
+```lua
+local items = {
+    {type = 'item', name = 'fishrod', count = 1, time = 5, ingredients = {
+      {name = 'stick', count = 1},
+      {name = 'hook', count = 1}
+    }},
+    -- copy and paste the table above in here for multiple items at this position
+  }
+```
+
+### Clientside
+```lua
+TriggerEvent("inventory:openCrafting", title, items)
+```
+
+### Serverside
+You can use this:
+```lua
+TriggerClientEvent("inventory:openCrafting", source, title, items)
+```
+or you can use this:
+```lua
+xPlayer.triggerEvent("inventory:openCrafting", title, items)
+```

docs/inventory-v4/Events/inventory-openhouse.md

@@ -0,0 +1,35 @@
+---
+description: Open the house inventory from a different script
+sidebar_position: 11
+---
+
+# inventory:openHouse
+
+:::info
+clientside AND serverside
+:::
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**owner** - `string` - Owner of house (identifier)\
+**id** - `string` - ID of house\
+**title** - `string` - Title of the house\
+**weight** - `number` - Weight of the house
+
+```lua
+TriggerEvent('inventory:openHouse', "steam:id", "house-1", "House Title", 300)
+```
+
+### Clientside
+```lua
+TriggerEvent('inventory:openHouse', ESX.GetPlayerData().identifier, "house-1", "House Title", 300)
+```
+
+### Serverside
+You can use this:
+```lua
+TriggerClientEvent('inventory:openHouse', source, xPlayer.identifier, "house-1", "House Title", 300)
+```
+or you can use this:
+```lua
+xPlayer.triggerEvent("inventory:openShop", xPlayer.identifier, "house-1", "House Title", 300)
+```

docs/inventory-v4/Events/inventory-openinventory.md

@@ -0,0 +1,25 @@
+---
+description: Trigger to open the inventory
+sidebar_position: 2
+---
+
+# inventory:openInventory
+
+This opens the own player inventory:
+
+```lua
+TriggerEvent('inventory:openInventory')
+```
+
+This opens a secondary inventory:
+
+```lua
+TriggerEvent('inventory:openInventory', {
+    type = "stash", -- "type" in database
+    id = "1", -- "identifier" in database
+    title = "Chezza's Stash", 
+    weight = 100, -- set to false for no weight,
+    delay = 100,
+    save = true -- save to database true or false
+})
+```

docs/inventory-v4/Events/inventory-openplayerinventory.md

@@ -0,0 +1,44 @@
+---
+description: Open a players inventory
+sidebar_position: 6
+---
+
+# inventory:openPlayerInventory
+
+:::info
+clientside AND serverside
+:::
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**playerId** - `number` - This should be the playerId\
+**receiveWeapons** - `boolean` - `true` or`false`
+
+### Clientside
+```lua
+TriggerEvent("inventory:openPlayerInventory", playerId, receiveWeapons)
+```
+
+**Example:**
+```lua
+local player, distance = ESX.Game.GetClosestPlayer()
+if player ~= -1 and distance <= 3.0 then
+    TriggerEvent('inventory:openPlayerInventory', GetPlayerServerId(player), true)
+end
+```
+
+### Serverside
+```lua
+TriggerClientEvent("inventory:openPlayerInventory", source, playerId, receiveWeapons)
+```
+
+**Example:**
+
+You can use this:
+```lua
+TriggerClientEvent("inventory:openPlayerInventory", source, xPlayer.source, true)
+```
+
+or you can use this:
+```lua
+xPlayer.triggerEvent("inventory:openPlayerInventory", xPlayer.source, true)
+```

docs/inventory-v4/Events/inventory-openshop.md

@@ -0,0 +1,49 @@
+---
+description: Open the shop inventory from a different script
+sidebar_position: 9
+---
+
+# inventory:openShop
+
+:::info
+clientside AND serverside
+:::
+
+:::warning
+`Config.Shops` must be set to `true`
+:::
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**title** - `string` - Title of the shop\
+**items** - `array` - See below (Items Object)
+
+<span style={{color: 'yellow'}}>**Parameters (Item Object)**</span>\
+**type** - `string` - `item` or `weapon`\
+**name** - `string` - Name of the item\
+**method** - `string` - `money`, `bank` or `black_money`\
+**price** - `number` or `boolean` - Set false to disable buying\
+**sellPrice** - `number` or `boolean` - Set false to disable selling
+
+```lua
+local items = {
+  {type = 'item', name = 'apple', method = 'money', price = 10, sellPrice = 3},
+  {type = 'item', name = 'strawberry', method = 'bank', price = false, sellPrice = 3},
+  {type = 'item', name = 'cherry', method = 'black_money', price = 10, sellPrice = false},
+}
+```
+
+### Clientside
+
+```lua
+TriggerEvent("inventory:openShop", title, items)
+```
+
+### Serverside
+You can use this:
+```lua
+TriggerClientEvent("inventory:openShop", source, title, items)
+```
+or you can use this:
+```lua
+xPlayer.triggerEvent("inventory:openShop", title, items)
+```

docs/inventory-v4/Events/inventory-openstorage.md

@@ -0,0 +1,32 @@
+---
+description: Open the storage inventory from a different script
+sidebar_position: 10
+---
+
+# inventory:openStorage
+
+:::info
+clientside AND serverside
+:::
+
+<span style={{color: 'red'}}>**Parameters**</span>\
+**title** - `string` - Title of the storage container\
+**id** - `string` - Unique id for the the storage container\
+**weight** - `number` - Weight of the storage container\
+**delay** - `number` - Open delay for the container\
+**jobs** - `array` or `string` - Array of jobs that are allowed to access the container
+
+### Clientside
+```lua
+TriggerEvent('inventory:openStorage', "Locker", "locker-1", 100, 1000, {"police", "ambulance"})
+```
+
+### Serverside
+You can use this:
+```lua
+TriggerClientEvent('inventory:openStorage', source, "Locker", "locker-1", 100, 1000, {"police", "ambulance"})
+```
+or you can use this:
+```lua
+xPlayer.triggerEvent("inventory:openShop", "Locker", "locker-1", 100, 1000, {"police", "ambulance"})
+```