eu.wauz.wauzcore.events

Class WauzPlayerEventHomeChange

java.lang.Object

eu.wauz.wauzcore.events.WauzPlayerEventHomeChange

All Implemented Interfaces:

WauzPlayerEvent

public class WauzPlayerEventHomeChange
extends java.lang.Object
implements WauzPlayerEvent

An event for changing the home location of a player.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	fromCommand If the event was triggered by a command.
private org.bukkit.Location	innkeeperLocation The location of the innkeeper, to set the home to.
private org.bukkit.inventory.ItemStack	scroll The scroll that triggered the event.

Fields inherited from interface eu.wauz.wauzcore.events.WauzPlayerEvent

core

Constructor Summary

Constructors

Constructor and Description
WauzPlayerEventHomeChange(org.bukkit.Location innkeeperLocation, boolean fromCommand) Creates an event to set the new home location of a player, to the position of an innkeeper.
WauzPlayerEventHomeChange(org.bukkit.Location innkeeperLocation, org.bukkit.inventory.ItemStack scroll) Creates an event to set the new home location of a player, to the position of an innkeeper.

Method Summary

Modifier and Type	Method and Description
boolean	execute(org.bukkit.entity.Player player) Executes the event for the given player.

Methods inherited from class java.lang.Object

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

Field Detail

innkeeperLocation

private org.bukkit.Location innkeeperLocation

The location of the innkeeper, to set the home to.

fromCommand

private boolean fromCommand

If the event was triggered by a command.

scroll

private org.bukkit.inventory.ItemStack scroll

The scroll that triggered the event.

Constructor Detail

WauzPlayerEventHomeChange

public WauzPlayerEventHomeChange(org.bukkit.Location innkeeperLocation,
                                 boolean fromCommand)

Creates an event to set the new home location of a player, to the position of an innkeeper.

Parameters:

innkeeperLocation - The location of the innkeeper, to set the home to.

fromCommand - If the event was triggered by a command.

WauzPlayerEventHomeChange

public WauzPlayerEventHomeChange(org.bukkit.Location innkeeperLocation,
                                 org.bukkit.inventory.ItemStack scroll)

Creates an event to set the new home location of a player, to the position of an innkeeper.

Parameters:

innkeeperLocation - The location of the innkeeper (in this case likely the player himself), to set the home to.

scroll - The scroll that triggered the event.

Method Detail

execute

public boolean execute(org.bukkit.entity.Player player)

Executes the event for the given player. If the player is not in Survival and executes this event per command it will fail. It will also fail if the region of the innkeeper is unknown.

Specified by:

execute in interface WauzPlayerEvent

Parameters:

player - The player for the execution.

Returns:

If the event was executed successfully.

See Also:

PlayerConfigurator.setCharacterHearthstone(Player, org.bukkit.Location, String)