Package net.risingworld.api.events.player

Klasse PlayerHitPlayerEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerHitPlayerEvent

Alle implementierten Schnittstellen:

Cancellable

public final class PlayerHitPlayerEvent
extends PlayerEvent
implements Cancellable

Called when a player hits / attacks another player. It's always triggered no matter what kind of weapon the player uses (so it's triggered for both melee and ranged weapons). If you cancel the event, it won't be processed any further, i.e the target player won't get any damage

Siehe auch:

• PlayerDamageEvent

Feldübersicht

Von Klasse geerbte Felder net.risingworld.api.events.Event

cancelled, pointer

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
short	getDamage()	Gets the amount of damage this hit will cause.
float	getDistance()	Gets the distance between the player and the target player (or more precisely, the damage point).
Vector3f	getHitPosition()	Gets the coordinates where the player was hit exactly.
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	setHitPosition(float x, float y, float z)	Sets the coordinates where the player was hit exactly.
void	setHitPosition(Vector3f position)	Sets the coordinates where the player was hit exactly.

Von Klasse geerbte Methoden net.risingworld.api.events.player.PlayerEvent

getPlayer

Von Klasse geerbte Methoden net.risingworld.api.events.Event

equals, hashCode, isValid

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

getTargetPlayer

public Player getTargetPlayer()

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

Gibt zurück:

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

setHitPosition

public void setHitPosition(Vector3f position)

Sets the coordinates where the player was hit exactly.

Parameter:

position - the new position.

setHitPosition

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

Sets the coordinates where the player was hit exactly.

Parameter:

x - the x coordinate.

y - the y coordinate.

z - the z coordinate.

getHitPosition

public Vector3f getHitPosition()

Gets the coordinates where the player was hit exactly.

Gibt zurück:

coordinates where the player was hit.

setDamage

public void setDamage(short damage)

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

Parameter:

damage - the new damage amount.

getDamage

public short getDamage()

Gets the amount of damage this hit will cause.

Gibt zurück:

the amount of damage.

getDistance

public float getDistance()

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

Gibt zurück:

the distance.

isCancelled

public boolean isCancelled()

Beschreibung aus Schnittstelle kopiert: 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.

Angegeben von:

isCancelled in Schnittstelle Cancellable

Gibt zurück:

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

setCancelled

public void setCancelled(boolean cancel)

Beschreibung aus Schnittstelle kopiert: Cancellable

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

Angegeben von:

setCancelled in Schnittstelle Cancellable

Parameter:

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

Example: Cancel "PlayerEnterAreaEvent", i.e prevent player from entering an area

1	//Listener class
2	public class PlayerListener implements Listener{
3	@EventMethod
4	public void onEnterArea(PlayerEnterAreaEvent evt){
5	//Now the player will not be able to enter the area, i.e.
6	//he will be teleported back to his old position (outside the area)
7	evt.setCancelled(true);
8	}
9	}