net.risingworld.api.events.player.world

Class PlayerEditConstructionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerConstructionEvent

net.risingworld.api.events.player.world.PlayerEditConstructionEvent

All Implemented Interfaces:

Cancellable

public class PlayerEditConstructionEvent
extends PlayerConstructionEvent
implements Cancellable

Called when the player edits a construction element (e.g. changes texture, changes rotation etc).

Constructor Summary

Constructors

Constructor and Description
PlayerEditConstructionEvent(Player player, commons.constructions.ConstructionElement construct)
PlayerEditConstructionEvent(Player player, short typeid, int texture, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, short sx, short sy, short sz, byte repetitionsh, byte repetitionsv, byte gap, short ntypeid, int ntexture, int ncx, int ncy, int ncz, short npx, short npy, short npz, short nrx, short nry, short nrz, short nsx, short nsy, short nsz, byte nrepetitionsh, byte nrepetitionsv, byte ngap)

Method Summary

Modifier and Type	Method and Description
int	getNewChunkPositionX() Gets the new x offset of the chunk (which contains the construction element).
int	getNewChunkPositionY() Gets the new y offset of the chunk (which contains the construction element).
int	getNewChunkPositionZ() Gets the new z offset of the chunk (which contains the construction element).
Vector3f	getNewConstructionPosition() Gets the new world position of the construction element as a Vector3f.
float	getNewConstructionPositionX() Gets the new world x position of the construction element.
float	getNewConstructionPositionY() Gets the new world y position of the construction element.
float	getNewConstructionPositionZ() Gets the new world z position of the construction element.
Quaternion	getNewConstructionRotation() Gets the new rotation of the construction element as a Quaternion.
Vector3f	getNewConstructionSize() Gets the new size (x, y, z) of the construction element as a Vector3f.
float	getNewConstructionSizeX()
float	getNewConstructionSizeY()
float	getNewConstructionSizeZ()
int	getNewConstructionTextureID() Gets the new texture of the construction element.
short	getNewConstructionTypeID() Gets the new type ID of the construction element.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.

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

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getConstructionDefinition, getConstructionPosition, getConstructionPositionX, getConstructionPositionY, getConstructionPositionZ, getConstructionRotation, getConstructionRotationX, getConstructionRotationY, getConstructionRotationZ, getConstructionSize, getConstructionSizeX, getConstructionSizeY, getConstructionSizeZ, getConstructionTextureID, getConstructionTypeID, getPX, getPY, getPZ, getRX, getRY, getRZ, getSX, getSY, getSZ

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

PlayerEditConstructionEvent

public PlayerEditConstructionEvent(Player player,
                                   commons.constructions.ConstructionElement construct)

PlayerEditConstructionEvent

public PlayerEditConstructionEvent(Player player,
                                   short typeid,
                                   int texture,
                                   int cx,
                                   int cy,
                                   int cz,
                                   short px,
                                   short py,
                                   short pz,
                                   short rx,
                                   short ry,
                                   short rz,
                                   short sx,
                                   short sy,
                                   short sz,
                                   byte repetitionsh,
                                   byte repetitionsv,
                                   byte gap,
                                   short ntypeid,
                                   int ntexture,
                                   int ncx,
                                   int ncy,
                                   int ncz,
                                   short npx,
                                   short npy,
                                   short npz,
                                   short nrx,
                                   short nry,
                                   short nrz,
                                   short nsx,
                                   short nsy,
                                   short nsz,
                                   byte nrepetitionsh,
                                   byte nrepetitionsv,
                                   byte ngap)

Method Detail

getNewConstructionTypeID

public short getNewConstructionTypeID()

Gets the new type ID of the construction element.

Returns:

the new construction element type ID.

getNewConstructionTextureID

public int getNewConstructionTextureID()

Gets the new texture of the construction element.

Returns:

the new construction element texture ID.

getNewChunkPositionX

public int getNewChunkPositionX()

Gets the new x offset of the chunk (which contains the construction element).

Returns:

the new x chunk offset.

getNewChunkPositionY

public int getNewChunkPositionY()

Gets the new y offset of the chunk (which contains the construction element).

Returns:

the new y chunk offset.

getNewChunkPositionZ

public int getNewChunkPositionZ()

Gets the new z offset of the chunk (which contains the construction element).

Returns:

the new z chunk offset.

getNewConstructionPosition

public Vector3f getNewConstructionPosition()

Gets the new world position of the construction element as a Vector3f.

Returns:

the new global construction element position as a Vector3f.

getNewConstructionPositionX

public float getNewConstructionPositionX()

Gets the new world x position of the construction element.

Returns:

the new global construction element x position.

getNewConstructionPositionY

public float getNewConstructionPositionY()

Gets the new world y position of the construction element.

Returns:

the new global construction element y position.

getNewConstructionPositionZ

public float getNewConstructionPositionZ()

Gets the new world z position of the construction element.

Returns:

the new global construction element z position.

getNewConstructionRotation

public Quaternion getNewConstructionRotation()

Gets the new rotation of the construction element as a Quaternion.

Returns:

the new construction element rotation as a Quaternion.

getNewConstructionSize

public Vector3f getNewConstructionSize()

Gets the new size (x, y, z) of the construction element as a Vector3f.

Returns:

the new size of the construction element as a Vector3f.

getNewConstructionSizeX

public float getNewConstructionSizeX()

getNewConstructionSizeY

public float getNewConstructionSizeY()

getNewConstructionSizeZ

public float getNewConstructionSizeZ()

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.