Index

A B C D E F G H I K L M N O P R S T U V W 
All Classes and Interfaces|All Packages

A

AbstractItemBuilder<B,C> - Class in studio.mevera.lotus.api.item
Abstract fluent builder for ItemStack instances.
AbstractItemBuilder(Material) - Constructor for class studio.mevera.lotus.api.item.AbstractItemBuilder
 
AbstractLotusListener<C> - Class in studio.mevera.lotus.internal
Shared listener logic that is agnostic to the platform-specific InventoryView ABI.
AbstractLotusListener(Lotus<C>) - Constructor for class studio.mevera.lotus.internal.AbstractLotusListener
 
AbstractPageContext<C,T,P> - Class in studio.mevera.lotus.api.pagination
Read-only snapshot of a page's position within its session, passed to layout/renderer hooks.
AbstractPageContext(int, int, Player, P) - Constructor for class studio.mevera.lotus.api.pagination.AbstractPageContext
 
AbstractPagination<C,T,X> - Class in studio.mevera.lotus.api.pagination
Immutable, viewer-agnostic definition of a paginated menu.
AbstractPagination(String, PageLayout<C, X>, ContentSource<T>, ComponentRenderer<T, X>, boolean) - Constructor for class studio.mevera.lotus.api.pagination.AbstractPagination
 
AbstractPagination.Builder<C,T,X,P> - Class in studio.mevera.lotus.api.pagination
 
action() - Method in record class studio.mevera.lotus.api.button.ClickableButton
Returns the value of the action record component.
action() - Method in record class studio.mevera.lotus.api.button.SpanningButton
Returns the value of the action record component.
add(Button) - Method in interface studio.mevera.lotus.api.content.Content
Places the button into the first empty slot, returning that slot if one was found.
advanced() - Method in record class studio.mevera.lotus.api.button.CycleButton
 
allowBottomInventoryClick() - Method in record class studio.mevera.lotus.Lotus.Options
Returns the value of the allowBottomInventoryClick record component.
allowBottomInventoryClick(boolean) - Method in class studio.mevera.lotus.LotusBuilder
 
amount - Variable in class studio.mevera.lotus.api.item.AbstractItemBuilder
 
amount(int) - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
Sets the item stack size.
andThen(ClickAction) - Method in interface studio.mevera.lotus.api.button.ClickAction
Returns an action that runs this action first, then next.
apply(Consumer<Content>) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
at(int, int, Capacity) - Static method in record class studio.mevera.lotus.api.slot.Slot
 

B

base() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
Returns the value of the base record component.
BaseMenuView<C,M> - Class in studio.mevera.lotus.internal.menu
Reference MenuView implementation.
BaseMenuView(Lotus<C>, M, Player, DataRegistry) - Constructor for class studio.mevera.lotus.internal.menu.BaseMenuView
 
bounded(Capacity, Slot, Slot, Direction) - Static method in class studio.mevera.lotus.api.slot.SlotIterator
 
build() - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
build() - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
Builds and returns the configured ItemStack.
build() - Method in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
build() - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
build() - Method in class studio.mevera.lotus.LotusBuilder
 
builder(Capacity) - Static method in interface studio.mevera.lotus.api.content.Content
Creates a builder for the given capacity.
builder(Capacity) - Static method in interface studio.mevera.lotus.api.pagination.PageLayout
Creates a generic builder for the given capacity.
Builder(String) - Constructor for class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
buildPageMenu(int) - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
Factory method for constructing the page menu for a given index.
Button - Interface in studio.mevera.lotus.api.button
Sealed root of the button algebra.
buttons(Map<Slot, Button>) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 

C

capacity() - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
capacity() - Method in interface studio.mevera.lotus.api.content.ContentView
Returns the capacity this content was created for.
capacity() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the resolved capacity.
capacity() - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the page capacity.
capacity() - Method in interface studio.mevera.lotus.api.slot.SlotMask
 
capacity() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
Returns the value of the capacity record component.
capacity() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
 
capacity() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
Returns the value of the capacity record component.
capacity() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
Returns the value of the capacity record component.
capacity() - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
capacity() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
capacity(MenuView<C, ?>) - Method in interface studio.mevera.lotus.api.menu.Menu
Returns the capacity for the current view.
Capacity - Class in studio.mevera.lotus.api.slot
Immutable description of a menu's grid dimensions.
Capacity(int, int) - Constructor for class studio.mevera.lotus.api.slot.Capacity
 
children() - Method in record class studio.mevera.lotus.api.button.CompositeButton
Returns the value of the children record component.
clear() - Method in interface studio.mevera.lotus.api.content.ContentEditor
Removes all buttons.
clear() - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
clickable(ItemStack, ClickAction) - Static method in interface studio.mevera.lotus.api.button.Button
 
