eu.wauz.wauzcore.menu.social

Class GroupMenu

java.lang.Object

eu.wauz.wauzcore.menu.social.GroupMenu

All Implemented Interfaces:

WauzInventory

public class GroupMenu
extends java.lang.Object
implements WauzInventory

An inventory that can be used as menu or for other custom interaction mechanics. Sub menu of the social menu, that is used for teaming up with other players.

Author:

Wauzmons

See Also:

WauzPlayerGroup

Constructor Summary

Constructors

Constructor and Description
GroupMenu()

Method Summary

Modifier and Type	Method and Description
java.util.List<WauzMode>	getGamemodes()
java.lang.String	getInventoryId()
void	handlePlayerInteractions(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack clicked) Handles a player head or option interaction.
private void	kickPlayer(org.bukkit.entity.Player player, org.bukkit.entity.Player target) Kicks a player out of the group.
static void	open(org.bukkit.entity.Player player) Opens the menu for the given player.
void	openInstance(org.bukkit.entity.Player player) Opens a new inventory of this type for the given player.
static void	passwordInput(org.bukkit.entity.Player player, java.lang.String groupUuidString, java.lang.String passwordString) Opens an menu to input a password for a group creation or join.
static void	playerSelection(org.bukkit.entity.Player player, boolean promote) Opens a view, showing all members of the player's group.
private void	promotePlayer(org.bukkit.entity.Player player, org.bukkit.entity.Player target) Promotes a player to the new group leader.
void	selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event) Checks if an event in this inventory was triggered by a player click.
static void	setGroupItemMeta(org.bukkit.inventory.ItemStack groupItemStack, WauzPlayerGroup playerGroup, boolean insideGroup) Adds information about a group to an item stack.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.wauz.wauzcore.menu.util.WauzInventory

destroyInventory

Constructor Detail

GroupMenu

public GroupMenu()

Method Detail

getInventoryId

public java.lang.String getInventoryId()

Specified by:

getInventoryId in interface WauzInventory

Returns:

The id of the inventory.

getGamemodes

public java.util.List<WauzMode> getGamemodes()

Specified by:

getGamemodes in interface WauzInventory

Returns:

The modes in which the inventory can be opened.

openInstance

public void openInstance(org.bukkit.entity.Player player)

Opens a new inventory of this type for the given player.

Specified by:

openInstance in interface WauzInventory

Parameters:

player - The player that should view the inventory.

open

public static void open(org.bukkit.entity.Player player)

Opens the menu for the given player. If the player is not in a group, a list of groups, aswell as options to create their own, will be shown. The color of a group changes depending on status: full (black), protected (yellow), open (lime). If the player is in a group, the current group info, a list of members to teleport to, aswell as an option to leave are shown. As a group leader there are additional options to kick a member or promote them to the new leader.

Parameters:

player - The player that should view the inventory.

See Also:

WauzPlayerGroupPool.getGroups(), WauzPlayerGroup.getPlayers(), setGroupItemMeta(ItemStack, WauzPlayerGroup, boolean), MenuUtils.setBorders(Inventory)

setGroupItemMeta

public static void setGroupItemMeta(org.bukkit.inventory.ItemStack groupItemStack,
                                    WauzPlayerGroup playerGroup,
                                    boolean insideGroup)

Adds information about a group to an item stack. The lore will contain the mode, leader, player amount, description and if it is password protected. If the viewer of the item is inside the group, available commands and the encoded password are shown additionally.

Parameters:

groupItemStack - The item stack that will receive the group infos.

playerGroup - The group to get the infos from.

insideGroup - If the viewer of the item is inside the group.

See Also:

WauzPlayerGroup.getWauzMode(), WauzPlayerGroup.getAdminUuidString(), WauzPlayerGroup.getPlayerAmount(), WauzPlayerGroup.getWrappedGroupDescription(), WauzPlayerGroup.isPasswordProtected()

passwordInput

public static void passwordInput(org.bukkit.entity.Player player,
                                 java.lang.String groupUuidString,
                                 java.lang.String passwordString)

Opens an menu to input a password for a group creation or join. Called again for each character to add to the password.

Parameters:

player - The player that is inputting a password character.

groupUuidString - The group that password is for.

passwordString - The incomplete password.

playerSelection

public static void playerSelection(org.bukkit.entity.Player player,
                                   boolean promote)

Opens a view, showing all members of the player's group. Used to promote or kick members.

Parameters:

player - The player that is promoting or kicking a member.

promote - If it is a promotion, else it is a kick.

See Also:

WauzPlayerGroup.getPlayers(), MenuUtils.setBorders(Inventory)

selectMenuPoint

public void selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event)

Checks if an event in this inventory was triggered by a player click. Cancels the event and initiates the corresponding group action, based on concrete menu item color. On light blue, a new group is created, optionally with password, if the item name doesn't contain "Open". On yellow, a group is joined, after successful password input. On lime, a group is joined directly. On gray, a password character is added or validated, if 5 characters are already reached. On a player head or option interaction, the corresponding handler is called.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

WauzPlayerGroup, WauzPlayerDataSectionSelections.setGroupUuidString(String), WauzPlayerGroupPool.regGroup(WauzPlayerGroup), passwordInput(Player, String, String), handlePlayerInteractions(Player, ItemStack)

handlePlayerInteractions

public void handlePlayerInteractions(org.bukkit.entity.Player player,
                                     org.bukkit.inventory.ItemStack clicked)

Handles a player head or option interaction. On a player head, the player is, depending on context, promoted, kicked or teleported to. On a golden helmet, a player selection is shown, to selected a player to promote to the new leader. On an iron boot, a player selection is shown, to select a player to kick. On a barrier, the player will leave the group.

Parameters:

player - The player who started the interaction.

clicked - The option to interact with.

See Also:

playerSelection(Player, boolean), promotePlayer(Player, Player), kickPlayer(Player, Player), WauzTeleporter.playerTeleportManual(Player, Player)

promotePlayer

private void promotePlayer(org.bukkit.entity.Player player,
                           org.bukkit.entity.Player target)

Promotes a player to the new group leader.

Parameters:

player - The player performing the action.

target - The player to get promoted.

kickPlayer

private void kickPlayer(org.bukkit.entity.Player player,
                        org.bukkit.entity.Player target)

Kicks a player out of the group.

Parameters:

player - The player performing the action.

target - The player to get kicked.