Skip to content

Commit 0a6fe18

Browse files
committed
updating docs on inventory module to include enchantment code
1 parent de54d88 commit 0a6fe18

3 files changed

Lines changed: 34 additions & 14 deletions

File tree

docs/API-Reference.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4963,23 +4963,33 @@ var inventory = require('inventory');
49634963
var items = require('items');
49644964
var utils = require('utils');
49654965

4966-
// gives every player a cookie and a baked potatoe
4967-
utils.players(function(player){
4968-
inventory(player)
4969-
.add( items.cookie(1) )
4970-
.add( items.bakedPotato(1) )
4966+
// gives every player 2 cookies and a baked potatoe
4967+
var bakedPotato = items.bakedPotato(1);
4968+
var cookies2 = items.cookie(2);
4969+
4970+
utils.players(function( player ){
4971+
inventory( player )
4972+
.add( cookies2 )
4973+
.add( bakedPotato )
49714974
});
49724975

49734976
// give a player 6 cookies then take away 4 of them
49744977

4975-
inventory(player)
4978+
inventory( player )
49764979
.add( items.cookie(6) )
49774980
.remove ( items.cookie(4) )
49784981

49794982
// check if a player has any cookies
49804983

49814984
var hasCookies = inventory(player).contains( items.cookie(1) );
49824985

4986+
// Enchant an item and give it to the player (CraftBukkit/Spigot only)
4987+
4988+
var luck = org.bukkit.enchantments.Enchantment.getByName("LUCK");
4989+
var luckyRod = items.fishingRod( 1 );
4990+
luckyRod.addEnchantment( luck, 3);
4991+
inventory( player ).add( luckyRod );
4992+
49834993
```
49844994
The inventory module exposes a single function which when passed a player or NPC will return an object with 3 methods:
49854995

@@ -6365,7 +6375,7 @@ See https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html for a list
63656375
### Usage
63666376
63676377
items.book(); // returns org.bukkit.Material.BOOK
6368-
items.book(2); // returns a new org.bukkit.Material object with an amount 2 (2 books)
6378+
items.book(2); // returns a new org.bukkit.inventory.ItemStack object of 2 books
63696379
items.book( itemType ); // compares itemType parameter to org.bukkit.Material.BOOK or an Item of type book
63706380
63716381
The following functions are provided:

src/docs/js/generateItemsDoc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ var content = [
1010
'### Usage',
1111
'',
1212
' items.book(); // returns org.bukkit.Material.BOOK',
13-
' items.book(2); // returns a new org.bukkit.Material object with an amount 2 (2 books)',
13+
' items.book(2); // returns a new org.bukkit.inventory.ItemStack object of 2 books',
1414
' items.book( itemType ); // compares itemType parameter to org.bukkit.Material.BOOK or an Item of type book',
1515
'',
1616
'The following functions are provided:',

src/main/js/modules/inventory/index.js

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,33 @@ var inventory = require('inventory');
1111
var items = require('items');
1212
var utils = require('utils');
1313
14-
// gives every player a cookie and a baked potatoe
15-
utils.players(function(player){
16-
inventory(player)
17-
.add( items.cookie(1) )
18-
.add( items.bakedPotato(1) )
14+
// gives every player 2 cookies and a baked potatoe
15+
var bakedPotato = items.bakedPotato(1);
16+
var cookies2 = items.cookie(2);
17+
18+
utils.players(function( player ){
19+
inventory( player )
20+
.add( cookies2 )
21+
.add( bakedPotato )
1922
});
2023
2124
// give a player 6 cookies then take away 4 of them
2225
23-
inventory(player)
26+
inventory( player )
2427
.add( items.cookie(6) )
2528
.remove ( items.cookie(4) )
2629
2730
// check if a player has any cookies
2831
2932
var hasCookies = inventory(player).contains( items.cookie(1) );
3033
34+
// Enchant an item and give it to the player (CraftBukkit/Spigot only)
35+
36+
var luck = org.bukkit.enchantments.Enchantment.getByName("LUCK");
37+
var luckyRod = items.fishingRod( 1 );
38+
luckyRod.addEnchantment( luck, 3);
39+
inventory( player ).add( luckyRod );
40+
3141
```
3242
The inventory module exposes a single function which when passed a player or NPC will return an object with 3 methods:
3343

0 commit comments

Comments
 (0)