net.risingworld.api.events.player

Class PlayerHitEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerHitEvent

All Implemented Interfaces:

Cancellable

public class PlayerHitEvent
extends PlayerEvent
implements Cancellable

Called when a player hits / attacks another player.

See Also:

PlayerDamageEvent

Constructor Summary

Constructors

Constructor and Description
PlayerHitEvent(Player player, Player targetPlayer, Vector3f damagePoint, short damage, float distance)

Method Summary

Modifier and Type	Method and Description
short	getDamage() Gets the amount of damage this hit will cause.
Vector3f	getDamagePosition() Gets the coordinates where the player was hit exactly.
float	getDistance() Gets the distance between the player and the target player (or more precisely, the damage point).
Player	getTargetPlayer() Gets the target player, i.e. the player who was hit.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setDamage(short damage) Sets the amount of damage that will be caused by this hit.
void	setDamagePosition(float x, float y, float z) Sets the coordinates where the player was hit exactly.
void	setDamagePosition(Vector3f position) Sets the coordinates where the player was hit exactly.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerHitEvent

public PlayerHitEvent(Player player,
                      Player targetPlayer,
                      Vector3f damagePoint,
                      short damage,
                      float distance)

Method Detail

getTargetPlayer

public Player getTargetPlayer()

Gets the target player, i.e. the player who was hit.

Returns:

the player who was hit (the "victim").

setDamagePosition

public void setDamagePosition(Vector3f position)

Sets the coordinates where the player was hit exactly.

Parameters:

position - the new position.

setDamagePosition

public void setDamagePosition(float x,
                              float y,
                              float z)

Sets the coordinates where the player was hit exactly.

Parameters:

x - the x coordinate.

y - the y coordinate.

z - the z coordinate.

getDamagePosition

public Vector3f getDamagePosition()

Gets the coordinates where the player was hit exactly.

Returns:

coordinates where the player was hit.

setDamage

public void setDamage(short damage)

Sets the amount of damage that will be caused by this hit.

Parameters:

damage - the new damage amount.

getDamage

public short getDamage()

Gets the amount of damage this hit will cause.

Returns:

the amount of damage.

getDistance

public float getDistance()

Gets the distance between the player and the target player (or more precisely, the damage point).

Returns:

the distance.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.