Package com.palmergames.bukkit.towny.event.damage

Class TownyPlayerDamagePlayerEvent

java.lang.Object

org.bukkit.event.Event

com.palmergames.bukkit.towny.event.damage.TownyDamageEvent

com.palmergames.bukkit.towny.event.damage.TownyPlayerDamagePlayerEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class TownyPlayerDamagePlayerEvent
extends TownyDamageEvent

Part of the API which lets Towny's war and other plugins modify Towny's plot-permission-decision outcomes.

Author:

LlmDl

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class com.palmergames.bukkit.towny.event.damage.TownyDamageEvent

cancelled, cause, entity, loc, message, townblock

Constructor Summary

Constructors

Constructor	Description
TownyPlayerDamagePlayerEvent(org.bukkit.Location location, org.bukkit.entity.Entity harmedEntity, org.bukkit.event.entity.EntityDamageEvent.DamageCause cause, TownBlock townblock, boolean cancelled, org.bukkit.entity.Player attackingPlayer)	Event thrown when a player damages a player.

Method Summary

Modifier and Type	Method	Description
@Nullable Town	getAttackerTown()
org.bukkit.entity.Player	getAttackingPlayer()
@Nullable Resident	getAttackingResident()
static org.bukkit.event.HandlerList	getHandlerList()
org.bukkit.event.HandlerList	getHandlers()
org.bukkit.entity.Player	getVictimPlayer()
@Nullable Resident	getVictimResident()
@Nullable Town	getVictimTown()

Methods inherited from class com.palmergames.bukkit.towny.event.damage.TownyDamageEvent

getCause, getEntity, getLocation, getMessage, getTown, getTownBlock, hasTownBlock, isCancelled, isInWilderness, setCancelled, setMessage

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

TownyPlayerDamagePlayerEvent

public TownyPlayerDamagePlayerEvent(org.bukkit.Location location,
 org.bukkit.entity.Entity harmedEntity,
 org.bukkit.event.entity.EntityDamageEvent.DamageCause cause,
 TownBlock townblock,
 boolean cancelled,
 org.bukkit.entity.Player attackingPlayer)

Event thrown when a player damages a player.

Parameters:

location - Location of the entity being damaged.

harmedEntity - Entity getting exploded.

cause - DamageCause.

townblock - TownBlock or null if in the wilderness.

cancelled - Whether Towny will cancel this already.

attackingPlayer - Player causing the damage to the harmedEntity.

Method Details

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

getHandlers

public org.bukkit.event.HandlerList getHandlers()

Specified by:

getHandlers in class org.bukkit.event.Event

getAttackingPlayer

public org.bukkit.entity.Player getAttackingPlayer()

Returns:

Player harming the other player.

getVictimPlayer

public org.bukkit.entity.Player getVictimPlayer()

Returns:

Player being harmed by another player.

getAttackingResident

@Nullable
public @Nullable Resident getAttackingResident()

Returns:

Resident object of the attacking player or (unlikely,) null.

getVictimResident

@Nullable
public @Nullable Resident getVictimResident()

Returns:

Resident object of the victim player or (unlikely,) null.

getAttackerTown

@Nullable
public @Nullable Town getAttackerTown()

Returns:

Town object of the attacking Resident or (unlikely,) null.

getVictimTown

@Nullable
public @Nullable Town getVictimTown()

Returns:

Town object of the victim Resident or (unlikely,) null.