forked from SpongePowered/SpongeAPI
/
InventoryComponent.java
80 lines (71 loc) · 2.72 KB
/
InventoryComponent.java
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
/*
* This file is part of Sponge, licensed under the MIT License (MIT).
*
* Copyright (c) SpongePowered.org <http://www.spongepowered.org>
* Copyright (c) contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.spongepowered.api.inventory;
/**
* Describe a logic subpart of an inventory, e.g. CrafingGrid.
*/
public interface InventoryComponent extends Iterable<ItemStack> {
/**
* @return amount of slots
*/
int getSlotSize();
/**
* Calls {@link org.spongepowered.api.inventory.InventorySystem#getItem(InventoryComponent, SlotType)}
*
* @param type abstraction for the slot index
*
* @return Item stack for a {@link org.spongepowered.api.inventory.SlotType}
*/
ItemStack getItem(SlotType type);
/**
* Calls {@link org.spongepowered.api.inventory.InventorySystem#setItem(InventoryComponent, SlotType, ItemStack)}
*/
boolean setItem(SlotType slot, ItemStack stack);
/**
* Subject to change.
* Calls {@link org.spongepowered.api.inventory.InventorySystem#getItem(InventoryComponent, int)}
*
* @param slot raw slot count for the component
*
* @return Item stack for the raw slot index
*/
ItemStack getItem(int slot);
/**
* Calls {@link org.spongepowered.api.inventory.InventorySystem#setItem(InventoryComponent, int, ItemStack)}
*/
boolean setItem(int slot, ItemStack stack);
/**
* Calls {@link org.spongepowered.api.inventory.InventorySystem#clear(InventoryComponent)} )}
*/
void clear();
/**
* @return get first free slot.
*/
SlotType getFirstAirSlot();
/**
* @return return the entity/parent/inventory
*/
InventoryView getInventory();
}