eu.wauz.wauzcore.mobs.citizens

Class WauzCitizenInteractions

java.lang.Object

eu.wauz.wauzcore.mobs.citizens.WauzCitizenInteractions

public class WauzCitizenInteractions
extends java.lang.Object

The interaction options of a citizen.

Author:

Wauzmons

See Also:

WauzCitizen

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	displayName The name of the citizen, as shown in chat.
private java.util.Map<org.bukkit.inventory.ItemStack,WauzPlayerEvent>	interactionEventMap A map of interaction events, indexed by the triggering item stacks.
private java.util.List<org.bukkit.inventory.ItemStack>	interactionItemStacks The list of item stacks, representing the interactions.
private java.lang.String	modeSelection The mode that should be selected from the hub on interaction.

Constructor Summary

Constructors

Constructor and Description
WauzCitizenInteractions(java.lang.String citizenName, java.lang.String displayName) Constructs a set of interactions for the citizen with the given name.

Method Summary

Modifier and Type	Method and Description
boolean	checkForValidInteractions(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack clickedItemStack) Triggers the corresponding event, if the player clicked an interaction item stack.
private void	createInteractionItemStack(java.lang.String citizenName, java.lang.String interactionKey) Creates an interaction item stack from the given values.
org.bukkit.inventory.Inventory	createInteractionMenuBase(CitizenInteractionMenu interactionMenu, java.lang.String menuTitle) Creates an inventory menu, containing all interaction item stacks.
java.lang.String	getModeSelection()

Methods inherited from class java.lang.Object

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

Field Detail

displayName

private java.lang.String displayName

The name of the citizen, as shown in chat.

modeSelection

private java.lang.String modeSelection

The mode that should be selected from the hub on interaction.

interactionItemStacks

private java.util.List<org.bukkit.inventory.ItemStack> interactionItemStacks

The list of item stacks, representing the interactions.

interactionEventMap

private java.util.Map<org.bukkit.inventory.ItemStack,WauzPlayerEvent> interactionEventMap

A map of interaction events, indexed by the triggering item stacks.

Constructor Detail

WauzCitizenInteractions

public WauzCitizenInteractions(java.lang.String citizenName,
                               java.lang.String displayName)

Constructs a set of interactions for the citizen with the given name.

Parameters:

citizenName - The canonical name of the citizen.

displayName - The display name of the citizen.

See Also:

CitizenConfigurator.getModeSelection(String), createInteractionItemStack(String, String)

Method Detail

checkForValidInteractions

public boolean checkForValidInteractions(org.bukkit.entity.Player player,
                                         org.bukkit.inventory.ItemStack clickedItemStack)

Triggers the corresponding event, if the player clicked an interaction item stack.

Parameters:

player - The player who chose the interaction.

clickedItemStack - The chosen interaction item stack.

Returns:

If a successful interaction was made.

createInteractionMenuBase

public org.bukkit.inventory.Inventory createInteractionMenuBase(CitizenInteractionMenu interactionMenu,
                                                                java.lang.String menuTitle)

Creates an inventory menu, containing all interaction item stacks.

Parameters:

interactionMenu - The menu to create the base for.

menuTitle - The title of the menu.

Returns:

The created inventory menu.

createInteractionItemStack

private void createInteractionItemStack(java.lang.String citizenName,
                                        java.lang.String interactionKey)

Creates an interaction item stack from the given values. Also creates an event entry in the interaction map.

Parameters:

citizenName - The name of the citizen.

interactionKey - The key of the citizen interaction.

getModeSelection

public java.lang.String getModeSelection()

Returns:

The mode that should be selected from the hub on interaction.