net.risingworld.api.events.player.world

Class PlayerCreativeTerrainEditEvent

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

All Implemented Interfaces:

Cancellable

public class PlayerCreativeTerrainEditEvent
extends PlayerWorldEditEvent

Called when a player uses the creative terrain edit tools (F5) to edit the terrain (e.g. remove, place, smooth etc).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlayerCreativeTerrainEditEvent.Mode

Constructor Summary

Constructors

Constructor and Description
PlayerCreativeTerrainEditEvent(Player player, int terrainID, int cx, int cy, int cz, int bx, int by, int bz, int brushsize, PlayerCreativeTerrainEditEvent.Mode mode)

Method Summary

Modifier and Type	Method and Description
int	getBrushSize() Gets the size of the brush.
PlayerCreativeTerrainEditEvent.Mode	getCreativeEditMode() Gets the edit mode, i.e. the terrain edit sub tool (Add, Subtract, Paint, Smooth etc).
int	getTerrainID() Gets the terrain id the player wants to place.
void	setTerrainID(int id) Changes the terrain 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

PlayerCreativeTerrainEditEvent

public PlayerCreativeTerrainEditEvent(Player player,
                                      int terrainID,
                                      int cx,
                                      int cy,
                                      int cz,
                                      int bx,
                                      int by,
                                      int bz,
                                      int brushsize,
                                      PlayerCreativeTerrainEditEvent.Mode mode)

Method Detail

getTerrainID

public int getTerrainID()

Gets the terrain id the player wants to place.

Returns:

the terrain id.

setTerrainID

public void setTerrainID(int id)

Changes the terrain id to another id.

Parameters:

id - the new terrain id.

getCreativeEditMode

public PlayerCreativeTerrainEditEvent.Mode getCreativeEditMode()

Gets the edit mode, i.e. the terrain edit sub tool (Add, Subtract, Paint, Smooth etc).

Returns:

the creative mode terrain edit tool.

getBrushSize

public int getBrushSize()

Gets the size of the brush.

Returns:

the brush size.