Package space.maxus.flare.ui.compose

Interface ContainerSlot

All Superinterfaces:

Composable, ComposableLike, Configurable<ContainerSlot>, Disable

public interface ContainerSlot
extends Configurable<ContainerSlot>, Composable, Disable

ContainerSlot is a component that can have an item placed in it.
See more in Flare docs: Container Slot

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ContainerSlot.Builder	Builder for ContainerSlot
static interface	ContainerSlot.ContainerEvent
static interface	ContainerSlot.ContainerPredicate

Nested classes/interfaces inherited from interface space.maxus.flare.ui.compose.Configurable

Configurable.Configurator<S>

Method Summary

Modifier and Type	Method	Description
static @NotNull ContainerSlot.Builder	builder()	Constructs a new container slot builder
static ItemStackBuilder	emptyBuilder(@Nullable String name, @Nullable String description)	Returns item builder for empty container slot item
static @NotNull ItemProvider	emptyItem(@Nullable String name, @Nullable String description)	Returns item provider for empty container slot item
default @Nullable org.bukkit.inventory.ItemStack	getItem()	Gets the item inside this container
ReactiveState<org.bukkit.inventory.ItemStack>	itemState()	Returns the reactive state of an item inside this container
static @NotNull ContainerSlot	of(@NotNull ContainerSlot.ContainerEvent onPut, @NotNull ContainerSlot.ContainerEvent onTake)	Constructs a new container slot with handlers
default void	setItem(@Nullable org.bukkit.inventory.ItemStack stack)	Sets the item inside this container

Methods inherited from interface space.maxus.flare.ui.Composable

asComposable, bind, click, context, contextOrNull, destroy, drag, injectRoot, inside, into, leftClick, markDirty, renderAt, restore, rightClick, root, shiftFrom, shiftInto, viewer

Methods inherited from interface space.maxus.flare.ui.compose.Configurable

configure, configureTyped

Methods inherited from interface space.maxus.flare.ui.compose.Disable

disabledState, isDisabled, isNotDisabled, setDisabled

Method Details

emptyBuilder

static ItemStackBuilder emptyBuilder(@Nullable
 @Nullable String name,
 @Nullable
 @Nullable String description)

Returns item builder for empty container slot item

Parameters:

name - Extra message in item name

description - Extra description

Returns:

Item builder for empty container slot item

emptyItem

@Contract("_, _ -> new")
@NotNull
static @NotNull ItemProvider emptyItem(@Nullable
 @Nullable String name,
 @Nullable
 @Nullable String description)

Returns item provider for empty container slot item

Parameters:

name - Extra message in item name

description - Extra description

Returns:

Item provider for empty container slot item

of

@NotNull
static @NotNull ContainerSlot of(@NotNull
 @NotNull ContainerSlot.ContainerEvent onPut,
 @NotNull
 @NotNull ContainerSlot.ContainerEvent onTake)

Constructs a new container slot with handlers

Parameters:

onPut - Put handler

onTake - Take handler

Returns:

New container slot with handlers

builder

@NotNull
static @NotNull ContainerSlot.Builder builder()

Constructs a new container slot builder

Returns:

New container slot builder

itemState

ReactiveState<org.bukkit.inventory.ItemStack> itemState()

Returns the reactive state of an item inside this container

Returns:

Reactive state of an item inside this container

getItem

@Nullable
default @Nullable org.bukkit.inventory.ItemStack getItem()

Gets the item inside this container

Returns:

Item inside this container

setItem

default void setItem(@Nullable
 @Nullable org.bukkit.inventory.ItemStack stack)

Sets the item inside this container

Parameters:

stack - Item inside this container