Index (vgui 2.1.0-SNAPSHOT API)

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

A

addListener(VGuiListener) - Static method in class me.agent.vgui.api.VGui
addListener(VGuiListener) - Method in interface me.agent.vgui.api.VGuiService: Registers a global listener observing all views.
addListener(VGuiListener) - Method in class me.agent.vgui.core.internal.SessionManager
addListener(VGuiListener) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
amount(int) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets the stack size (clamped to [1, 99]).
ANVIL - Enum constant in enum class me.agent.vgui.api.ViewType: Anvil window (3 slots: two inputs, one output).
AnvilInputView - Class in me.agent.vgui.api.input: A text-input prompt rendered as an anvil window: the player types in the rename field and clicks the output slot to confirm.
AnvilInputView.Builder - Class in me.agent.vgui.api.input: Builder for AnvilInputView.
applyLayout(Layout) - Method in interface me.agent.vgui.api.contents.ViewContents: Applies a Layout: every mapped character is written to its slots.
applyLayout(Layout) - Method in class me.agent.vgui.core.internal.DefaultViewContents
asItem() - Method in class me.agent.vgui.api.item.ItemBuilder: Shortcut for ViewItem.of(build()).
asUnmodifiableMap() - Method in interface me.agent.vgui.api.context.ViewContext: Read-only snapshot of simple string-backed values.
asUnmodifiableMap() - Method in class me.agent.vgui.core.internal.DefaultViewContext

B

