Package net.risingworld.api.events.player.world

Class PlayerHitTerrainEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerWorldEditEvent

net.risingworld.api.events.player.world.PlayerHitTerrainEvent

All Implemented Interfaces:

Cancellable

public final class PlayerHitTerrainEvent
extends PlayerWorldEditEvent

Called when a player hits terrain with a tool (e.g pickaxe).

Field Summary

Fields inherited from class net.risingworld.api.events.Event

cancelled, pointer

Method Summary

Modifier and Type	Method	Description
short	getDamage()	Gets the amount of damage the player deals with this hit.
Vector3f	getHitPosition()	Gets the world coordinates where the terrain was hit exactly.
void	setDamage(short damage)	Sets the amount of damage the player should inflict with this hit.

Methods inherited from class net.risingworld.api.events.player.world.PlayerWorldEditEvent

getBlockPositionX, getBlockPositionY, getBlockPositionZ, getChunkPositionX, getChunkPositionY, getChunkPositionZ, isCancelled, setCancelled

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

getPlayer

Methods inherited from class net.risingworld.api.events.Event

equals, hashCode, isValid

Methods inherited from class java.lang.Object

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

Method Details

getDamage

public short getDamage()

Gets the amount of damage the player deals with this hit. To destroy terrain, the total damage must exceed a threshold of 100.

Returns:

the amount of damage.

setDamage

public void setDamage(short damage)

Sets the amount of damage the player should inflict with this hit. To destroy terrain, the total damage must exceed a threshold of 100.

Parameters:

damage - the new amount of damage.

getHitPosition

public Vector3f getHitPosition()

Gets the world coordinates where the terrain was hit exactly.

Returns:

coordinates where the terrain was hit.