net.risingworld.api.events.player.world

Class PlayerPlaceObjectEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

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

net.risingworld.api.events.player.world.PlayerPlaceObjectEvent

All Implemented Interfaces:

Cancellable

public class PlayerPlaceObjectEvent
extends PlayerObjectEvent
implements Cancellable

Called when the player places an objects (furniture, doors, lamps, chests etc).

Example: Check if object is a chest, in this case, put some items in it

1	@EventMethod
2	public void onPlayerPlaceObjectEvent(PlayerPlaceObjectEvent event){
3	//Check if object is a chest - you can use the ObjectDefinition for this
4	if(event.getObjectDefinition().isChest()){
5	//If it's a chest, the chest ID is stored as "info ID". We can use this ID
6	//to retrieve the chest from the "World" class (see plugin.getWorld())
7	Chest chest = getWorld().getChest(event.getObjectInfoID());
8
9	//It's always recommendable to check if it's not null...
10	if(chest != null){
11	//Now we want to add a pickaxe. Instead of using hard coded item IDs,
12	//you can make use of the "ItemDefinition" class. Once you have the
13	//item definition, insert a new item to chest
14	Definitions.ItemDefinition pickaxe = Definitions.getItemDefinition("pickaxe");
15	chest.insertNewItem(pickaxe.getID(), 0, 1);
16
17	//We also want to put an axe into the chest
18	Definitions.ItemDefinition axe = Definitions.getItemDefinition("axe");
19	chest.insertNewItem(axe.getID(), 0, 1);
20
21	//Finally we want to put a full stack of tnt into the chest. We can use
22	//the item definition to get the max stack size
23	Definitions.ItemDefinition tnt = Definitions.getItemDefinition("tnt");
24	chest.insertNewItem(tnt.getID(), 0, tnt.getMaxStacksize());
25	}
26	}
27	}

Constructor Summary

Constructors

Constructor and Description
PlayerPlaceObjectEvent(Player player, commons.objects.ObjectElement object)
PlayerPlaceObjectEvent(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
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setObjectPosition(float x, float y, float z) Changes the object position.
void	setObjectPosition(Vector3f position) Changes the object position.
void	setObjectRotation(Quaternion rotation) Changes the object rotation.

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

getChunkPositionX, getChunkPositionY, getChunkPositionZ, getObjectDefinition, getObjectInfoID, getObjectPosition, getObjectPositionX, getObjectPositionY, getObjectPositionZ, getObjectRotation, getObjectRotationX, getObjectRotationY, getObjectRotationZ, getObjectStatus, getObjectTypeID, getObjectVariation, getPX, getPY, getPZ, getRX, getRY, getRZ

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

PlayerPlaceObjectEvent

public PlayerPlaceObjectEvent(Player player,
                              commons.objects.ObjectElement object)

PlayerPlaceObjectEvent

public PlayerPlaceObjectEvent(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

setObjectPosition

public void setObjectPosition(Vector3f position)

Changes the object position.

Parameters:

position - the new object world position.

setObjectPosition

public void setObjectPosition(float x,
                              float y,
                              float z)

Changes the object position.

Parameters:

x - the new object world x position.

y - the new object world y position.

z - the new object world z position.

setObjectRotation

public void setObjectRotation(Quaternion rotation)

Changes the object rotation.

Parameters:

rotation - the new object rotation. Set to null to reset the rotation (Quaternion.IDENTITY).

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.