Class VGui

java.lang.Object

me.agent.vgui.api.VGui

public final class VGui
extends Object

Static entry point to VGui. The instance is installed by the platform bootstrap (VGuiPlatform when running as a plugin, or VGuiBootstrap when shaded as a library) during proxy initialization.

View shop = VGui.chest(3)
    .title(Component.text("Shop"))
    .layout("#########",
            "#..a.b..#",
            "####c####")
    .map('#', ViewItem.of(filler))
    .map('a', ViewItem.clickable(sword, click -> buySword(click.player())))
    .map('c', ViewItem.closeButton(barrier))
    .build();

VGui.open(player, shop);

Method Summary

Modifier and Type	Method	Description
static void	addListener(VGuiListener listener)
static boolean	back(com.velocitypowered.api.proxy.Player player)
static ViewBuilder	chest(int rows)	Starts building a chest view with the given number of rows (1-6).
static void	close(com.velocitypowered.api.proxy.Player player)
static ViewContents	currentContents(com.velocitypowered.api.proxy.Player player)
static ViewContext	currentContext(com.velocitypowered.api.proxy.Player player)
static View	currentView(com.velocitypowered.api.proxy.Player player)
static VGuiService	get()	The service instance.
static boolean	isInitialized()	Whether the service is initialized and ready.
static boolean	isViewing(com.velocitypowered.api.proxy.Player player)
static void	open(com.velocitypowered.api.proxy.Player player, View view)
static void	open(com.velocitypowered.api.proxy.Player player, View view, Consumer<ViewContext> contextBuilder)
static void	open(com.velocitypowered.api.proxy.Player player, View view, ViewContext context)
static void	openReplacing(com.velocitypowered.api.proxy.Player player, View view)
static CompletableFuture<String>	prompt(com.velocitypowered.api.proxy.Player player, net.kyori.adventure.text.Component title)
static CompletableFuture<String>	prompt(com.velocitypowered.api.proxy.Player player, net.kyori.adventure.text.Component title, String initialText)
static void	removeListener(VGuiListener listener)
static void	setInstance(VGuiService service)	Installs the service instance.
static ViewBuilder	view(ViewType type)	Starts building a view of the given type.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

public static VGuiService get()

The service instance.

Throws:

IllegalStateException - if VGui has not initialized yet. Declare a dependency on vgui so it loads first.

setInstance

public static void setInstance(VGuiService service)

Installs the service instance. Called by the platform bootstrap; do not call yourself.

isInitialized

public static boolean isInitialized()

Whether the service is initialized and ready.

chest

public static ViewBuilder chest(int rows)

Starts building a chest view with the given number of rows (1-6).

view

public static ViewBuilder view(ViewType type)

Starts building a view of the given type.

open

public static void open(com.velocitypowered.api.proxy.Player player,
 View view)

See Also:

• VGuiService.open(Player, View)

open

public static void open(com.velocitypowered.api.proxy.Player player,
 View view,
 ViewContext context)

See Also:

• VGuiService.open(Player, View, ViewContext)

open

public static void open(com.velocitypowered.api.proxy.Player player,
 View view,
 Consumer<ViewContext> contextBuilder)

See Also:

• VGuiService.open(Player, View, Consumer)

openReplacing

public static void openReplacing(com.velocitypowered.api.proxy.Player player,
 View view)

See Also:

• VGuiService.openReplacing(Player, View)

back

public static boolean back(com.velocitypowered.api.proxy.Player player)

See Also:

• VGuiService.back(Player)

close

public static void close(com.velocitypowered.api.proxy.Player player)

See Also:

• VGuiService.close(Player)

currentView

public static View currentView(com.velocitypowered.api.proxy.Player player)

See Also:

• VGuiService.currentView(Player)

currentContext

public static ViewContext currentContext(com.velocitypowered.api.proxy.Player player)

See Also:

• VGuiService.currentContext(Player)

currentContents

public static ViewContents currentContents(com.velocitypowered.api.proxy.Player player)

See Also:

• VGuiService.currentContents(Player)

isViewing

public static boolean isViewing(com.velocitypowered.api.proxy.Player player)

See Also:

• VGuiService.isViewing(Player)

prompt

public static CompletableFuture<String> prompt(com.velocitypowered.api.proxy.Player player,
 net.kyori.adventure.text.Component title)

See Also:

• VGuiService.prompt(Player, Component)

prompt

public static CompletableFuture<String> prompt(com.velocitypowered.api.proxy.Player player,
 net.kyori.adventure.text.Component title,
 String initialText)

See Also:

• VGuiService.prompt(Player, Component, String)

addListener

public static void addListener(VGuiListener listener)

See Also:

• VGuiService.addListener(VGuiListener)

removeListener

public static void removeListener(VGuiListener listener)

See Also:

• VGuiService.removeListener(VGuiListener)