FumeNodes/jim-consumables
1
0
Fork 0
mirror of https://github.com/jimathy/jim-consumables.git synced 2026-08-17 06:26:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update item example snippet

Browse Source
This commit is contained in:
Jim Shield
2023-02-14 15:10:13 +00:00
committed by GitHub
parent 7996100dad
commit 6ba9febb0a
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -42,6 +42,10 @@ To add an item, you only need to add a new item table in the Config.Consumables
heal = 0, -- Set amount to heal by after consuming heal = 0, -- Set amount to heal by after consuming
armor = 5, -- Amount of armor to add armor = 5, -- Amount of armor to add
type = "food", -- Type: "alcohol" / "drink" / "food" type = "food", -- Type: "alcohol" / "drink" / "food"
returnItem = { -- Item that will be given when the item is used
item = "plastic", -- eg. Plastic bottles can give "plastic"
amount = 1,
},
stats = { stats = {
screen = "rampage", -- The screen effect to be played when after consuming the item screen = "rampage", -- The screen effect to be played when after consuming the item
effect = "heal", -- The status effect given by the item, "heal" / "stamina" effect = "heal", -- The status effect given by the item, "heal" / "stamina"