me.devnatan.inventoryframework.context

Interface IFSlotClickContext

All Superinterfaces:

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

public interface IFSlotClickContext
extends IFSlotContext, IFConfinedContext

The click context represents an interaction between the actor and the container, even if an item is not present, it stores information about the click, and it's origin.

See Also:

IFSlotContext

Method Summary

Modifier and Type	Method and Description
@NotNull ViewContainer	getClickedContainer()
int	getClickedSlot()
default java.lang.String	getClickIdentifier() The click identifier, available only in cases where the library does not cover all types of clicks, so you can discover the type of click through its identifier.
Component	getComponent()
java.lang.Object	getPlatformEvent() This is an internal inventory-framework API that should not be used from outside of this library.
boolean	isCancelled() If the click was cancelled.
boolean	isCombined() This is an internal inventory-framework API that should not be used from outside of this library.
boolean	isKeyboardClick() If the click source came from a keyboard, e.g.
boolean	isLeftClick() If the click was using the left mouse button.
boolean	isMiddleClick() If the click was using the middle mouse button, commonly known as the scroll button.
boolean	isOutsideClick() If the click did not occur within any containers.
boolean	isRightClick() If the click was using the right mouse button.
boolean	isShiftClick() If the click was accompanied by a click holding the keyboard shift button.
default boolean	isShiftLeftClick()
default boolean	isShiftRightClick()
void	setCancelled(boolean cancelled) Cancels the click.

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

getContainer, getParent, getSlot, isOnEntityContainer, setSlot

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

back, back, canBack, closeForPlayer, getViewer, openForPlayer, openForPlayer, resetTitleForPlayer, updateTitleForPlayer

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

addComponent, addViewer, closeForEveryone, getComponentsAt, getConfig, getId, getIndexedViewers, getInitialData, getInitialTitle, getRoot, getViewers, isActive, isEndless, isShared, openForEveryone, openForEveryone, performClickInComponent, removeComponent, removeViewer, renderComponent, resetTitleForEveryone, setActive, setEndless, 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

getClickedContainer

@NotNull
@NotNull ViewContainer getClickedContainer()

getComponent

Component getComponent()

getClickedSlot

int getClickedSlot()

isLeftClick

boolean isLeftClick()

If the click was using the left mouse button.

Returns:

If the click was using the left mouse button.

isRightClick

boolean isRightClick()

If the click was using the right mouse button.

Returns:

If the click was using the right mouse button.

isMiddleClick

boolean isMiddleClick()

If the click was using the middle mouse button, commonly known as the scroll button.

Returns:

If the click was using the middle mouse button.

isShiftClick

boolean isShiftClick()

If the click was accompanied by a click holding the keyboard shift button.

Returns:

If it was a click holding the keyboard shift button.

isShiftLeftClick

default boolean isShiftLeftClick()

isShiftRightClick

default boolean isShiftRightClick()

isKeyboardClick

boolean isKeyboardClick()

If the click source came from a keyboard, e.g. the player's toolbar number.

Returns:

If the click source came from a keyboard.

isOutsideClick

boolean isOutsideClick()

If the click did not occur within any containers.

Returns:

If the click did not occur within any containers.

getClickIdentifier

default java.lang.String getClickIdentifier()

The click identifier, available only in cases where the library does not cover all types of clicks, so you can discover the type of click through its identifier.

Returns:

The click type identifier. Can be null if the click type is known or a platform doesn't implement an identifier.

isCancelled

boolean isCancelled()

If the click was cancelled.

Returns:

If the click was cancelled.

setCancelled

void setCancelled(boolean cancelled)

Cancels the click.

Parameters:

cancelled - If the click should be cancelled.

getPlatformEvent

@ApiStatus.Internal
java.lang.Object getPlatformEvent()

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

isCombined

@ApiStatus.Internal
boolean isCombined()

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