net.risingworld.api.events.player.world

Class PlayerWorldHitEvent

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.PlayerWorldHitEvent

All Implemented Interfaces:

Cancellable

public class PlayerWorldHitEvent
extends PlayerWorldEditEvent

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

Example: Spawn block when player hits terrain

1	@EventMethod
2	public void onWorldHit(PlayerWorldHitEvent event){
3	//Get the "World" object (we need it to place blocks)
4	World world = getWorld();
5
6	//Check if player hits terrain
7	if(event.getType() == PlayerWorldHitEvent.Type.Terrain){
8	//Place block (id 182 == red-white striped texture) at hit position
9	world.placeBlock(182, event.getChunkPositionX(), event.getChunkPositionY(), event.getChunkPositionZ(), event.getBlockPositionX(), event.getBlockPositionY(), event.getBlockPositionZ());
10	}
11	}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerWorldHitEvent.Type

Constructor Summary

Constructors

Constructor and Description
PlayerWorldHitEvent(Player player, float hitx, float hity, float hitz, short dmg, short id, int cx, int cy, int cz, int bx, int by, int bz, PlayerWorldHitEvent.Type type)

Method Summary

Modifier and Type	Method and Description
short	getDamage() Gets the amount of damage the player deals with this hit.
Vector3f	getHitPosition() Gets the coordinates where the world was hit exactly.
float	getHitPositionX() Gets the x coordinate where the world was hit exactly.
float	getHitPositionY() Gets the y coordinate where the world was hit exactly.
float	getHitPositionZ() Gets the z coordinate where the world was hit exactly.
PlayerWorldHitEvent.Type	getType() Gets the world hit type, i.e. if the player hit terrain, blocks etc.

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

getBlockPositionX, getBlockPositionY, getBlockPositionZ, getChunkPositionX, getChunkPositionY, getChunkPositionZ, getGlobalBlockPositionX, getGlobalBlockPositionY, getGlobalBlockPositionZ, isCancelled, setCancelled

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

PlayerWorldHitEvent

public PlayerWorldHitEvent(Player player,
                           float hitx,
                           float hity,
                           float hitz,
                           short dmg,
                           short id,
                           int cx,
                           int cy,
                           int cz,
                           int bx,
                           int by,
                           int bz,
                           PlayerWorldHitEvent.Type type)

Method Detail

getDamage

public short getDamage()

Gets the amount of damage the player deals with this hit.

Returns:

the amount of damage.

getHitPosition

public Vector3f getHitPosition()

Gets the coordinates where the world was hit exactly.

Returns:

coordinates where the world was hit.

getHitPositionX

public float getHitPositionX()

Gets the x coordinate where the world was hit exactly.

Returns:

x coordinate where the world was hit.

getHitPositionY

public float getHitPositionY()

Gets the y coordinate where the world was hit exactly.

Returns:

y coordinate where the world was hit.

getHitPositionZ

public float getHitPositionZ()

Gets the z coordinate where the world was hit exactly.

Returns:

z coordinate where the world was hit.

getType

public PlayerWorldHitEvent.Type getType()

Gets the world hit type, i.e. if the player hit terrain, blocks etc.

Returns:

the world hit type.