blob: 557cc04d89a5d484a339387ece1df759ce37d25d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
package org.bukkit.inventory;
import org.bukkit.entity.HumanEntity;
/**
* Interface to the inventory of a Player, including the four armor slots and any extra slots.
*/
public interface PlayerInventory extends Inventory {
/**
* Get all ItemStacks from the armor slots
*
* @return All the ItemStacks from the armor slots
*/
public ItemStack[] getArmorContents();
/**
* Get all additional ItemStacks stored in this inventory.
* <br>
* NB: What defines an extra slot is up to the implementation, however it
* will not be contained within {@link #getStorageContents()} or
* {@link #getArmorContents()}
*
* @return All additional ItemStacks
*/
public ItemStack[] getExtraContents();
/**
* Return the ItemStack from the helmet slot
*
* @return The ItemStack in the helmet slot
*/
public ItemStack getHelmet();
/**
* Return the ItemStack from the chestplate slot
*
* @return The ItemStack in the chestplate slot
*/
public ItemStack getChestplate();
/**
* Return the ItemStack from the leg slot
*
* @return The ItemStack in the leg slot
*/
public ItemStack getLeggings();
/**
* Return the ItemStack from the boots slot
*
* @return The ItemStack in the boots slot
*/
public ItemStack getBoots();
/**
* Stores the ItemStack at the given index of the inventory.
* <p>
* Indexes 0 through 8 refer to the hotbar. 9 through 35 refer to the main inventory, counting up from 9 at the top
* left corner of the inventory, moving to the right, and moving to the row below it back on the left side when it
* reaches the end of the row. It follows the same path in the inventory like you would read a book.
* <p>
* Indexes 36 through 39 refer to the armor slots. Though you can set armor with this method using these indexes,
* you are encouraged to use the provided methods for those slots.
* <p>
* If you attempt to use this method with an index less than 0 or greater than 39, an ArrayIndexOutOfBounds
* exception will be thrown.
*
* @param index The index where to put the ItemStack
* @param item The ItemStack to set
* @throws ArrayIndexOutOfBoundsException when index < 0 || index > 39
* @see #setBoots(ItemStack)
* @see #setChestplate(ItemStack)
* @see #setHelmet(ItemStack)
* @see #setLeggings(ItemStack)
*/
@Override
public void setItem(int index, ItemStack item);
/**
* Put the given ItemStacks into the armor slots
*
* @param items The ItemStacks to use as armour
*/
public void setArmorContents(ItemStack[] items);
/**
* Put the given ItemStacks into the extra slots
* <br>
* See {@link #getExtraContents()} for an explanation of extra slots.
*
* @param items The ItemStacks to use as extra
*/
public void setExtraContents(ItemStack[] items);
/**
* Put the given ItemStack into the helmet slot. This does not check if
* the ItemStack is a helmet
*
* @param helmet The ItemStack to use as helmet
*/
public void setHelmet(ItemStack helmet);
/**
* Put the given ItemStack into the chestplate slot. This does not check
* if the ItemStack is a chestplate
*
* @param chestplate The ItemStack to use as chestplate
*/
public void setChestplate(ItemStack chestplate);
/**
* Put the given ItemStack into the leg slot. This does not check if the
* ItemStack is a pair of leggings
*
* @param leggings The ItemStack to use as leggings
*/
public void setLeggings(ItemStack leggings);
/**
* Put the given ItemStack into the boots slot. This does not check if the
* ItemStack is a boots
*
* @param boots The ItemStack to use as boots
*/
public void setBoots(ItemStack boots);
/**
* Gets a copy of the item the player is currently holding
* in their main hand.
*
* @return the currently held item
*/
ItemStack getItemInMainHand();
/**
* Sets the item the player is holding in their main hand.
*
* @param item The item to put into the player's hand
*/
void setItemInMainHand(ItemStack item);
/**
* Gets a copy of the item the player is currently holding
* in their off hand.
*
* @return the currently held item
*/
ItemStack getItemInOffHand();
/**
* Sets the item the player is holding in their off hand.
*
* @param item The item to put into the player's hand
*/
void setItemInOffHand(ItemStack item);
/**
* Gets a copy of the item the player is currently holding
*
* @deprecated players can duel wield now use the methods for the
* specific hand instead
* @see #getItemInMainHand()
* @see #getItemInOffHand()
* @return the currently held item
*/
@Deprecated
public ItemStack getItemInHand();
/**
* Sets the item the player is holding
*
* @deprecated players can duel wield now use the methods for the
* specific hand instead
* @see #setItemInMainHand(ItemStack)
* @see #setItemInOffHand(ItemStack)
* @param stack The item to put into the player's hand
*/
@Deprecated
public void setItemInHand(ItemStack stack);
/**
* Get the slot number of the currently held item
*
* @return Held item slot number
*/
public int getHeldItemSlot();
/**
* Set the slot number of the currently held item.
* <p>
* This validates whether the slot is between 0 and 8 inclusive.
*
* @param slot The new slot number
* @throws IllegalArgumentException Thrown if slot is not between 0 and 8
* inclusive
*/
public void setHeldItemSlot(int slot);
/**
* Clears all matching items from the inventory. Setting either value to
* -1 will skip it's check, while setting both to -1 will clear all items
* in your inventory unconditionally.
*
* @param id the id of the item you want to clear from the inventory
* @param data the data of the item you want to clear from the inventory
* @return The number of items cleared
* @deprecated Magic value
*/
@Deprecated
public int clear(int id, int data);
public HumanEntity getHolder();
}
|
