net.risingworld.api.events.player.world

Class PlayerPlaceBlockEvent

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

All Implemented Interfaces:

Cancellable

public class PlayerPlaceBlockEvent
extends PlayerWorldEditEvent

Called when a player places a block in the world.

Constructor Summary

Constructors

Constructor and Description
PlayerPlaceBlockEvent(Player player, int blockID, int cx, int cy, int cz, int bx, int by, int bz, byte blockCount, byte blockDir)

Method Summary

Modifier and Type	Method and Description
int	getBlockID() Gets the id of the block the player wants to place.
byte	getMultiplePlacementCount() Gets the amount of blocks that will be placed.
byte	getMultiplePlacementDirection() Gets the block row direction if the player places multiple blocks in a row at once.
boolean	isMultiplePlacement() Gets whether or not the player places multiple blocks in a row at once.
void	setBlockID(int id) Changes the block id to another id.
void	setMultiplePlacementCount(byte count) Sets the amount of blocks that will be placed.
void	setMultiplePlacementDirection(byte direction) Sets the direction of the block row for multiple block placement (i.e. placing multiple blocks at once).

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

PlayerPlaceBlockEvent

public PlayerPlaceBlockEvent(Player player,
                             int blockID,
                             int cx,
                             int cy,
                             int cz,
                             int bx,
                             int by,
                             int bz,
                             byte blockCount,
                             byte blockDir)

Method Detail

getBlockID

public int getBlockID()

Gets the id of the block the player wants to place.

Returns:

the block id.

setBlockID

public void setBlockID(int id)

Changes the block id to another id.

Parameters:

id - the new block id.

getMultiplePlacementCount

public byte getMultiplePlacementCount()

Gets the amount of blocks that will be placed. Only relevant when isMultiplePlacement() is true (i.e. when the player places multiple blocks in a row at once).

Returns:

the amount of blocks that will be placed (usually 1 unless the player places multiple blocks in a row at once).

getMultiplePlacementDirection

public byte getMultiplePlacementDirection()

Gets the block row direction if the player places multiple blocks in a row at once.

Directions:
0 = single block placement
1 = positive x direction (+x)
2 = negative x direction (-x)
3 = positive y direction (+y)
4 = negative y direction (-y)
5 = positive z direction (+z)
6 = negative z direction (-z)

Returns:

the block row direction (or 0 if the player only places a single block).

setMultiplePlacementCount

public void setMultiplePlacementCount(byte count)

Sets the amount of blocks that will be placed. Only works when a placement direction is set, i.e. is greater than 0 (see setMultiplePlacementDirection(byte).

Parameters:

count - the amount of blocks that will be placed.

Example: Place 5 blocks on top of each other when the player places a block

1	@EventMethod
2	public void onPlayerPlaceBlock(PlayerPlaceBlockEvent event){
3	// set block placement direction to +y (3)
4	event.setMultiplePlacementDirection((byte) 3);
5
6	// now change the block amount (to 5 blocks)
7	event.setMultiplePlacementCount((byte) 5);
8	}

setMultiplePlacementDirection

public void setMultiplePlacementDirection(byte direction)

Sets the direction of the block row for multiple block placement (i.e. placing multiple blocks at once). Only makes sense if the block count (can be set with setMultiplePlacementCount(byte)) is greater than 1

Directions:
0 = single block placement
1 = positive x direction (+x)
2 = negative x direction (-x)
3 = positive y direction (+y)
4 = negative y direction (-y)
5 = positive z direction (+z)
6 = negative z direction (-z)

Parameters:

direction - the block row direction (set to 0 to disable multiple block placement, i.e. to just place a single block).

isMultiplePlacement

public boolean isMultiplePlacement()

Gets whether or not the player places multiple blocks in a row at once.

Returns:

true if the player places multiple blocks at once, false if he only places a single block.