ClickableButton - Record Class in studio.mevera.lotus.api.button
 
ClickableButton(ItemStack, ClickAction, DataRegistry) - Constructor for record class studio.mevera.lotus.api.button.ClickableButton
Creates an instance of a ClickableButton record class.
ClickAction - Interface in studio.mevera.lotus.api.button
Action that runs when a button is clicked.
close() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Closes the session and the viewer's inventory.
close() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
column(Capacity) - Method in record class studio.mevera.lotus.api.slot.Slot
 
columnDelta() - Method in enum class studio.mevera.lotus.api.slot.Direction
 
columns() - Method in class studio.mevera.lotus.api.slot.Capacity
 
compareTo(Slot) - Method in record class studio.mevera.lotus.api.slot.Slot
 
ComponentRenderer<T,X> - Interface in studio.mevera.lotus.api.pagination
Converts one page item into a Button.
composite(ItemStack, Button...) - Static method in interface studio.mevera.lotus.api.button.Button
 
CompositeButton - Record Class in studio.mevera.lotus.api.button
A button that aggregates several child buttons under a single display item, dispatching each child in declaration order on click.
CompositeButton(ItemStack, List<Button>, DataRegistry) - Constructor for record class studio.mevera.lotus.api.button.CompositeButton
Creates an instance of a CompositeButton record class.
contains(int) - Method in class studio.mevera.lotus.api.slot.Capacity
 
contains(Key<?>) - Method in class studio.mevera.lotus.api.data.DataRegistry
 
contains(Slot) - Method in interface studio.mevera.lotus.api.slot.SlotMask
 
contains(Slot) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
 
contains(Slot) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
 
contains(Slot) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
 
contains(Slot) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
 
content() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the current content.
content() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
content(MenuView<C, ?>) - Method in interface studio.mevera.lotus.api.menu.Menu
Builds the content for the current view.
Content - Interface in studio.mevera.lotus.api.content
Full read-write content for a menu.
ContentBuilder - Class in studio.mevera.lotus.api.content
Fluent builder for Content.
ContentEditor - Interface in studio.mevera.lotus.api.content
Write operations for menu content.
ContentSource<T> - Interface in studio.mevera.lotus.api.pagination
Supplies the items that a pagination session will show.
ContentView - Interface in studio.mevera.lotus.api.content
Read-only view of a menu's buttons.
create(AbstractPagination<C, T, X>, Lotus<C>, Player) - Method in interface studio.mevera.lotus.spi.PaginationSessionFactory
Creates a new PaginationSession for the given definition and viewer.
create(PageLayout<C, X>, ContentSource<T>, ComponentRenderer<T, X>, boolean) - Method in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
current() - Method in record class studio.mevera.lotus.api.button.CycleButton
Returns the currently active child button.
currentIndex() - Method in record class studio.mevera.lotus.api.button.CycleButton
Returns the value of the currentIndex record component.
currentIndex() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Returns the current page index.
currentIndex() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
Custom(Capacity, Set<Slot>) - Constructor for record class studio.mevera.lotus.api.slot.SlotMask.Custom
Creates an instance of a Custom record class.
cycle(Button...) - Static method in interface studio.mevera.lotus.api.button.Button
 
CycleButton - Record Class in studio.mevera.lotus.api.button
A multi-state button that advances through its CycleButton.states() on each click.
CycleButton(List<Button>, int, DataRegistry) - Constructor for record class studio.mevera.lotus.api.button.CycleButton
Creates an instance of a CycleButton record class.

D

data() - Method in interface studio.mevera.lotus.api.button.Button
 
data() - Method in record class studio.mevera.lotus.api.button.ClickableButton
Returns the value of the data record component.
data() - Method in record class studio.mevera.lotus.api.button.CompositeButton
Returns the value of the data record component.
data() - Method in record class studio.mevera.lotus.api.button.CycleButton
Returns the value of the data record component.
data() - Method in record class studio.mevera.lotus.api.button.SpanningButton
Returns the value of the data record component.
data() - Method in record class studio.mevera.lotus.api.button.StaticButton
Returns the value of the data record component.
data() - Method in record class studio.mevera.lotus.api.button.TransformingButton
Returns the value of the data record component.
data() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the per-view data registry.
data() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
DataRegistry - Class in studio.mevera.lotus.api.data
Type-safe heterogeneous container keyed by Key.
debug() - Method in record class studio.mevera.lotus.Lotus.Options
Returns the value of the debug record component.
debug(boolean) - Method in class studio.mevera.lotus.LotusBuilder
 
