net.risingworld.api.events.player.world

Class PlayerCreativePlaceBlockEvent

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

All Implemented Interfaces:

Cancellable

public class PlayerCreativePlaceBlockEvent
extends PlayerWorldEditEvent

Called when a player uses the creative placement tools (F6) to place blocks. This tool always fills an area with blocks.

Constructor Summary

Constructors

Constructor and Description
PlayerCreativePlaceBlockEvent(Player player, int blockID, int cx, int cy, int cz, int bx, int by, int bz, byte areaSizeX, byte areaSizeY, byte areaSizeZ)

Method Summary

Modifier and Type	Method and Description
byte	getAreaSizeX() Gets the X size of the area (i.e. the area that will be filled with blocks).
byte	getAreaSizeY() Gets the Y size of the area (i.e. the area that will be filled with blocks).
byte	getAreaSizeZ() Gets the Z size of the area (i.e. the area that will be filled with blocks).
int	getBlockID() Gets the id of the block the player wants to place.
void	setAreaSize(byte x, byte y, byte z) Overrides the size of the area (which will be filled with blocks).
void	setBlockID(int id) Changes the block id to another id.

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

PlayerCreativePlaceBlockEvent

public PlayerCreativePlaceBlockEvent(Player player,
                                     int blockID,
                                     int cx,
                                     int cy,
                                     int cz,
                                     int bx,
                                     int by,
                                     int bz,
                                     byte areaSizeX,
                                     byte areaSizeY,
                                     byte areaSizeZ)

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.

getAreaSizeX

public byte getAreaSizeX()

Gets the X size of the area (i.e. the area that will be filled with blocks).

Returns:

the size of the area along the x axis (horizontal).

getAreaSizeY

public byte getAreaSizeY()

Gets the Y size of the area (i.e. the area that will be filled with blocks).

Returns:

the size of the area along the y axis (vertical).

getAreaSizeZ

public byte getAreaSizeZ()

Gets the Z size of the area (i.e. the area that will be filled with blocks).

Returns:

the size of the area along the z axis (horizontal).

setAreaSize

public void setAreaSize(byte x,
                        byte y,
                        byte z)

Overrides the size of the area (which will be filled with blocks).

Parameters:

x - the x size of the area (along the x axis, horizontally).

y - the y size of the area (along the y axis, vertically).

z - the z size of the area (along the z axis, horizontally).