net.risingworld.api.events.player.world

Class PlayerConstructionEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

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

Direct Known Subclasses:

PlayerConstructionHitEvent, PlayerCreativeRemoveConstructionEvent, PlayerDestroyConstructionEvent, PlayerEditConstructionEvent, PlayerPlaceConstructionEvent, PlayerRemoveConstructionEvent

public abstract class PlayerConstructionEvent
extends PlayerEvent

Base class for any kind of interactions (destroy, pickup, use etc) with construction elements (planks, beams, windows, posters etc).

Constructor Summary

Constructors

Constructor and Description
PlayerConstructionEvent(Player player, commons.constructions.ConstructionElement construction)
PlayerConstructionEvent(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)

Method Summary

Modifier and Type	Method and Description
int	getChunkPositionX() Gets the x offset of the chunk (which contains the construction element).
int	getChunkPositionY() Gets the y offset of the chunk (which contains the construction element).
int	getChunkPositionZ() Gets the z offset of the chunk (which contains the construction element).
Definitions.ConstructionDefinition	getConstructionDefinition() Gets the construction definition for this element (this contains meta data about the construction element type).
Vector3f	getConstructionPosition() Gets the world position of the construction element as a Vector3f.
float	getConstructionPositionX() Gets the world x position of the construction element.
float	getConstructionPositionY() Gets the world y position of the construction element.
float	getConstructionPositionZ() Gets the world z position of the construction element.
Quaternion	getConstructionRotation() Gets the rotation of the construction element as a Quaternion.
float	getConstructionRotationX() Gets the rotation of the construction element as euler x angle (pitch).
float	getConstructionRotationY() Gets the rotation of the construction element as euler y angle (yaw).
float	getConstructionRotationZ() Gets the rotation of the construction element as euler z angle (roll).
Vector3f	getConstructionSize() Gets the size (x, y, z) of the construction element as a Vector3f.
float	getConstructionSizeX() Gets the x size of the construction element.
float	getConstructionSizeY() Gets the y size of the construction element.
float	getConstructionSizeZ() Gets the z size of the construction element.
int	getConstructionTextureID() Gets the texture of the construction element.
short	getConstructionTypeID() Gets the type ID of the construction element.
short	getPX() Gets the internal position value.
short	getPY() Gets the internal position value.
short	getPZ() Gets the internal position value.
short	getRX() Gets the internal rotation value.
short	getRY() Gets the internal rotation value.
short	getRZ() Gets the internal rotation value.
short	getSX() Gets the internal size value.
short	getSY() Gets the internal size value.
short	getSZ() Gets the internal size value.

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

PlayerConstructionEvent

public PlayerConstructionEvent(Player player,
                               commons.constructions.ConstructionElement construction)

PlayerConstructionEvent

public PlayerConstructionEvent(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)

Method Detail

getConstructionTypeID

public short getConstructionTypeID()

Gets the type ID of the construction element.

Returns:

the construction element type ID.

getConstructionTextureID

public int getConstructionTextureID()

Gets the texture of the construction element.

Returns:

the construction element texture ID.

getChunkPositionX

public int getChunkPositionX()

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

Returns:

the x chunk offset.

getChunkPositionY

public int getChunkPositionY()

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

Returns:

the y chunk offset.

getChunkPositionZ

public int getChunkPositionZ()

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

Returns:

the z chunk offset.

getConstructionPosition

public Vector3f getConstructionPosition()

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

Returns:

the global construction element position as a Vector3f.

getConstructionPositionX

public float getConstructionPositionX()

Gets the world x position of the construction element.

Returns:

the global construction element x position.

getConstructionPositionY

public float getConstructionPositionY()

Gets the world y position of the construction element.

Returns:

the global construction element y position.

getConstructionPositionZ

public float getConstructionPositionZ()

Gets the world z position of the construction element.

Returns:

the global construction element z position.

getConstructionRotation

public Quaternion getConstructionRotation()

Gets the rotation of the construction element as a Quaternion.

Returns:

the construction element rotation as a Quaternion.

getConstructionRotationX

public float getConstructionRotationX()

Gets the rotation of the construction element as euler x angle (pitch).

Returns:

the construction element rotation as euler x angle (pitch).

getConstructionRotationY

public float getConstructionRotationY()

Gets the rotation of the construction element as euler y angle (yaw).

Returns:

the construction element rotation as euler y angle (yaw).

getConstructionRotationZ

public float getConstructionRotationZ()

Gets the rotation of the construction element as euler z angle (roll).

Returns:

the construction element rotation as euler z angle (roll).

getConstructionSize

public Vector3f getConstructionSize()

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

Returns:

the size of the construction element as a Vector3f.

getConstructionSizeX

public float getConstructionSizeX()

Gets the x size of the construction element.

Returns:

the size of the construction element along the x axis.

getConstructionSizeY

public float getConstructionSizeY()

Gets the y size of the construction element.

Returns:

the size of the construction element along the y axis.

getConstructionSizeZ

public float getConstructionSizeZ()

Gets the z size of the construction element.

Returns:

the size of the construction element along the z axis.

getConstructionDefinition

public Definitions.ConstructionDefinition getConstructionDefinition()

Gets the construction definition for this element (this contains meta data about the construction element type).

Returns:

the construction element definition.

getPX

public short getPX()

Gets the internal position value. Use getConstructionPosition() instead!

Returns:

the internal x position value as a short.

getPY

public short getPY()

Gets the internal position value. Use getConstructionPosition() instead!

Returns:

the internal y position value as a short.

getPZ

public short getPZ()

Gets the internal position value. Use getConstructionPosition() instead!

Returns:

the internal z position value as a short.

getRX

public short getRX()

Gets the internal rotation value. Use getConstructionRotation() instead!

Returns:

the internal x rotation value as a short.

getRY

public short getRY()

Gets the internal rotation value. Use getConstructionRotation() instead!

Returns:

the internal y rotation value as a short.

getRZ

public short getRZ()

Gets the internal rotation value. Use getConstructionRotation() instead!

Returns:

the internal z rotation value as a short.

getSX

public short getSX()

Gets the internal size value. Use getConstructionSize() instead!

Returns:

the internal x size value as a short.

getSY

public short getSY()

Gets the internal size value. Use getConstructionSize() instead!

Returns:

the internal y size value as a short.

getSZ

public short getSZ()

Gets the internal size value. Use getConstructionSize() instead!

Returns:

the internal z size value as a short.