Package dev.aurelium.slate.info

Class MenuInfo

java.lang.Object

dev.aurelium.slate.info.MenuInfo

Direct Known Subclasses:

ItemClick, ItemInfo, PlaceholderInfo

public class MenuInfo
extends Object

Represents contextual information about an instance of a menu.

Constructor Summary

Constructors

Constructor	Description
MenuInfo(Slate slate, org.bukkit.entity.Player player, ActiveMenu menu)

Method Summary

Modifier and Type	Method	Description
Locale	locale()	Gets the locale of the player viewing the menu as defined by the GlobalBehavior.localeProvider().
ActiveMenu	menu()	Gets the ActiveMenu instance of the menu.
org.bukkit.entity.Player	player()	Gets the player viewing the menu.

Methods inherited from class java.lang.Object

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

Constructor Details

MenuInfo

public MenuInfo(Slate slate,
 org.bukkit.entity.Player player,
 ActiveMenu menu)

Method Details

player

public org.bukkit.entity.Player player()

Gets the player viewing the menu.

Returns:

the player

menu

public ActiveMenu menu()

Gets the ActiveMenu instance of the menu. This can be used to get properties of the menu and modify the menu while its open.

Returns:

the menu

locale

public Locale locale()

Gets the locale of the player viewing the menu as defined by the GlobalBehavior.localeProvider(). If the locale provider is not set, this will always return Locale.ENGLISH. This is useful if you have player-dependent locales.

Returns:

the locale of the player