net.risingworld.api.events.player

Class PlayerChestAccessEvent

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

All Implemented Interfaces:

Cancellable

public class PlayerChestAccessEvent
extends PlayerObjectEvent
implements Cancellable

Called when a player accesses a chest.

See Also:

PlayerObjectInteractionEvent

Constructor Summary

Constructors

Constructor and Description
PlayerChestAccessEvent(Player player, commons.objects.ObjectElement object)
PlayerChestAccessEvent(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
Chest	getChest()
int	getChestID() Gets the chest ID (does the same as PlayerObjectEvent.getObjectInfoID())
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

PlayerChestAccessEvent

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

PlayerChestAccessEvent

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

getChestID

public int getChestID()

Gets the chest ID (does the same as PlayerObjectEvent.getObjectInfoID())

Returns:

the global chest ID.

getChest

public Chest getChest()

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.