net.risingworld.api.events.player.world

Class PlayerChangeObjectStatusEvent

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

All Implemented Interfaces:

Cancellable

public final class PlayerChangeObjectStatusEvent
extends PlayerObjectEvent
implements Cancellable

Called when the status of an object changes. For example, when someone opens a door (usually status 0 == closed, status 1 == opened), or turns on a furnace.

Example: If a player opens a door, an explosion will be triggered

1	@EventMethod
2	public void onPlayerChangeObjectStatusEvent(PlayerChangeObjectStatusEvent event){
3	//Get the object definition
4	Definitions.ObjectDefiniton definition = event.getObjectDefinition();
5
6	//The definition enables you to find out if the object is a door
7	if(definition.isDoor()){
8	//The door is booby-trapped: we will trigger an explosion
9	getWorld().triggerExplosion(event.getObjectPosition(), true, true);
10
11	//We don't want the player to pick up the door, so we cancel this event
12	event.setCancelled(true);
13	}
14	}

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
byte	getNewObjectStatus() Gets the new object status.
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

PlayerChangeObjectStatusEvent

public PlayerChangeObjectStatusEvent(Player player,
                                     commons.objects.ObjectElement object,
                                     byte newstatus)

PlayerChangeObjectStatusEvent

public PlayerChangeObjectStatusEvent(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,
                                     byte newstatus)

Method Detail

getNewObjectStatus

public byte getNewObjectStatus()

Gets the new object status.

Returns:

the new status.

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.