back() - Method in interface me.agent.vgui.api.click.ClickContext: Returns to the previous view, if any.
back() - Method in interface me.agent.vgui.api.contents.ViewContents: Returns to the previous view in the player's history, if any.
back() - Method in class me.agent.vgui.core.internal.DefaultViewContents
back(Player) - Static method in class me.agent.vgui.api.VGui
back(Player) - Method in interface me.agent.vgui.api.VGuiService: Returns to the player's previous view, if any.
back(Player) - Method in class me.agent.vgui.core.internal.SessionManager: Reopens the previous view in the player's history, if any.
back(Player) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
backButton(ItemStack) - Static method in class me.agent.vgui.api.item.ViewItem: An item that returns to the previous view (or closes if there is none) when clicked.
backendConnected(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: Marks the latest backend generation connected and ready to accept a baseline.
backendConnected(UUID) - Method in class me.agent.vgui.core.internal.SessionManager: Activates the latest backend generation after Velocity finishes connecting.
BackendConnectionListener - Class in me.agent.vgui.core: Invalidates backend-scoped state around Velocity server transitions.
BackendConnectionListener(SessionManager) - Constructor for class me.agent.vgui.core.BackendConnectionListener
backendSwitchAborted(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: Ends a failed connection attempt without reviving the invalidated old cache.
backendSwitchAborted(UUID) - Method in class me.agent.vgui.core.internal.SessionManager: Releases the open gate after a failed backend connection attempt.
backendSwitchStarted(UUID) - Method in class me.agent.vgui.core.internal.SessionManager: Invalidates backend-scoped state before a connection attempt.
batch(Consumer) - Method in interface me.agent.vgui.api.contents.ViewContents: Runs bulk mutations without sending per-slot packets, then pushes one full refresh at the end.
batch(Consumer) - Method in class me.agent.vgui.core.internal.DefaultViewContents
beginBackendSwitch(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: Invalidates the current cache before a backend connection attempt.
build() - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Builds the view.
build() - Method in class me.agent.vgui.api.item.ItemBuilder: Builds the item stack.
build() - Method in class me.agent.vgui.api.ViewBuilder: Builds the immutable, reusable view.
builder() - Static method in class me.agent.vgui.api.input.AnvilInputView: Starts building an anvil input prompt.
builder(String) - Static method in class me.agent.vgui.api.item.Skulls: An ItemBuilder pre-configured as a textured player head.

C

cancel() - Method in interface me.agent.vgui.api.contents.UpdateTask: Stops the task.
cancelClientTransactions() - Method in interface me.agent.vgui.api.View: Whether client click transactions are cancelled so items can never be taken out of (or put into) the GUI.
cancelClientTransactions(boolean) - Method in class me.agent.vgui.api.ViewBuilder: See View.cancelClientTransactions().
charAt(int) - Method in class me.agent.vgui.api.contents.Layout: The character at a flat slot index.
chest(int) - Static method in class me.agent.vgui.api.VGui: Starts building a chest view with the given number of rows (1-6).
CHEST_9X1 - Enum constant in enum class me.agent.vgui.api.ViewType: Generic chest with 1 row (9 slots).
CHEST_9X2 - Enum constant in enum class me.agent.vgui.api.ViewType: Generic chest with 2 rows (18 slots).
CHEST_9X3 - Enum constant in enum class me.agent.vgui.api.ViewType: Generic chest with 3 rows (27 slots).
CHEST_9X4 - Enum constant in enum class me.agent.vgui.api.ViewType: Generic chest with 4 rows (36 slots).
CHEST_9X5 - Enum constant in enum class me.agent.vgui.api.ViewType: Generic chest with 5 rows (45 slots).
CHEST_9X6 - Enum constant in enum class me.agent.vgui.api.ViewType: Generic chest with 6 rows (54 slots).
chestForSize(int) - Static method in enum class me.agent.vgui.api.ViewType: Smallest chest type that fits size slots (clamped to [9, 54], rounded up to a full row).
chestRows(int) - Static method in enum class me.agent.vgui.api.ViewType: Chest type for the given row count.
ChestView - Class in me.agent.vgui.api: Convenience base class for static 9xN chest menus: call ChestView.setItem(int, ViewItem) in your constructor and the items are applied every time the view opens.
ChestView(int, Component) - Constructor for class me.agent.vgui.api.ChestView
clear() - Method in interface me.agent.vgui.api.contents.ViewContents: Clears every slot.
clear() - Method in class me.agent.vgui.core.internal.DefaultViewContents
clear() - Method in class me.agent.vgui.core.internal.InventoryTracker: Drops every cached player, used when the owning bootstrap shuts down.
clear() - Method in class me.agent.vgui.core.internal.WindowIdAllocator
clickable(ItemStack, Consumer) - Static method in class me.agent.vgui.api.item.ViewItem: An item that runs onClick when clicked.
clickable(ItemBuilder, Consumer) - Static method in class me.agent.vgui.api.item.ViewItem: An item built from an ItemBuilder that runs onClick when clicked.
ClickContext - Interface in me.agent.vgui.api.click: Everything about one inventory click inside an open view, plus convenient actions to react to it (mutate contents, navigate, play sounds).
clickCooldown(Duration) - Method in class me.agent.vgui.api.ViewBuilder: See View.clickCooldownMillis().
clickCooldownMillis() - Method in interface me.agent.vgui.api.View: Minimum milliseconds between processed non-drag clicks per player.
clickType() - Method in interface me.agent.vgui.api.click.ClickContext: The decoded click type.
ClickType - Enum Class in me.agent.vgui.api.click: High-level classification of an inventory click, decoded from the raw click mode + button combination the client sends.
CLIENT - Enum constant in enum class me.agent.vgui.api.CloseReason: The player closed the window themselves (e.g. pressed Esc).
clientClosed(UUID) - Method in class me.agent.vgui.core.internal.SessionManager: Compatibility overload that closes whichever session is current at dispatch.
clientClosed(ViewSession) - Method in class me.agent.vgui.core.internal.SessionManager: The client told us it closed this exact window.
close() - Method in interface me.agent.vgui.api.click.ClickContext: Closes the view.
close() - Method in interface me.agent.vgui.api.contents.ViewContents: Closes this view.
close() - Method in class me.agent.vgui.core.internal.DefaultViewContents
close(Player) - Static method in class me.agent.vgui.api.VGui
close(Player) - Method in interface me.agent.vgui.api.VGuiService: Closes the player's current view (fires CloseReason.SERVER).
close(Player) - Method in class me.agent.vgui.core.internal.SessionManager: Closes the player's session (server-initiated), sending a close packet.
close(Player) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
closeAll() - Method in interface me.agent.vgui.api.VGuiService: Closes every open view on the proxy.
closeAll() - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
closeAll(CloseReason) - Method in class me.agent.vgui.core.internal.SessionManager: Closes every session.
closeButton(ItemStack) - Static method in class me.agent.vgui.api.item.ViewItem: An item that closes the view when clicked.
CloseHandler - Interface in me.agent.vgui.api: Callback invoked when a view closes; see ViewBuilder.onClose(CloseHandler).
CloseReason - Enum Class in me.agent.vgui.api: Why a View was closed.
column() - Method in record class me.agent.vgui.api.contents.Slot: Returns the value of the column record component.
columns() - Method in class me.agent.vgui.api.contents.Layout: Number of columns (length of each row string).
columns() - Method in enum class me.agent.vgui.api.ViewType: Number of columns per row (9 for chests, 5 for hopper, 3 for dispenser/anvil).
contains(String) - Method in interface me.agent.vgui.api.context.ViewContext
contains(String) - Method in class me.agent.vgui.core.internal.DefaultViewContext
contents() - Method in interface me.agent.vgui.api.click.ClickContext: The live contents of the open view.
contents() - Method in class me.agent.vgui.core.internal.ViewSession
context() - Method in interface me.agent.vgui.api.click.ClickContext: The per-open key/value context.
context() - Method in interface me.agent.vgui.api.contents.ViewContents: The per-open key/value context (survives view switches via history).
context() - Method in class me.agent.vgui.core.internal.DefaultViewContents
context() - Method in class me.agent.vgui.core.internal.ViewSession
CTRL_DROP - Enum constant in enum class me.agent.vgui.api.click.ClickType: Ctrl+Q drops the whole stack.
currentContents(Player) - Static method in class me.agent.vgui.api.VGui
currentContents(Player) - Method in interface me.agent.vgui.api.VGuiService: The live contents of the player's open view, or null.
currentContents(Player) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
currentContext(Player) - Static method in class me.agent.vgui.api.VGui
currentContext(Player) - Method in interface me.agent.vgui.api.VGuiService: The player's current view context, or null.
currentContext(Player) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
currentView(Player) - Static method in class me.agent.vgui.api.VGui
currentView(Player) - Method in interface me.agent.vgui.api.VGuiService: The player's open view, or null.
currentView(Player) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
customModelData(int) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets custom model data (resource-pack driven models, 1.14+).

D

DefaultViewContents - Class in me.agent.vgui.core.internal: Live contents backing one ViewSession.
DefaultViewContext - Class in me.agent.vgui.core.internal
DefaultViewContext() - Constructor for class me.agent.vgui.core.internal.DefaultViewContext
DemoCommand - Class in me.agent.vgui.core.demo: /vgui opens a live tour of layouts, pagination, animation, dynamic updates, navigation history, sounds, and anvil text input.
DemoCommand() - Constructor for class me.agent.vgui.core.demo.DemoCommand
DISCONNECT - Enum constant in enum class me.agent.vgui.api.CloseReason: The player disconnected from the proxy.
disconnected(UUID) - Method in class me.agent.vgui.core.internal.SessionManager: The player disconnected from the proxy.
DISPENSER - Enum constant in enum class me.agent.vgui.api.ViewType: 3x3 dispenser-style grid (9 slots).
DOUBLE_CLICK - Enum constant in enum class me.agent.vgui.api.click.ClickType: Double click collects matching items to the cursor.
DRAG_ADD - Enum constant in enum class me.agent.vgui.api.click.ClickType: Added a slot to an ongoing click-drag operation.
DRAG_END - Enum constant in enum class me.agent.vgui.api.click.ClickType: Finished a click-drag operation.
DRAG_START - Enum constant in enum class me.agent.vgui.api.click.ClickType: Started a click-drag ("paint") operation.
DROP - Enum constant in enum class me.agent.vgui.api.click.ClickType: Q drops one item.

E

edit(Consumer) - Method in class me.agent.vgui.api.item.ItemBuilder: Escape hatch: mutate the underlying PacketEvents builder directly.
equals(Object) - Method in record class me.agent.vgui.api.contents.Slot: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class me.agent.vgui.api.context.ViewKey
evict(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: Drops all connection and inventory state for a disconnected player.
execute(SimpleCommand.Invocation) - Method in class me.agent.vgui.core.demo.DemoCommand

F

fill(ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Fills every slot with the item.
fill(ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
fillBorder(ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Fills the outer border (first/last row and first/last column).
fillBorder(ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
fillColumn(int, ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Fills one column (zero-based).
fillColumn(int, ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
fillEmpty(ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Fills only slots that are currently empty.
fillEmpty(ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
fillRect(int, int, int, int, ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Fills the rectangle from (rowFrom, columnFrom) to (rowTo, columnTo), both inclusive.
fillRect(int, int, int, int, ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
fillRow(int, ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Fills one row (zero-based).
fillRow(int, ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
first() - Method in interface me.agent.vgui.api.contents.Pagination: Jumps to the first page.
forget(UUID) - Method in class me.agent.vgui.core.internal.WindowIdAllocator
fromIndex(int, int) - Static method in record class me.agent.vgui.api.contents.Slot: Converts a flat slot index back to a position for a view that is columns wide.

G

generation(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: Current backend generation, captured by packet listeners before an update.
get() - Static method in class me.agent.vgui.api.VGui: The service instance.
get(int) - Method in interface me.agent.vgui.api.contents.ViewContents: The item currently at a flat slot index, or null if empty.
get(int) - Method in class me.agent.vgui.core.internal.DefaultViewContents
get(int, int) - Method in interface me.agent.vgui.api.contents.ViewContents: The item currently at a row/column position, or null if empty.
get(int, int) - Method in class me.agent.vgui.core.internal.DefaultViewContents
get(String) - Method in interface me.agent.vgui.api.context.ViewContext
get(String) - Method in class me.agent.vgui.core.internal.DefaultViewContext
get(String, Class) - Method in interface me.agent.vgui.api.context.ViewContext
get(String, Class) - Method in class me.agent.vgui.core.internal.DefaultViewContext
get(ViewKey) - Method in interface me.agent.vgui.api.context.ViewContext
get(ViewKey) - Method in class me.agent.vgui.core.internal.DefaultViewContext
getSession(UUID) - Method in class me.agent.vgui.core.internal.SessionManager
glow() - Method in class me.agent.vgui.api.item.ItemBuilder: Gives the item an enchantment glint without a visible enchantment.
glow(boolean) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets or removes the enchantment glint override.

H

handle(ClickContext) - Method in class me.agent.vgui.api.item.ViewItem: Runs the click handler, if any.
hasHandler() - Method in class me.agent.vgui.api.item.ViewItem: Whether this item has a click handler.
hashCode() - Method in record class me.agent.vgui.api.contents.Slot: Returns a hash code value for this object.
hashCode() - Method in class me.agent.vgui.api.context.ViewKey
hasPermission(SimpleCommand.Invocation) - Method in class me.agent.vgui.core.demo.DemoCommand
HOPPER - Enum constant in enum class me.agent.vgui.api.ViewType: Hopper window (5 slots in one row).
hotbarKey() - Method in interface me.agent.vgui.api.click.ClickContext: The pressed hotbar key in [0, 8] when ClickContext.clickType() is ClickType.NUMBER_KEY, otherwise -1.

I

index(int) - Method in record class me.agent.vgui.api.contents.Slot: Converts this position to a flat slot index for a view that is columns wide.
init(ProxyServer, Object, Logger, boolean) - Static method in class me.agent.vgui.core.VGuiBootstrap: Initializes VGui: PacketEvents listeners, session manager, disconnect cleanup and the VGui service singleton.
initialText(String) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Text pre-filled in the rename field.
instance() - Static method in class me.agent.vgui.core.VGuiBootstrap: The active bootstrap, or null before VGuiBootstrap.init(ProxyServer, Object, Logger, boolean).
InventoryTracker - Class in me.agent.vgui.core.internal: Caches each player's backend-owned inventory by observing window-0 packets.
InventoryTracker() - Constructor for class me.agent.vgui.core.internal.InventoryTracker
isCancelled() - Method in interface me.agent.vgui.api.contents.UpdateTask: Whether the task has been cancelled (explicitly or by the view closing).
isChest() - Method in enum class me.agent.vgui.api.ViewType: True for any of the generic 9xN chest types.
isDrag() - Method in enum class me.agent.vgui.api.click.ClickType: True for the three drag phases.
isFirst() - Method in interface me.agent.vgui.api.contents.Pagination: True when on the first page.
isGui() - Method in interface me.agent.vgui.api.click.ClickContext: True when the click landed in the top (GUI) half of the window.
isInitialized() - Static method in class me.agent.vgui.api.VGui: Whether the service is initialized and ready.
isLast() - Method in interface me.agent.vgui.api.contents.Pagination: True when on the last page.
isLeft() - Method in enum class me.agent.vgui.api.click.ClickType: True for ClickType.LEFT, ClickType.SHIFT_LEFT and ClickType.LEFT_OUTSIDE.
isOpen() - Method in interface me.agent.vgui.api.contents.ViewContents: Whether this view is still open for the player.
isOpen() - Method in class me.agent.vgui.core.internal.DefaultViewContents
isOpen() - Method in class me.agent.vgui.core.internal.ViewSession
isOutside() - Method in enum class me.agent.vgui.api.click.ClickType: True when the click happened outside the window bounds.
isPlayerInventory() - Method in interface me.agent.vgui.api.click.ClickContext: True when the click landed in the player-inventory half of the window.
isRight() - Method in enum class me.agent.vgui.api.click.ClickType: True for ClickType.RIGHT, ClickType.SHIFT_RIGHT and ClickType.RIGHT_OUTSIDE.
isShift() - Method in enum class me.agent.vgui.api.click.ClickType: True for ClickType.SHIFT_LEFT and ClickType.SHIFT_RIGHT.
isShiftClick() - Method in interface me.agent.vgui.api.click.ClickContext: Shortcut for clickType().isShift().
isSwitching(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: Whether a backend transition is in progress; proxy views should not open yet.
isViewing(Player) - Static method in class me.agent.vgui.api.VGui
isViewing(Player) - Method in interface me.agent.vgui.api.VGuiService: Whether the player has a proxy view open.
isViewing(Player) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
item() - Method in class me.agent.vgui.api.item.ViewItem: A defensive copy of the displayed item stack.
item(int, int, ViewItem) - Method in class me.agent.vgui.api.ViewBuilder: Places an item at a row/column position (applied after the layout).
item(int, ViewItem) - Method in class me.agent.vgui.api.ViewBuilder: Places an item at a flat slot index (applied after the layout).
ItemBuilder - Class in me.agent.vgui.api.item: Fluent builder for PacketEvents ItemStacks that writes both modern item components (1.20.5+) and legacy NBT tags, so items render correctly on every client version from 1.8 to the latest.
items(List) - Method in interface me.agent.vgui.api.contents.Pagination: Sets (or replaces) the items to paginate.
itemsPerPage() - Method in interface me.agent.vgui.api.contents.Pagination: Number of slots per page (the size of the configured region).
itemType(ItemType) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Item type shown in the input and output slots (default paper).

L

last() - Method in interface me.agent.vgui.api.contents.Pagination: Jumps to the last page.
layout(String...) - Method in class me.agent.vgui.api.ViewBuilder: Sets a character-mask layout.
Layout - Class in me.agent.vgui.api.contents: A character-mask layout for a view.
LEFT - Enum constant in enum class me.agent.vgui.api.click.ClickType: Plain left click on a slot.
LEFT_OUTSIDE - Enum constant in enum class me.agent.vgui.api.click.ClickType: Left click outside the window (would drop the cursor stack).
legacyData(int) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets legacy item data (durability or metadata) for pre-1.13 clients.
loadPacketEvents(ProxyServer, PluginContainer, Logger, Path) - Static method in class me.agent.vgui.core.VGuiBootstrap: Builds and loads the PacketEvents API if no other plugin has installed it yet.
lore(List) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets the lore lines.
lore(Component...) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets the lore lines.

M

mainAndHotbar(UUID) - Method in class me.agent.vgui.core.internal.InventoryTracker: The 36 main-inventory + hotbar items in container-window order.
map(char, ViewItem) - Method in class me.agent.vgui.api.ViewBuilder: Maps a layout character to an item ('.' and ' ' stay empty).
me.agent.vgui.api - package me.agent.vgui.api: Public VGui API: the VGui entry point, the View contract and the fluent ViewBuilder.
me.agent.vgui.api.click - package me.agent.vgui.api.click: Click handling: the decoded ClickType and the ClickContext passed to handlers.
me.agent.vgui.api.contents - package me.agent.vgui.api.contents: Live view contents: per-player slot state (ViewContents), character-mask Layouts and Pagination.
me.agent.vgui.api.context - package me.agent.vgui.api.context: Per-open key/value storage: ViewContext with typed ViewKeys.
me.agent.vgui.api.event - package me.agent.vgui.api.event: Global observation hooks: VGuiListener.
me.agent.vgui.api.input - package me.agent.vgui.api.input: Player text input via anvil windows: AnvilInputView.
me.agent.vgui.api.item - package me.agent.vgui.api.item: Items shown in views: ViewItem slot entries and the cross-version ItemBuilder.
me.agent.vgui.core - package me.agent.vgui.core
me.agent.vgui.core.demo - package me.agent.vgui.core.demo
me.agent.vgui.core.internal - package me.agent.vgui.core.internal
MIDDLE - Enum constant in enum class me.agent.vgui.api.click.ClickType: Middle click (creative clone).

N

name() - Method in class me.agent.vgui.api.context.ViewKey
name(Component) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets the display name.
next() - Method in interface me.agent.vgui.api.contents.Pagination: Advances one page if possible.
nextId(UUID) - Method in class me.agent.vgui.core.internal.WindowIdAllocator
NUMBER_KEY - Enum constant in enum class me.agent.vgui.api.click.ClickType: Hotbar number key (1-9); see ClickContext.hotbarKey().

O

of(int, int) - Static method in record class me.agent.vgui.api.contents.Slot: Creates a slot position.
of(ItemStack) - Static method in class me.agent.vgui.api.item.ViewItem: A display-only item without a click handler.
of(ItemType) - Static method in class me.agent.vgui.api.item.ItemBuilder: Starts building an item of the given type with amount 1.
of(ItemType, int) - Static method in class me.agent.vgui.api.item.ItemBuilder: Starts building an item of the given type and amount (clamped to [1, 99]).
of(String...) - Static method in class me.agent.vgui.api.contents.Layout: Creates a layout from row strings.
of(String, Class) - Static method in class me.agent.vgui.api.context.ViewKey
of(List) - Static method in class me.agent.vgui.api.contents.Layout: Creates a layout from row strings.
of(ItemBuilder) - Static method in class me.agent.vgui.api.item.ViewItem: A display-only item built from an ItemBuilder.
OFFHAND_SWAP - Enum constant in enum class me.agent.vgui.api.click.ClickType: F key swaps with the offhand.
onAnvilInput(String, ViewContents) - Method in class me.agent.vgui.api.input.AnvilInputView
onAnvilInput(String, ViewContents) - Method in interface me.agent.vgui.api.View: Called when the player types in an anvil rename field (only for ViewType.ANVIL views), once per keystroke with the full current text.
onAnvilInput(BiConsumer) - Method in class me.agent.vgui.api.ViewBuilder: Runs on anvil rename input (only for ViewType.ANVIL views).
onCancel(Consumer) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Called when the player closes the prompt without confirming.
onClick(Consumer) - Method in class me.agent.vgui.api.item.ItemBuilder: Shortcut for ViewItem.clickable(build(), onClick).
onClick(Consumer) - Method in class me.agent.vgui.api.ViewBuilder: Runs for every click (after any per-item handler).
onClick(ClickContext) - Method in interface me.agent.vgui.api.event.VGuiListener: Called before a click is dispatched to item and view handlers.
onClick(ClickContext) - Method in interface me.agent.vgui.api.View: Called for every click inside the window (GUI half and player-inventory half).
onClose(Player, CloseReason, ViewContext) - Method in interface me.agent.vgui.api.CloseHandler: Handles the close.
onClose(Player, CloseReason, ViewContext) - Method in class me.agent.vgui.api.input.AnvilInputView
onClose(Player, CloseReason, ViewContext) - Method in interface me.agent.vgui.api.View: Called exactly once when the view stops being shown, with the reason and the per-open context.
onClose(Player, View, CloseReason) - Method in interface me.agent.vgui.api.event.VGuiListener: Called after a view closed for a player.
onClose(CloseHandler) - Method in class me.agent.vgui.api.ViewBuilder: Runs when the view closes.
onConfirm(BiConsumer) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Called when the player clicks the output slot to confirm.
onKickedFromServer(KickedFromServerEvent) - Method in class me.agent.vgui.core.BackendConnectionListener
onOpen(Player, View, ViewContents) - Method in interface me.agent.vgui.api.event.VGuiListener: Called after a view opened for a player.
onOpen(Consumer) - Method in class me.agent.vgui.api.ViewBuilder: Runs after the layout and items are applied when the view opens for a player.
onOpen(ViewContents) - Method in class me.agent.vgui.api.ChestView
onOpen(ViewContents) - Method in class me.agent.vgui.api.input.AnvilInputView
onOpen(ViewContents) - Method in interface me.agent.vgui.api.View: Called right after the window opens (and again if the view is re-opened via back-navigation).
onPacketReceive(PacketReceiveEvent) - Method in class me.agent.vgui.core.internal.PacketBridge
onPacketSend(PacketSendEvent) - Method in class me.agent.vgui.core.internal.ServerPacketBridge
onPlayerDisconnect(DisconnectEvent) - Method in class me.agent.vgui.core.PlayerDisconnectListener
onProxyInitialization(ProxyInitializeEvent) - Method in class me.agent.vgui.core.VGuiPlatform
onProxyShutdown(ProxyShutdownEvent) - Method in class me.agent.vgui.core.VGuiPlatform
onServerConnected(ServerConnectedEvent) - Method in class me.agent.vgui.core.BackendConnectionListener
onServerPreConnect(ServerPreConnectEvent) - Method in class me.agent.vgui.core.BackendConnectionListener
onType(BiConsumer) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Called on every keystroke with the full current text.
open(int) - Method in interface me.agent.vgui.api.contents.Pagination: Jumps to a page (clamped to the valid range) and re-renders.
open(Player) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Builds the view and opens it for a player.
open(Player, View) - Static method in class me.agent.vgui.api.VGui
open(Player, View) - Method in interface me.agent.vgui.api.VGuiService: Opens a view.
open(Player, View) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
open(Player, View, Consumer) - Static method in class me.agent.vgui.api.VGui
open(Player, View, Consumer) - Method in interface me.agent.vgui.api.VGuiService: Opens a view, configuring a fresh context first.
open(Player, View, Consumer) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
open(Player, View, ViewContext) - Static method in class me.agent.vgui.api.VGui
open(Player, View, ViewContext) - Method in interface me.agent.vgui.api.VGuiService: Opens a view with a pre-populated context.
open(Player, View, ViewContext) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
open(Player, View, ViewContext, boolean) - Method in class me.agent.vgui.core.internal.SessionManager: Opens a view.
open(View) - Method in interface me.agent.vgui.api.click.ClickContext: Opens another view, pushing the current one onto the back-history.
open(View) - Method in interface me.agent.vgui.api.contents.ViewContents: Opens another view, pushing the current one onto the player's back-history.
open(View) - Method in class me.agent.vgui.core.internal.DefaultViewContents
openReplacing(Player, View) - Static method in class me.agent.vgui.api.VGui
openReplacing(Player, View) - Method in interface me.agent.vgui.api.VGuiService: Opens a view without pushing the currently open view onto the back-history.
openReplacing(Player, View) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
openReplacing(Player, View, ViewContext) - Method in interface me.agent.vgui.api.VGuiService: Opens a view without pushing history, with a pre-populated context.
openReplacing(Player, View, ViewContext) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
openReplacing(View) - Method in interface me.agent.vgui.api.click.ClickContext: Opens another view without pushing history.
openReplacing(View) - Method in interface me.agent.vgui.api.contents.ViewContents: Opens another view without pushing the current one onto the back-history.
openReplacing(View) - Method in class me.agent.vgui.core.internal.DefaultViewContents
opens(ItemStack, Supplier) - Static method in class me.agent.vgui.api.item.ViewItem: An item that opens a lazily-created view (pushing back-history) when clicked.
opens(ItemStack, View) - Static method in class me.agent.vgui.api.item.ViewItem: An item that opens another view (pushing back-history) when clicked.
openWindow(User, int, ViewType, Component) - Static method in class me.agent.vgui.core.internal.WindowTypeResolver: Sends the OPEN_WINDOW packet for the given view type, bypassing our own listeners.
overridden(UUID) - Method in class me.agent.vgui.core.internal.SessionManager: Atomically lets a backend window take ownership from the current proxy view.
overridden(ViewSession) - Method in class me.agent.vgui.core.internal.SessionManager: A backend server took over the player's screen.
OVERRIDDEN - Enum constant in enum class me.agent.vgui.api.CloseReason: A backend server opened or closed a window, taking over the player's screen.
ownedHead(String) - Static method in class me.agent.vgui.api.item.Skulls: A player head showing the skin of the given (premium) player name.

P

PacketBridge - Class in me.agent.vgui.core.internal: Translates client-bound packets into view events: clicks, window closes and anvil text input.
PacketBridge(Logger, SessionManager) - Constructor for class me.agent.vgui.core.internal.PacketBridge
page() - Method in interface me.agent.vgui.api.contents.Pagination: Current zero-based page.
pageCount() - Method in interface me.agent.vgui.api.contents.Pagination: Total number of pages (at least 1, even with no items).
pageNext(ItemStack) - Static method in class me.agent.vgui.api.item.ViewItem: An item that advances the view's Pagination one page.
pagePrevious(ItemStack) - Static method in class me.agent.vgui.api.item.ViewItem: An item that goes back one page in the view's Pagination.
pagination() - Method in interface me.agent.vgui.api.contents.ViewContents: The pagination helper for this view (lazily created, one per open view).
pagination() - Method in class me.agent.vgui.core.internal.DefaultViewContents
Pagination - Interface in me.agent.vgui.api.contents: Paginates a list of items across a region of slots.
player() - Method in interface me.agent.vgui.api.click.ClickContext: The player who clicked.
player() - Method in interface me.agent.vgui.api.contents.ViewContents: The player viewing this GUI.
player() - Method in class me.agent.vgui.core.internal.DefaultViewContents
player() - Method in class me.agent.vgui.core.internal.ViewSession
PlayerDisconnectListener - Class in me.agent.vgui.core: Cleans up sessions, history and inventory caches when a player leaves the proxy.
PlayerDisconnectListener(SessionManager) - Constructor for class me.agent.vgui.core.PlayerDisconnectListener
playerId() - Method in class me.agent.vgui.core.internal.ViewSession
playSound(Sound) - Method in interface me.agent.vgui.api.click.ClickContext: Plays a sound only this player hears (volume 1, pitch 1).
playSound(Sound, float, float) - Method in interface me.agent.vgui.api.click.ClickContext: Plays a sound only this player hears.
previous() - Method in interface me.agent.vgui.api.contents.Pagination: Goes back one page if possible.
prompt(Player, Component) - Static method in class me.agent.vgui.api.VGui
prompt(Player, Component) - Method in interface me.agent.vgui.api.VGuiService: Opens an anvil text prompt.
prompt(Player, Component) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
prompt(Player, Component, String) - Static method in class me.agent.vgui.api.VGui
prompt(Player, Component, String) - Method in interface me.agent.vgui.api.VGuiService: Opens an anvil text prompt with pre-filled initial text.
prompt(Player, Component, String) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl

R

rawButton() - Method in interface me.agent.vgui.api.click.ClickContext: The raw button id from the click packet.
rawMode() - Method in interface me.agent.vgui.api.click.ClickContext: The raw click mode ordinal from the click packet (pickup, quick-move, swap, ...).
refresh() - Method in interface me.agent.vgui.api.contents.ViewContents: Re-sends the full window contents to the client.
refresh() - Method in class me.agent.vgui.core.internal.DefaultViewContents
remove(int) - Method in interface me.agent.vgui.api.contents.ViewContents: Clears one slot.
remove(int) - Method in class me.agent.vgui.core.internal.DefaultViewContents
removeListener(VGuiListener) - Static method in class me.agent.vgui.api.VGui
removeListener(VGuiListener) - Method in interface me.agent.vgui.api.VGuiService: Removes a previously registered global listener.
removeListener(VGuiListener) - Method in class me.agent.vgui.core.internal.SessionManager
removeListener(VGuiListener) - Method in class me.agent.vgui.core.internal.VGuiServiceImpl
render() - Method in interface me.agent.vgui.api.contents.Pagination: Re-renders the current page into the region (e.g. after external changes).
resolve() - Method in class me.agent.vgui.api.contents.Layout: Resolves the layout to a map of flat slot index to item, in reading order.
RIGHT - Enum constant in enum class me.agent.vgui.api.click.ClickType: Plain right click on a slot.
RIGHT_OUTSIDE - Enum constant in enum class me.agent.vgui.api.click.ClickType: Right click outside the window (would drop one from the cursor stack).
row() - Method in record class me.agent.vgui.api.contents.Slot: Returns the value of the row record component.
rows() - Method in class me.agent.vgui.api.ChestView: Number of chest rows (1-6).
rows() - Method in class me.agent.vgui.api.contents.Layout: Number of rows in this layout.
rows() - Method in enum class me.agent.vgui.api.ViewType: Number of rows (slots() / columns()).

S

schedule(Duration, Consumer) - Method in interface me.agent.vgui.api.contents.ViewContents: Schedules a repeating task on the proxy scheduler, cancelled automatically when this view closes or the player switches views.
schedule(Duration, Consumer) - Method in class me.agent.vgui.core.internal.DefaultViewContents
SERVER - Enum constant in enum class me.agent.vgui.api.CloseReason: A plugin closed the view via VGuiService.close(Player).
ServerPacketBridge - Class in me.agent.vgui.core.internal: Observes packets flowing from backend servers to the client.
ServerPacketBridge(Logger, SessionManager, InventoryTracker) - Constructor for class me.agent.vgui.core.internal.ServerPacketBridge
sessionManager() - Method in class me.agent.vgui.core.VGuiBootstrap: The session manager (internal API, exposed for the platform plugin).
SessionManager - Class in me.agent.vgui.core.internal: Owns all view sessions: opening, closing, navigation history, packet pushes and global listener dispatch.
SessionManager(Logger, WindowIdAllocator, InventoryTracker, UpdateScheduler) - Constructor for class me.agent.vgui.core.internal.SessionManager
set(int, int, ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Sets or replaces the item at a row/column position.
set(int, int, ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
set(int, ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Sets or replaces the item at a flat slot index.
set(int, ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
set(String, Object) - Method in interface me.agent.vgui.api.context.ViewContext
set(String, Object) - Method in class me.agent.vgui.core.internal.DefaultViewContext
set(Slot, ViewItem) - Method in interface me.agent.vgui.api.contents.ViewContents: Sets or replaces the item at a Slot position.
set(Slot, ViewItem) - Method in class me.agent.vgui.core.internal.DefaultViewContents
set(ViewKey, T) - Method in interface me.agent.vgui.api.context.ViewContext
set(ViewKey, T) - Method in class me.agent.vgui.core.internal.DefaultViewContext
setInstance(VGuiService) - Static method in class me.agent.vgui.api.VGui: Installs the service instance.
setItem(int, int, ViewItem) - Method in class me.agent.vgui.api.ChestView: Sets or replaces a static item at a row/column position.
setItem(int, ViewItem) - Method in class me.agent.vgui.api.ChestView: Sets or replaces a static item; null removes it.
setSlot(UUID, int, ItemStack) - Method in class me.agent.vgui.core.internal.InventoryTracker: Records a single window-0 slot update for the current generation.
setSlot(UUID, long, int, ItemStack) - Method in class me.agent.vgui.core.internal.InventoryTracker: Records a slot update only for a live generation with a full baseline.
SHIFT_LEFT - Enum constant in enum class me.agent.vgui.api.click.ClickType: Shift + left click.
SHIFT_RIGHT - Enum constant in enum class me.agent.vgui.api.click.ClickType: Shift + right click.
shutdown() - Method in class me.agent.vgui.core.VGuiBootstrap: Closes all views and (if VGui owns it) terminates PacketEvents.
SHUTDOWN - Enum constant in enum class me.agent.vgui.api.CloseReason: The proxy is shutting down.
size() - Method in class me.agent.vgui.api.ChestView: Total slot count (rows() * 9).
size() - Method in class me.agent.vgui.api.contents.Layout: Total number of slots covered by this layout.
size() - Method in interface me.agent.vgui.api.contents.ViewContents: Number of slots in the top (GUI) inventory.
size() - Method in class me.agent.vgui.core.internal.DefaultViewContents
size() - Method in class me.agent.vgui.core.internal.ViewSession
skullOwner(String) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets a player-head skin by player name.
Skulls - Class in me.agent.vgui.api.item: Shortcuts for building player heads.
skullTexture(String) - Method in class me.agent.vgui.api.item.ItemBuilder: Sets a player-head texture from a base64 texture value (the Value field of a textures property, as found on skin sites).
slot() - Method in interface me.agent.vgui.api.click.ClickContext: The clicked slot, or -999 for clicks outside the window.
Slot - Record Class in me.agent.vgui.api.contents: A row/column position inside a view's top inventory.
Slot(int, int) - Constructor for record class me.agent.vgui.api.contents.Slot: Creates an instance of a Slot record class.
slotPos() - Method in interface me.agent.vgui.api.click.ClickContext: The row/column of the clicked slot, or null for outside/player-inventory clicks.
slots() - Method in enum class me.agent.vgui.api.ViewType: Number of slots in the top (GUI) inventory.
slots(int...) - Method in interface me.agent.vgui.api.contents.Pagination: Sets the unique slots the items flow into, in the given order.
slots(Layout, char) - Method in interface me.agent.vgui.api.contents.Pagination: Sets the region to all slots marked with character in layout.
slotsOf(char) - Method in class me.agent.vgui.api.contents.Layout: All flat slot indexes whose layout character equals character, in reading order.
stateId() - Method in interface me.agent.vgui.api.click.ClickContext: The client's window state id from the click packet, or -1 if absent.
SWITCHED - Enum constant in enum class me.agent.vgui.api.CloseReason: The view was replaced by another proxy view opening for the same player.

T

TEXT - Static variable in class me.agent.vgui.api.input.AnvilInputView: Context key holding the text currently typed into the rename field.
texturedHead(String) - Static method in class me.agent.vgui.api.item.Skulls: A player head with the given base64 texture value.
textureFromUrl(String) - Static method in class me.agent.vgui.api.item.Skulls: Builds the base64 texture value for a bare skin URL, e.g.
title() - Method in class me.agent.vgui.api.ChestView
title() - Method in class me.agent.vgui.api.input.AnvilInputView
title() - Method in interface me.agent.vgui.api.View: Title shown on the container.
title(Component) - Method in interface me.agent.vgui.api.contents.ViewContents: Changes the window title in place (re-opens the same window id client-side).
title(Component) - Method in class me.agent.vgui.api.input.AnvilInputView.Builder: Window title.
title(Component) - Method in class me.agent.vgui.api.ViewBuilder: Sets the window title.
title(Component) - Method in class me.agent.vgui.core.internal.DefaultViewContents
toString() - Method in record class me.agent.vgui.api.contents.Slot: Returns a string representation of this record class.
toString() - Method in class me.agent.vgui.api.context.ViewKey
type() - Method in class me.agent.vgui.api.ChestView
type() - Method in interface me.agent.vgui.api.contents.ViewContents: The window type.
type() - Method in class me.agent.vgui.api.context.ViewKey
type() - Method in class me.agent.vgui.api.input.AnvilInputView
type() - Method in interface me.agent.vgui.api.View: The window type (determines slot count and shape).
type() - Method in class me.agent.vgui.core.internal.DefaultViewContents
type() - Method in class me.agent.vgui.core.internal.ViewSession

U

unbreakable() - Method in class me.agent.vgui.api.item.ItemBuilder: Marks the item unbreakable (also hides the durability bar).
UNKNOWN - Enum constant in enum class me.agent.vgui.api.click.ClickType: Anything this library does not recognize.
updateEvery(Duration, Consumer) - Method in class me.agent.vgui.api.ViewBuilder: Registers a repeating update task started when the view opens and cancelled when it closes.
UpdateScheduler - Class in me.agent.vgui.core.internal: Runs repeating view-update tasks on the Velocity scheduler, tied to a session's lifetime.
UpdateScheduler(ProxyServer, Object, Logger) - Constructor for class me.agent.vgui.core.internal.UpdateScheduler
UpdateTask - Interface in me.agent.vgui.api.contents: Handle for a repeating update task registered with ViewContents.schedule(Duration, Consumer).
user() - Method in class me.agent.vgui.core.internal.ViewSession

V

valueOf(String) - Static method in enum class me.agent.vgui.api.click.ClickType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.agent.vgui.api.CloseReason: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class me.agent.vgui.api.ViewType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class me.agent.vgui.api.click.ClickType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.agent.vgui.api.CloseReason: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class me.agent.vgui.api.ViewType: Returns an array containing the constants of this enum class, in the order they are declared.
VGui - Class in me.agent.vgui.api: Static entry point to VGui.
VGuiBootstrap - Class in me.agent.vgui.core: Wires VGui into a running proxy.
VGuiListener - Interface in me.agent.vgui.api.event: Global hook for every view on the proxy.
VGuiPlatform - Class in me.agent.vgui.core: Standalone plugin entry point.
VGuiPlatform(ProxyServer, PluginContainer, Logger, Path) - Constructor for class me.agent.vgui.core.VGuiPlatform
VGuiService - Interface in me.agent.vgui.api: The VGui service: open/close views, query sessions, register global listeners.
VGuiServiceImpl - Class in me.agent.vgui.core.internal
VGuiServiceImpl(SessionManager, Logger) - Constructor for class me.agent.vgui.core.internal.VGuiServiceImpl
view() - Method in interface me.agent.vgui.api.click.ClickContext: The view being clicked.
view() - Method in interface me.agent.vgui.api.contents.ViewContents: The view definition these contents belong to.
view() - Method in class me.agent.vgui.core.internal.DefaultViewContents
view() - Method in class me.agent.vgui.core.internal.ViewSession
view(ViewType) - Static method in class me.agent.vgui.api.VGui: Starts building a view of the given type.
View - Interface in me.agent.vgui.api: A server-controlled inventory screen rendered entirely at the proxy.
ViewBuilder - Class in me.agent.vgui.api: Fluent builder for views.
ViewContents - Interface in me.agent.vgui.api.contents: The live, mutable contents of one player's open view.
ViewContext - Interface in me.agent.vgui.api.context: Context associated with a single player's active view (menu).
ViewItem - Class in me.agent.vgui.api.item: An item shown in a view slot, optionally with a click handler.
ViewKey<T> - Class in me.agent.vgui.api.context: Strongly typed key for ViewContext storage.
ViewSession - Class in me.agent.vgui.core.internal: One player's active view: window id, live contents, state id counter, cooldown state and the update tasks tied to the view's lifetime.
ViewType - Enum Class in me.agent.vgui.api: The kind of container window a View renders as.

W

where(char, ViewItem) - Method in class me.agent.vgui.api.contents.Layout: Maps a character to an item.
windowId() - Method in class me.agent.vgui.core.internal.ViewSession
WindowIdAllocator - Class in me.agent.vgui.core.internal: Allocates container window ids per player.
WindowIdAllocator() - Constructor for class me.agent.vgui.core.internal.WindowIdAllocator
windowItems(UUID, long, List) - Method in class me.agent.vgui.core.internal.InventoryTracker: Records a full window-0 packet only if its captured generation is still live.
windowItems(UUID, List) - Method in class me.agent.vgui.core.internal.InventoryTracker: Records a full window-0 contents packet for the current generation.
WindowTypeResolver - Class in me.agent.vgui.core.internal: Version-aware window opener.
withClick(Consumer) - Method in class me.agent.vgui.api.item.ViewItem: A copy of this item with a different click handler (null removes it).
withItem(ItemStack) - Method in class me.agent.vgui.api.item.ViewItem: A copy of this item with a different item stack.

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