net.risingworld.api.events.player.world

Class PlayerObjectEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.world.PlayerObjectEvent

Direct Known Subclasses:

PlayerChangeObjectStatusEvent, PlayerChestAccessEvent, PlayerCreativeRemoveObjectEvent, PlayerDestroyObjectEvent, PlayerObjectHitEvent, PlayerObjectInteractionEvent, PlayerPlaceObjectEvent, PlayerRemoveObjectEvent

public abstract class PlayerObjectEvent
extends PlayerEvent

Base class for any kind of interactions (destroy, pickup, use etc) with objects (like furniture, doors, lamps etc).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlayerObjectEvent(Player player, commons.objects.ObjectElement object)
protected	PlayerObjectEvent(Player player, short objectid, byte variation, int cx, int cy, int cz, short px, short py, short pz, short rx, short ry, short rz, int info, byte status)

Method Summary

Modifier and Type	Method and Description
int	getChunkPositionX() Gets the x offset of the chunk (which contains the object).
int	getChunkPositionY() Gets the y offset of the chunk (which contains the object).
int	getChunkPositionZ() Gets the z offset of the chunk (which contains the object).
Definitions.ObjectDefinition	getObjectDefinition() Gets the object definition for this item (this contains meta data about the object type).
int	getObjectInfoID() Gets the info ID of the object.
Vector3f	getObjectPosition() Gets the world position of the object as a Vector3f.
float	getObjectPositionX() Gets the world x position of the object.
float	getObjectPositionY() Gets the world y position of the object.
float	getObjectPositionZ() Gets the world z position of the object.
Quaternion	getObjectRotation() Gets the rotation of the object as a Quaternion.
float	getObjectRotationX() Gets the object rotation as euler x angle (pitch).
float	getObjectRotationY() Gets the object rotation as euler y angle (yaw).
float	getObjectRotationZ() Gets the object rotation as euler z angle (roll).
byte	getObjectStatus() Gets the current status of the object.
short	getObjectTypeID() Gets the type ID of the object.
byte	getObjectVariation() Gets the variation of the objecth.
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

PlayerObjectEvent

protected PlayerObjectEvent(Player player,
                            commons.objects.ObjectElement object)

PlayerObjectEvent

protected PlayerObjectEvent(Player player,
                            short objectid,
                            byte variation,
                            int cx,
                            int cy,
                            int cz,
                            short px,
                            short py,
                            short pz,
                            short rx,
                            short ry,
                            short rz,
                            int info,
                            byte status)

Method Detail

getObjectTypeID

public short getObjectTypeID()

Gets the type ID of the object.

Returns:

the object type ID.

getObjectVariation

public byte getObjectVariation()

Gets the variation of the objecth.

Returns:

the object variation ID.

getChunkPositionX

public int getChunkPositionX()

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

Returns:

the x chunk offset.

getChunkPositionY

public int getChunkPositionY()

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

Returns:

the y chunk offset.

getChunkPositionZ

public int getChunkPositionZ()

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

Returns:

the z chunk offset.

getObjectPosition

public Vector3f getObjectPosition()

Gets the world position of the object as a Vector3f.

Returns:

the global object position as a Vector3f.

getObjectPositionX

public float getObjectPositionX()

Gets the world x position of the object.

Returns:

the global object x position.

getObjectPositionY

public float getObjectPositionY()

Gets the world y position of the object.

Returns:

the global object y position.

getObjectPositionZ

public float getObjectPositionZ()

Gets the world z position of the object.

Returns:

the global object z position.

getObjectRotation

public Quaternion getObjectRotation()

Gets the rotation of the object as a Quaternion.

Returns:

the object rotation as a Quaternion.

getObjectRotationX

public float getObjectRotationX()

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

Returns:

the object rotation as euler x angle (pitch).

getObjectRotationY

public float getObjectRotationY()

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

Returns:

the object rotation as euler y angle (yaw).

getObjectRotationZ

public float getObjectRotationZ()

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

Returns:

the object rotation as euler z angle (roll).

getObjectInfoID

public int getObjectInfoID()

Gets the info ID of the object. For regular objects, the info ID is usually -1 (so it's unused), only objects which hold additional information have an info ID (e.g. for a chest, the info ID is the global chest ID, for furnaces, it is the global furnace ID etc).

Returns:

the object info ID.

getObjectStatus

public byte getObjectStatus()

Gets the current status of the object. The status is only used by some objects, e.g. doors (usually status 0 == closed, status 1 == opened), chests (status only represents the visual state, like doors), furnaces etc.

Returns:

the object status.

getObjectDefinition

public Definitions.ObjectDefinition getObjectDefinition()

Gets the object definition for this item (this contains meta data about the object type).

Returns:

the object definition.

Example: Prevent player from destroying chests

1	// in our event listener...
2	@EventMethod
3	public void onObjectDestroy(PlayerDestroyObjectEvent event){
4	// get object definition for the related object
5	Definitions.ObjectDefinition def = event.getObjectDefinition();
6
7	// check if object is a chest (you get this info from the definitions)
8	if(def.isChest()){
9	// cancel event (so it does not get executed)
10	event.setCancelled(true);
11	}
12	}

getPX

public short getPX()

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

Returns:

the internal x position value as a short.

getPY

public short getPY()

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

Returns:

the internal y position value as a short.

getPZ

public short getPZ()

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

Returns:

the internal z position value as a short.

getRX

public short getRX()

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

Returns:

the internal x rotation value as a short.

getRY

public short getRY()

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

Returns:

the internal y rotation value as a short.

getRZ

public short getRZ()

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

Returns:

the internal z rotation value as a short.