Package dev.aurelium.slate.info

Class PlaceholderInfo

java.lang.Object

dev.aurelium.slate.info.PlaceholderInfo

Direct Known Subclasses:

TemplatePlaceholderInfo

public class PlaceholderInfo
extends Object

Represents contextual information about a placeholder in a menu.

Constructor Summary

Constructors

Constructor	Description
PlaceholderInfo(Slate slate, org.bukkit.entity.Player player, String placeholder, ActiveMenu menu, PlaceholderData data)

Method Summary

Modifier and Type	Method	Description
PlaceholderData	data()	Gets data about the specific placeholder, such as where it is located (display name or lore), the active style, and list data if applicable.
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.
String	placeholder()	Gets the name of the placeholder string being replaced.
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

PlaceholderInfo

public PlaceholderInfo(Slate slate,
 org.bukkit.entity.Player player,
 String placeholder,
 ActiveMenu menu,
 PlaceholderData data)

Method Details

player

public org.bukkit.entity.Player player()

Gets the player viewing the menu.

Returns:

the player

placeholder

public String placeholder()

Gets the name of the placeholder string being replaced. This is the placeholder string in the menu file without the curly braces.

Returns:

the placeholder

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 active menu

data

public PlaceholderData data()

Gets data about the specific placeholder, such as where it is located (display name or lore), the active style, and list data if applicable.

Returns:

the placeholder data

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