me.devnatan.inventoryframework.context

Interface IFSlotContext

All Superinterfaces:

ComponentContainer, IFContext, java.lang.Iterable<Component>, StateValueHost, VirtualView

All Known Subinterfaces:

IFSlotClickContext, IFSlotRenderContext

public interface IFSlotContext
extends IFContext

Represents a context in which there is a specific slot related to it, the main context encompasses the entire container in an actor's view, the ViewSlotContext encapsulates a context for just one slot of a container.

Methods specific to a ViewSlotContext will only apply to that slot.

See Also:

IFContext, IFSlotClickContext

Method Summary

Modifier and Type	Method and Description
@NotNull ViewContainer	getContainer() The container of this context.
IFRenderContext	getParent() The parent context of this context.
int	getSlot() Returns the slot position of this context in the current container.
boolean	isOnEntityContainer() Whether this context originated from an interaction coming from the actor's container and not from the view's container.
void	setSlot(int slot)

Methods inherited from interface me.devnatan.inventoryframework.context.IFContext

addComponent, addViewer, closeForEveryone, getComponentsAt, getConfig, getId, getIndexedViewers, getInitialData, getInitialTitle, getRoot, getViewers, isActive, isShared, openForEveryone, openForEveryone, removeComponent, removeViewer, renderComponent, resetTitleForEveryone, setActive, setInitialData, update, updateComponent, updateTitleForEveryone

Methods inherited from interface me.devnatan.inventoryframework.state.StateValueHost

getInternalStateValue, getRawStateValue, getStateValues, getUninitializedStateValue, initializeState, updateState, watchState

Methods inherited from interface me.devnatan.inventoryframework.component.ComponentContainer

getComponents, getInternalComponents

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getParent

@ApiStatus.Internal
IFRenderContext getParent()

The parent context of this context.

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

Returns:

The parent context of this context.

getSlot

int getSlot()

Returns the slot position of this context in the current container.

Returns:

The slot position of this context.

setSlot

void setSlot(int slot)

isOnEntityContainer

boolean isOnEntityContainer()

Whether this context originated from an interaction coming from the actor's container and not from the view's container.

Returns:

If this context originated from the actor's container

getContainer

@NotNull
@NotNull ViewContainer getContainer()

The container of this context.

The container is where all the changes that are displayed to the user are applied.

Direct modifications to the container must launch an inventory modification error, which signals that that function will change the container for whoever is seeing what, which, if it is not possible at that moment or if the container is not sufficiently prepared for this, it must fail.

Returns:

The container of this context.