eu.wauz.wauzcore.menu

Class CitizenInteractionMenu

java.lang.Object

eu.wauz.wauzcore.menu.CitizenInteractionMenu

All Implemented Interfaces:

WauzInventory

public class CitizenInteractionMenu
extends java.lang.Object
implements WauzInventory

An inventory that can be used as menu or for other custom interaction mechanics. A citizen interaction menu, that enables the player to talk to citizen npcs.

Author:

Wauzmons

See Also:

WauzCitizen, WauzCitizenSpawner

Field Summary

Fields

Modifier and Type	Field and Description
private WauzCitizen	citizen The citizen that should be interacted with.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	CitizenInteractionMenu(WauzCitizen citizen) Creates a new menu to interact with citizen npcs.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInventoryId()
static void	open(org.bukkit.entity.Player player, WauzCitizen citizen) Opens the menu for the given player.
void	selectMenuPoint(org.bukkit.event.inventory.InventoryClickEvent event) Checks if an interaction with the citizen was triggered by a player click.

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, getGamemodes, openInstance

Field Detail

citizen

private WauzCitizen citizen

The citizen that should be interacted with.

Constructor Detail

CitizenInteractionMenu

private CitizenInteractionMenu(WauzCitizen citizen)

Creates a new menu to interact with citizen npcs.

Parameters:

citizen - The citizen that should be interacted with.

Method Detail

getInventoryId

public java.lang.String getInventoryId()

Specified by:

getInventoryId in interface WauzInventory

Returns:

The id of the inventory.

open

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

Opens the menu for the given player. Always shows the relation to the given citizen and a "goodbye" option. A list of interactions is shown, based on the citizen. If a the citizen contains a mode selection, the screen of that gamemode is opened, instead of the menu.

Parameters:

player - The player that should view the inventory.

citizen - The citizen that should be interacted with.

See Also:

WauzCitizenInteractions.createInteractionMenuBase(CitizenInteractionMenu, String), WauzCitizenInteractions.getModeSelection(), WauzModeMenu.selectMenuPoint(InventoryClickEvent), MenuUtils.setBorders(Inventory)

selectMenuPoint

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

Checks if an interaction with the citizen was triggered by a player click. The default event will be automatically canceled.

Specified by:

selectMenuPoint in interface WauzInventory

Parameters:

event - The inventory click event.

See Also:

WauzCitizenInteractions.checkForValidInteractions(Player, ItemStack)