net.risingworld.api.events.player.world

Class PlayerVegetationEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerVegetationEvent

Direct Known Subclasses:

PlayerCreativeRemoveVegetationEvent, PlayerDestroyVegetationEvent, PlayerPlaceVegetationEvent, PlayerRemoveVegetationEvent, PlayerVegetationHitEvent

public abstract class PlayerVegetationEvent
extends PlayerEvent

Base class for any kind of interactions (destroy, pickup, plant etc) with vegetations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlayerVegetationEvent(Player player, commons.world.Plant plant)
protected	PlayerVegetationEvent(Player player, short plantid, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, boolean iscut)

Method Summary

Modifier and Type	Method and Description
int	getChunkPositionX() Gets the x offset of the chunk (which contains the plant).
int	getChunkPositionY() Gets the y offset of the chunk (which contains the plant).
int	getChunkPositionZ() Gets the z offset of the chunk (which contains the plant).
Definitions.PlantDefinition	getPlantDefinition()
Vector3f	getPlantPosition() Gets the world position of the plant as a Vector3f.
float	getPlantPositionX() Gets the world x position of the plant.
float	getPlantPositionY() Gets the world y position of the plant.
float	getPlantPositionZ() Gets the world z position of the plant.
Quaternion	getPlantRotation() Gets the rotation of the plant as a Quaternion.
float	getPlantRotationX() Gets the plant rotation as euler x angle (pitch).
float	getPlantRotationY() Gets the plant rotation as euler y angle (yaw).
float	getPlantRotationZ() Gets the plant rotation as euler z angle (roll).
short	getPlantTypeID() Gets the type ID of the plant.
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.

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

PlayerVegetationEvent

protected PlayerVegetationEvent(Player player,
                                commons.world.Plant plant)

PlayerVegetationEvent

protected PlayerVegetationEvent(Player player,
                                short plantid,
                                int cx,
                                int cy,
                                int cz,
                                short px,
                                short py,
                                short pz,
                                short rx,
                                short ry,
                                short rz,
                                boolean iscut)

Method Detail

getPlantTypeID

public short getPlantTypeID()

Gets the type ID of the plant.

Returns:

the plant type ID.

getChunkPositionX

public int getChunkPositionX()

Gets the x offset of the chunk (which contains the plant).

Returns:

the x chunk offset.

getChunkPositionY

public int getChunkPositionY()

Gets the y offset of the chunk (which contains the plant).

Returns:

the y chunk offset.

getChunkPositionZ

public int getChunkPositionZ()

Gets the z offset of the chunk (which contains the plant).

Returns:

the z chunk offset.

getPlantPosition

public Vector3f getPlantPosition()

Gets the world position of the plant as a Vector3f.

Returns:

the global plant position as a Vector3f.

getPlantPositionX

public float getPlantPositionX()

Gets the world x position of the plant.

Returns:

the global plant x position.

getPlantPositionY

public float getPlantPositionY()

Gets the world y position of the plant.

Returns:

the global plant y position.

getPlantPositionZ

public float getPlantPositionZ()

Gets the world z position of the plant.

Returns:

the global plant z position.

getPlantRotation

public Quaternion getPlantRotation()

Gets the rotation of the plant as a Quaternion.

Returns:

the plant rotation as a Quaternion.

getPlantRotationX

public float getPlantRotationX()

Gets the plant rotation as euler x angle (pitch).

Returns:

the plant rotation as euler x angle (pitch).

getPlantRotationY

public float getPlantRotationY()

Gets the plant rotation as euler y angle (yaw).

Returns:

the plant rotation as euler y angle (yaw).

getPlantRotationZ

public float getPlantRotationZ()

Gets the plant rotation as euler z angle (roll).

Returns:

the plant rotation as euler z angle (roll).

getPlantDefinition

public Definitions.PlantDefinition getPlantDefinition()

getPX

public short getPX()

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

Returns:

the internal x position value as a short.

getPY

public short getPY()

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

Returns:

the internal y position value as a short.

getPZ

public short getPZ()

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

Returns:

the internal z position value as a short.

getRX

public short getRX()

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

Returns:

the internal x rotation value as a short.

getRY

public short getRY()

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

Returns:

the internal y rotation value as a short.

getRZ

public short getRZ()

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

Returns:

the internal z rotation value as a short.