net.risingworld.api.events.player.world

Class PlayerRemoveObjectEvent

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.PlayerRemoveObjectEvent

All Implemented Interfaces:

Cancellable

public class PlayerRemoveObjectEvent
extends PlayerObjectEvent
implements Cancellable

Called when the player removes an object (furniture, doors, lamps etc) without destroying it (usually this is called when a player deconstructs an object, i.e. when he picks it up).

Example: Check if object is a door

1	@EventMethod
2	public void onPlayerRemoveObjectEvent(PlayerRemoveObjectEvent event){
3	//Get the object definition
4	Definitions.ObjectDefiniton definition = event.getObjectDefinition();
5
6	//The object definition allows you to check if it is a door
7	if(definition.isDoor()){
8	//Now you can do something with the door...
9	evt.getPlayer().sendTextMessage("Removed a door!");
10	}
11	}

Constructor Summary

Constructors

Constructor and Description
PlayerRemoveObjectEvent(Player player, commons.objects.ObjectElement object)
PlayerRemoveObjectEvent(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.

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

PlayerRemoveObjectEvent

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

PlayerRemoveObjectEvent

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

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.