debug(String) - Method in class studio.mevera.lotus.internal.LotusLogger
 
decorations(Function<X, Content>) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
decorations(X) - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the static decorations for the current page.
DefaultContent - Class in studio.mevera.lotus.internal.content
Default Content implementation backed by a HashMap<Slot, Button>.
DefaultContent(Capacity) - Constructor for class studio.mevera.lotus.internal.content.DefaultContent
 
DefaultPaginationSession<C,T,X> - Class in studio.mevera.lotus.internal.pagination
Per-player pagination runtime.
DefaultPaginationSession(AbstractPagination<C, T, X>, Lotus<C>, Player) - Constructor for class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
defaults() - Static method in record class studio.mevera.lotus.Lotus.Options
 
defaultViewOpener(ViewOpener<C>) - Method in class studio.mevera.lotus.LotusBuilder
Sets the fallback ViewOpener used for all inventory types not explicitly registered via Lotus.registerOpener(org.bukkit.event.inventory.InventoryType, ViewOpener).
definition - Variable in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
definition() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Returns the shared pagination definition.
definition() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
Direction - Enum Class in studio.mevera.lotus.api.slot
Traversal direction across a menu grid.
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in interface studio.mevera.lotus.api.button.Button
 
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in record class studio.mevera.lotus.api.button.ClickableButton
 
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in record class studio.mevera.lotus.api.button.CompositeButton
 
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in record class studio.mevera.lotus.api.button.CycleButton
 
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in record class studio.mevera.lotus.api.button.SpanningButton
 
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in record class studio.mevera.lotus.api.button.StaticButton
 
dispatch(MenuView<?, ?>, InventoryClickEvent) - Method in record class studio.mevera.lotus.api.button.TransformingButton
 
