net.risingworld.api.events.player

Class PlayerDamageEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerDamageEvent

All Implemented Interfaces:

Cancellable

public class PlayerDamageEvent
extends PlayerEvent
implements Cancellable

Called when a player takes damage (e.g. fall damage).

Example: Prevent player from taking fall damage

1	@EventMethod
2	public void onPlayerDamage(PlayerDamageEvent evt){
3	//Check if the "cause" is fall damage
4	if(evt.getCause() == PlayerDamageEvent.Cause.FallDamage){
5	//Cancel the event, to the player won't take any damage
6	evt.setCancelled(true);
7	}
8	}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerDamageEvent.Cause Determines why the PlayerDamageEvent was triggered exactly (i.e. what's causing the damage).

Constructor Summary

Constructors

Constructor and Description
PlayerDamageEvent(Player player, short damage, int previousHealth, PlayerDamageEvent.Cause cause)

Method Summary

Modifier and Type	Method and Description
PlayerDamageEvent.Cause	getCause() Gets the "cause" of this damage, i.e. the reason why the player takes damage (or in other words, what's causing the damage)
short	getDamage() Gets the amount of damage the player will receive.
int	getPreviousHealth() Gets the previous amount of health.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setDamage(short damage) Sets the amount of damage the player will receive.

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

PlayerDamageEvent

public PlayerDamageEvent(Player player,
                         short damage,
                         int previousHealth,
                         PlayerDamageEvent.Cause cause)

Method Detail

setDamage

public void setDamage(short damage)

Sets the amount of damage the player will receive.

Parameters:

damage - the new damage amount.

getDamage

public short getDamage()

Gets the amount of damage the player will receive.

Returns:

the amount of damage.

getPreviousHealth

public int getPreviousHealth()

Gets the previous amount of health.

Returns:

the old health of the player.

getCause

public PlayerDamageEvent.Cause getCause()

Gets the "cause" of this damage, i.e. the reason why the player takes damage (or in other words, what's causing the damage)

Returns:

the reason why the player takes damage.

Example: While the player holds an apple in his hands, he should be immune to lava

1	@EventMethod
2	public void onPlayerDamage(PlayerDamageEvent event){
3	//Get the currently equipped item (can be null!)
4	Item item = event.getPlayer().getEquippedItem();
5
6	//Check if item is an apple (but first, check if it's not null)
7	if(item != null && item.getName().equals("apple")){
8	//Player holds apple in his hand, so we can cancel this event
9	//(this means the player won't take any damage)
10	event.setCancelled(true);
11	}
12	}

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.