Skip to content

Commit bb0b3ed

Browse files
Add SlotElement javadoc
1 parent 2ed3857 commit bb0b3ed

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

invui/src/main/java/xyz/xenondevs/invui/gui/SlotElement.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,27 @@
1313
*/
1414
public sealed interface SlotElement {
1515

16+
/**
17+
* Gets the {@link ItemStack} that should be displayed in the slot.
18+
*
19+
* @param player The player viewing the {@link ItemStack}
20+
* @return The {@link ItemStack} that should be displayed in the slot
21+
*/
1622
@Nullable
1723
ItemStack getItemStack(Player player);
1824

25+
/**
26+
* Gets the {@link SlotElement} that is actually holding the {@link ItemStack}.
27+
*
28+
* @return The {@link SlotElement} that is actually holding the {@link ItemStack}
29+
*/
1930
@Nullable
2031
SlotElement getHoldingElement();
2132

2233
/**
2334
* Contains an {@link xyz.xenondevs.invui.item.Item}
35+
*
36+
* @param item The {@link xyz.xenondevs.invui.item.Item}
2437
*/
2538
record Item(xyz.xenondevs.invui.item.Item item) implements SlotElement {
2639

0 commit comments

Comments
 (0)