displayName(C) - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
Sets the display name of the item.
DOWN - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
DOWN_LEFT - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
DOWN_RIGHT - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
draw(Slot, Direction, Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
draw(Slot, Slot, Direction, Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
dynamic(Function<Player, List<T>>) - Static method in interface studio.mevera.lotus.api.pagination.ContentSource
Returns a source backed by a function.
dynamicButtonAction() - Method in record class studio.mevera.lotus.Lotus.Options
Returns the value of the dynamicButtonAction record component.
dynamicButtonAction(boolean) - Method in class studio.mevera.lotus.LotusBuilder
 

E

empty() - Static method in class studio.mevera.lotus.api.data.DataRegistry
 
empty(Capacity) - Static method in interface studio.mevera.lotus.api.content.Content
Creates an empty content object for the given capacity.
entries() - Method in interface studio.mevera.lotus.api.content.ContentView
Returns the stored entries as a stream.
entries() - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
equals(Object) - Method in record class studio.mevera.lotus.api.button.ClickableButton
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.button.CompositeButton
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.button.CycleButton
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.button.SpanningButton
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.button.StaticButton
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.button.TransformingButton
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class studio.mevera.lotus.api.data.Key
 
equals(Object) - Method in class studio.mevera.lotus.api.slot.Capacity
 
equals(Object) - Method in record class studio.mevera.lotus.api.slot.Slot
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.api.util.Pair
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class studio.mevera.lotus.Lotus.Options
Indicates whether some other object is "equal to" this one.
excluded() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
Returns the value of the excluded record component.
excluding(Set<Slot>) - Method in interface studio.mevera.lotus.api.slot.SlotMask
 
excluding(Set<Slot>) - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
 
excluding(Slot...) - Method in interface studio.mevera.lotus.api.slot.SlotMask
 
Excluding(SlotMask, Set<Slot>) - Constructor for record class studio.mevera.lotus.api.slot.SlotMask.Excluding
Creates an instance of a Excluding record class.

F

fill(SlotMask, Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
fill(SlotMask, Button) - Method in interface studio.mevera.lotus.api.content.ContentEditor
Fills all slots in the mask with the same button.
fill(SlotMask, Button) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
fillAll(Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
fillBorder(Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
fillMask() - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the slots used for page items.
fillMask(SlotMask) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
first() - Static method in record class studio.mevera.lotus.api.slot.Slot
 
footprint() - Method in record class studio.mevera.lotus.api.button.SpanningButton
Returns the value of the footprint record component.
forEach(BiConsumer<Slot, Button>) - Method in interface studio.mevera.lotus.api.content.ContentView
Visits every stored button.
forEach(BiConsumer<Slot, Button>) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
from() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
Returns the value of the from record component.
full(Capacity) - Static method in interface studio.mevera.lotus.api.slot.SlotMask
 
Full(Capacity) - Constructor for record class studio.mevera.lotus.api.slot.SlotMask.Full
Creates an instance of a Full record class.

G

get(Key<T>) - Method in class studio.mevera.lotus.api.data.DataRegistry
 
get(Slot) - Method in interface studio.mevera.lotus.api.content.ContentView
Returns the button at the given slot, if one exists.
get(Slot) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
getId() - Method in class studio.mevera.lotus.api.pagination.AbstractPagination
 
getInventory() - Method in interface studio.mevera.lotus.api.menu.MenuView
 
getInventory() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
getOrNull(Key<T>) - Method in class studio.mevera.lotus.api.data.DataRegistry
 
goTo(int) - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Opens the given page index.
goTo(int) - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
growing(int) - Static method in class studio.mevera.lotus.api.slot.Capacity
 

H

handleClick(InventoryClickEvent) - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
handleClick(InventoryClickEvent, Inventory, Inventory) - Method in class studio.mevera.lotus.internal.AbstractLotusListener
 
handleClose(InventoryCloseEvent) - Method in class studio.mevera.lotus.internal.AbstractLotusListener
 
handleClose(InventoryCloseEvent) - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
handleDrag(InventoryDragEvent) - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
handleDrag(InventoryDragEvent, Inventory) - Method in class studio.mevera.lotus.internal.AbstractLotusListener
 
handleOpen(InventoryOpenEvent) - Method in class studio.mevera.lotus.internal.AbstractLotusListener
 
handleOpen(InventoryOpenEvent) - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
handleQuit(Player) - Method in class studio.mevera.lotus.internal.AbstractLotusListener
 
hashCode() - Method in record class studio.mevera.lotus.api.button.ClickableButton
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.button.CompositeButton
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.button.CycleButton
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.button.SpanningButton
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.button.StaticButton
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.button.TransformingButton
Returns a hash code value for this object.
hashCode() - Method in class studio.mevera.lotus.api.data.Key
 
hashCode() - Method in class studio.mevera.lotus.api.slot.Capacity
 
hashCode() - Method in record class studio.mevera.lotus.api.slot.Slot
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.api.util.Pair
Returns a hash code value for this object.
hashCode() - Method in record class studio.mevera.lotus.Lotus.Options
Returns a hash code value for this object.
hasNext() - Method in class studio.mevera.lotus.api.slot.SlotIterator
 

I

id - Variable in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
index() - Method in record class studio.mevera.lotus.api.slot.Slot
Returns the value of the index record component.
InteractiveMenu<C> - Interface in studio.mevera.lotus.api.menu
Menu type that includes both layout and event hooks.
inverse() - Method in enum class studio.mevera.lotus.api.slot.Direction
 
isEmpty() - Method in interface studio.mevera.lotus.api.content.ContentView
Returns whether no buttons are present.
isEmpty() - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
isFirst() - Method in class studio.mevera.lotus.api.pagination.AbstractPageContext
 
isFirst() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Returns whether the current page is the first page.
isLast() - Method in class studio.mevera.lotus.api.pagination.AbstractPageContext
 
isLast() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Returns whether the current page is the last page.
isOpen() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns whether the view is currently open.
isOpen() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
item() - Method in interface studio.mevera.lotus.api.button.Button
 
item() - Method in record class studio.mevera.lotus.api.button.ClickableButton
Returns the value of the item record component.
item() - Method in record class studio.mevera.lotus.api.button.CompositeButton
Returns the value of the item record component.
item() - Method in record class studio.mevera.lotus.api.button.CycleButton
 
item() - Method in record class studio.mevera.lotus.api.button.SpanningButton
Returns the value of the item record component.
item() - Method in record class studio.mevera.lotus.api.button.StaticButton
Returns the value of the item record component.
item() - Method in record class studio.mevera.lotus.api.button.TransformingButton
Returns the value of the item record component.
itemsPerPage - Variable in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 

K

Key<T> - Class in studio.mevera.lotus.api.data
Strongly-typed identifier for values stored in a DataRegistry.

L

last(Capacity) - Static method in record class studio.mevera.lotus.api.slot.Slot
 
layout() - Method in class studio.mevera.lotus.api.pagination.AbstractPagination
 
layout(PageLayout<C, X>) - Method in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
left() - Method in record class studio.mevera.lotus.api.util.Pair
Returns the value of the left record component.
LEFT - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
logger() - Method in class studio.mevera.lotus.Lotus
 
lore(C...) - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
 
lore(List<C>) - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
Sets the lore of the item.
lotus - Variable in class studio.mevera.lotus.internal.AbstractLotusListener
 
lotus - Variable in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
lotus() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the Lotus runtime that owns this view.
lotus() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
Lotus<C> - Class in studio.mevera.lotus
Facade and runtime for the Lotus menu framework.
Lotus.Options - Record Class in studio.mevera.lotus
Immutable runtime configuration.
LotusBuilder<C> - Class in studio.mevera.lotus
Builder for Lotus.
LotusBuilder(Plugin, Consumer<Lotus<C>>) - Constructor for class studio.mevera.lotus.LotusBuilder
 
LotusLogger - Class in studio.mevera.lotus.internal
Thin logger wrapper that gates debug on a flag from Lotus.Options.
LotusLogger(Logger, boolean) - Constructor for class studio.mevera.lotus.internal.LotusLogger
 

M

material - Variable in class studio.mevera.lotus.api.item.AbstractItemBuilder
 
menu() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the menu template behind this view.
menu() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
Menu<C> - Interface in studio.mevera.lotus.api.menu
Defines the layout of a menu.
MenuHandler<C> - Interface in studio.mevera.lotus.api.menu
Optional event hooks for a Menu.
MenuView<C,M> - Interface in studio.mevera.lotus.api.menu
Live view of a Menu for one player.
mergeWith(ContentView) - Method in interface studio.mevera.lotus.api.content.Content
Returns a new content object with entries from both sources.
mergeWith(ContentView) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 

N

name() - Method in class studio.mevera.lotus.api.data.Key
 
name() - Method in interface studio.mevera.lotus.api.menu.Menu
Returns the menu name used for registration and logging.
next() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Opens the next page when possible.
next() - Method in class studio.mevera.lotus.api.slot.SlotIterator
 
next() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
nextButton(Function<X, Button>) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
nextButton(Slot, Function<X, Button>) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
nextButton(X) - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the next-page button.
nextButtonSlot() - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the slot used by the next-page button.
nextEmpty(Slot) - Method in interface studio.mevera.lotus.api.content.ContentView
Returns the next empty slot starting from from.
nextEmpty(Slot) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 

O

of(int) - Static method in record class studio.mevera.lotus.api.slot.Slot
 
of(String, Class<T>) - Static method in class studio.mevera.lotus.api.data.Key
 
of(List<T>) - Static method in interface studio.mevera.lotus.api.pagination.ContentSource
Returns a source backed by a fixed list.
of(L, R) - Static method in record class studio.mevera.lotus.api.util.Pair
 
of(InventoryType) - Static method in class studio.mevera.lotus.api.slot.Capacity
 
of(ItemStack) - Static method in interface studio.mevera.lotus.api.button.Button
 
of(Capacity, Set<Slot>) - Static method in interface studio.mevera.lotus.api.slot.SlotMask
 
of(Capacity, Slot, Direction) - Static method in class studio.mevera.lotus.api.slot.SlotIterator
 
ofRows(int) - Static method in class studio.mevera.lotus.api.slot.Capacity
 
onClick(MenuView<?, ?>, InventoryClickEvent) - Method in interface studio.mevera.lotus.api.button.ClickAction
Handles the click.
onClose(MenuView<C, ?>, InventoryCloseEvent) - Method in interface studio.mevera.lotus.api.menu.MenuHandler
Runs when the menu is closed.
onDrag(MenuView<C, ?>, InventoryDragEvent) - Method in interface studio.mevera.lotus.api.menu.MenuHandler
Runs when the menu receives a drag event.
onOpen(MenuView<C, ?>, InventoryOpenEvent) - Method in interface studio.mevera.lotus.api.menu.MenuHandler
Runs when the menu is opened.
onPostClick(MenuView<C, ?>, InventoryClickEvent) - Method in interface studio.mevera.lotus.api.menu.MenuHandler
Runs after button dispatch.
onPreClick(MenuView<C, ?>, InventoryClickEvent) - Method in interface studio.mevera.lotus.api.menu.MenuHandler
Runs before button dispatch.
open(Lotus<C>, Player) - Method in class studio.mevera.lotus.api.pagination.AbstractPagination
Resolves source items for this viewer, creates a per-player session via the PaginationSessionFactory registered on Lotus, and opens page 0.
open(Lotus<C>, MenuView<C, ?>) - Method in interface studio.mevera.lotus.spi.opener.ViewOpener
Creates and opens the inventory for the given view.
open(ViewOpener<C>) - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
openerFor(InventoryType) - Method in class studio.mevera.lotus.Lotus
 
openMenu(Player, String) - Method in class studio.mevera.lotus.Lotus
 
openMenu(Player, M) - Method in class studio.mevera.lotus.Lotus
 
openMenu(Player, M, DataRegistry) - Method in class studio.mevera.lotus.Lotus
 
openViews() - Method in class studio.mevera.lotus.Lotus
 
options() - Method in class studio.mevera.lotus.Lotus
 
Options(boolean, boolean, boolean) - Constructor for record class studio.mevera.lotus.Lotus.Options
Creates an instance of a Options record class.

P

pageIndex() - Method in class studio.mevera.lotus.api.pagination.AbstractPageContext
 
PageLayout<C,X> - Interface in studio.mevera.lotus.api.pagination
Defines the shared layout for all pages in a pagination.
PageLayoutBuilder<C,X> - Class in studio.mevera.lotus.api.pagination
Generic builder for PageLayout.
PageLayoutBuilder(Capacity) - Constructor for class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
PaginationSession<C,T,X> - Interface in studio.mevera.lotus.api.pagination
Live pagination state for one player.
paginationSessionFactory(PaginationSessionFactory<C>) - Method in class studio.mevera.lotus.LotusBuilder
 
PaginationSessionFactory<C> - Interface in studio.mevera.lotus.spi
Strategy that constructs per-player PaginationSession instances.
Pair<L,R> - Record Class in studio.mevera.lotus.api.util
 
Pair(L, R) - Constructor for record class studio.mevera.lotus.api.util.Pair
Creates an instance of a Pair record class.
placeSpanning(SpanningButton) - Method in interface studio.mevera.lotus.api.content.ContentEditor
Places the same spanning button into every slot in its footprint.
plugin() - Method in class studio.mevera.lotus.Lotus
 
previous() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Opens the previous page when possible.
previous() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
previousButton(Function<X, Button>) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
previousButton(Slot, Function<X, Button>) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
previousButton(X) - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the previous-page button.
previousButtonSlot() - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the slot used by the previous-page button.
provide(Player) - Method in interface studio.mevera.lotus.api.pagination.ContentSource
Returns the full item list for the viewer.
put(Key<T>, T) - Method in class studio.mevera.lotus.api.data.DataRegistry
 

R

range(Capacity, Slot, Slot) - Static method in interface studio.mevera.lotus.api.slot.SlotMask
 
Range(Capacity, Slot, Slot) - Constructor for record class studio.mevera.lotus.api.slot.SlotMask.Range
Creates an instance of a Range record class.
rebuildState() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
refresh() - Method in interface studio.mevera.lotus.api.menu.MenuView
Rebuilds the resolved menu state and reapplies it to the live inventory.
refresh() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
registeredMenu(String) - Method in class studio.mevera.lotus.Lotus
 
registerMenu(Menu<C>) - Method in class studio.mevera.lotus.Lotus
 
registerOpener(InventoryType, ViewOpener) - Method in class studio.mevera.lotus.Lotus
 
reload() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Rebuilds the session snapshot and reopens the current page from scratch.
reload() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
remove(Key<?>) - Method in class studio.mevera.lotus.api.data.DataRegistry
 
remove(Slot) - Method in interface studio.mevera.lotus.api.content.ContentEditor
Removes the button at the given slot.
remove(Slot) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
render(T, X) - Method in interface studio.mevera.lotus.api.pagination.ComponentRenderer
Creates the button to show for the given item.
renderer() - Method in class studio.mevera.lotus.api.pagination.AbstractPagination
 
renderer(ComponentRenderer<T, X>) - Method in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
renderInto(Inventory) - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
require(Key<T>) - Method in class studio.mevera.lotus.api.data.DataRegistry
 
resolve() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
Resolves capacity and content from the template.
resolveView(Player) - Method in class studio.mevera.lotus.Lotus
 
right() - Method in record class studio.mevera.lotus.api.util.Pair
Returns the value of the right record component.
RIGHT - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
row(Capacity) - Method in record class studio.mevera.lotus.api.slot.Slot
 
rowDelta() - Method in enum class studio.mevera.lotus.api.slot.Direction
 
rows() - Method in class studio.mevera.lotus.api.slot.Capacity
 

S

self() - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
Returns this builder cast to B, enabling fluent method chaining in subclasses.
session() - Method in class studio.mevera.lotus.api.pagination.AbstractPageContext
 
sessionFactory() - Method in class studio.mevera.lotus.Lotus
 
sessionFactory(PaginationSessionFactory<C>) - Method in class studio.mevera.lotus.Lotus
 
set(int, int, Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
set(Slot, Button) - Method in class studio.mevera.lotus.api.content.ContentBuilder
 
set(Slot, Button) - Method in interface studio.mevera.lotus.api.content.ContentEditor
Sets or clears the button at the given slot.
set(Slot, Button) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
size() - Method in interface studio.mevera.lotus.api.content.ContentView
Returns the number of occupied slots.
size() - Method in class studio.mevera.lotus.api.data.DataRegistry
 
size() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
 
size() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
 
size() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
 
size() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
 
size() - Method in interface studio.mevera.lotus.api.slot.SlotMask
 
size() - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
sliceFor(int) - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
Slot - Record Class in studio.mevera.lotus.api.slot
Position within a menu, identified by its raw inventory index.
Slot(int) - Constructor for record class studio.mevera.lotus.api.slot.Slot
Creates an instance of a Slot record class.
SlotIterator - Class in studio.mevera.lotus.api.slot
Stateful iterator that walks a menu grid in a given Direction, optionally bounded by an end slot.
SlotMask - Interface in studio.mevera.lotus.api.slot
Declarative description of which slots are usable within a Capacity.
SlotMask.Custom - Record Class in studio.mevera.lotus.api.slot
 
SlotMask.Excluding - Record Class in studio.mevera.lotus.api.slot
 
SlotMask.Full - Record Class in studio.mevera.lotus.api.slot
 
SlotMask.Range - Record Class in studio.mevera.lotus.api.slot
 
slots() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
Returns the value of the slots record component.
snapshot - Variable in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
source() - Method in class studio.mevera.lotus.api.pagination.AbstractPagination
 
source(ContentSource<T>) - Method in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
spanning(ItemStack, Set<Slot>, ClickAction) - Static method in interface studio.mevera.lotus.api.button.Button
 
SpanningButton - Record Class in studio.mevera.lotus.api.button
A single logical button whose visual presence and click target span multiple slots — typically used for banners, multi-cell icons, region selectors or "tile" art that should read as one element to the user.
SpanningButton(ItemStack, Set<Slot>, ClickAction, DataRegistry) - Constructor for record class studio.mevera.lotus.api.button.SpanningButton
Creates an instance of a SpanningButton record class.
states() - Method in record class studio.mevera.lotus.api.button.CycleButton
Returns the value of the states record component.
StaticButton - Record Class in studio.mevera.lotus.api.button
 
StaticButton(ItemStack, DataRegistry) - Constructor for record class studio.mevera.lotus.api.button.StaticButton
Creates an instance of a StaticButton record class.
stream() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
 
stream() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
 
stream() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
 
stream() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
 
stream() - Method in interface studio.mevera.lotus.api.slot.SlotMask
 
studio.mevera.lotus - package studio.mevera.lotus
 
studio.mevera.lotus.api.button - package studio.mevera.lotus.api.button
 
studio.mevera.lotus.api.content - package studio.mevera.lotus.api.content
 
studio.mevera.lotus.api.data - package studio.mevera.lotus.api.data
 
studio.mevera.lotus.api.item - package studio.mevera.lotus.api.item
 
studio.mevera.lotus.api.menu - package studio.mevera.lotus.api.menu
 
studio.mevera.lotus.api.pagination - package studio.mevera.lotus.api.pagination
 
studio.mevera.lotus.api.slot - package studio.mevera.lotus.api.slot
 
studio.mevera.lotus.api.util - package studio.mevera.lotus.api.util
 
studio.mevera.lotus.internal - package studio.mevera.lotus.internal
 
studio.mevera.lotus.internal.content - package studio.mevera.lotus.internal.content
 
studio.mevera.lotus.internal.menu - package studio.mevera.lotus.internal.menu
 
studio.mevera.lotus.internal.pagination - package studio.mevera.lotus.internal.pagination
 
studio.mevera.lotus.spi - package studio.mevera.lotus.spi
 
studio.mevera.lotus.spi.opener - package studio.mevera.lotus.spi.opener
 

T

title() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the title of the view.
title() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
title(Function<X, C>) - Method in class studio.mevera.lotus.api.pagination.PageLayoutBuilder
 
title(MenuView<C, ?>) - Method in interface studio.mevera.lotus.api.menu.Menu
Returns the title for the current view.
title(X) - Method in interface studio.mevera.lotus.api.pagination.PageLayout
Returns the title for the current page.
to() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
Returns the value of the to record component.
toString() - Method in record class studio.mevera.lotus.api.button.ClickableButton
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.button.CompositeButton
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.button.CycleButton
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.button.SpanningButton
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.button.StaticButton
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.button.TransformingButton
Returns a string representation of this record class.
toString() - Method in class studio.mevera.lotus.api.data.Key
 
toString() - Method in class studio.mevera.lotus.api.slot.Capacity
 
toString() - Method in record class studio.mevera.lotus.api.slot.Slot
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Custom
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Excluding
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Full
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.slot.SlotMask.Range
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.api.util.Pair
Returns a string representation of this record class.
toString() - Method in record class studio.mevera.lotus.Lotus.Options
Returns a string representation of this record class.
totalPages - Variable in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
totalPages() - Method in class studio.mevera.lotus.api.pagination.AbstractPageContext
 
totalPages() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Returns the total number of pages.
totalPages() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
totalSize() - Method in class studio.mevera.lotus.api.slot.Capacity
 
track(Player, MenuView<C, ?>) - Method in class studio.mevera.lotus.Lotus
Internal: registers/replaces the open view for a player.
transformer() - Method in record class studio.mevera.lotus.api.button.TransformingButton
Returns the value of the transformer record component.
transforming(ItemStack, BiFunction<MenuView<?, ?>, InventoryClickEvent, Button>) - Static method in interface studio.mevera.lotus.api.button.Button
 
TransformingButton - Record Class in studio.mevera.lotus.api.button
 
TransformingButton(ItemStack, BiFunction<MenuView<?, ?>, InventoryClickEvent, Button>, DataRegistry) - Constructor for record class studio.mevera.lotus.api.button.TransformingButton
Creates an instance of a TransformingButton record class.
translate(int) - Method in record class studio.mevera.lotus.api.slot.Slot
 
trimOverflow() - Method in class studio.mevera.lotus.api.pagination.AbstractPagination
 
trimOverflow(boolean) - Method in class studio.mevera.lotus.api.pagination.AbstractPagination.Builder
 
trimTo(int) - Method in interface studio.mevera.lotus.api.content.Content
Removes extra buttons after the given limit is reached.
trimTo(int) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 
type() - Method in class studio.mevera.lotus.api.data.Key
 
type() - Method in interface studio.mevera.lotus.api.menu.Menu
Returns the Bukkit inventory type used by this menu.
type() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the inventory type used by this view.

U

unbreakable - Variable in class studio.mevera.lotus.api.item.AbstractItemBuilder
 
unbreakable(boolean) - Method in class studio.mevera.lotus.api.item.AbstractItemBuilder
Sets whether this item is unbreakable.
untrack(Player) - Method in class studio.mevera.lotus.Lotus
 
UP - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
UP_LEFT - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
UP_RIGHT - Enum constant in enum class studio.mevera.lotus.api.slot.Direction
 
update(Slot, UnaryOperator<Button>) - Method in interface studio.mevera.lotus.api.content.ContentEditor
Replaces the button at the given slot using the updater result.
update(Slot, UnaryOperator<Button>) - Method in class studio.mevera.lotus.internal.content.DefaultContent
 

V

valueOf(String) - Static method in enum class studio.mevera.lotus.api.slot.Direction
Returns the enum constant of this class with the specified name.
values() - Static method in enum class studio.mevera.lotus.api.slot.Direction
Returns an array containing the constants of this enum class, in the order they are declared.
viewer - Variable in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
viewer() - Method in interface studio.mevera.lotus.api.menu.MenuView
Returns the player viewing this menu.
viewer() - Method in class studio.mevera.lotus.api.pagination.AbstractPageContext
 
viewer() - Method in interface studio.mevera.lotus.api.pagination.PaginationSession
Returns the player viewing this session.
viewer() - Method in class studio.mevera.lotus.internal.menu.BaseMenuView
 
viewer() - Method in class studio.mevera.lotus.internal.pagination.DefaultPaginationSession
 
viewOf(Player) - Method in class studio.mevera.lotus.Lotus
 
ViewOpener<C> - Interface in studio.mevera.lotus.spi.opener
Opens a MenuView as a Bukkit Inventory.

W

warn(String) - Method in class studio.mevera.lotus.internal.LotusLogger
 
warn(String, Throwable) - Method in class studio.mevera.lotus.internal.LotusLogger
 
withAction(ClickAction) - Method in record class studio.mevera.lotus.api.button.ClickableButton
 
withItem(ItemStack) - Method in interface studio.mevera.lotus.api.button.Button
 
withItem(ItemStack) - Method in record class studio.mevera.lotus.api.button.ClickableButton
 
withItem(ItemStack) - Method in record class studio.mevera.lotus.api.button.CompositeButton
 
withItem(ItemStack) - Method in record class studio.mevera.lotus.api.button.CycleButton
Replaces the displayed item.
withItem(ItemStack) - Method in record class studio.mevera.lotus.api.button.SpanningButton
 
withItem(ItemStack) - Method in record class studio.mevera.lotus.api.button.StaticButton
 
withItem(ItemStack) - Method in record class studio.mevera.lotus.api.button.TransformingButton
 
A B C D E F G H I K L M N O P R S T U V W 
All Classes and Interfaces|All Packages