Package net.risingworld.api.events.player.ui

Class PlayerToggleInventoryEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.ui.PlayerToggleInventoryEvent

All Implemented Interfaces:

Cancellable

public final class PlayerToggleInventoryEvent
extends PlayerEvent
implements Cancellable

Called when a player opens or closes the inventory. This is also invoked when the player accesses a storage.
Cancelling the event prevents the player from accessing the inventory. Please note that you can only cancel the open action (i.e if isVisible() returns true), you cannot prevent the player from closing the inventory!

Field Summary

Fields inherited from class net.risingworld.api.events.Event

cancelled, pointer

Method Summary

Modifier and Type	Method	Description
Storage	getStorage()	If a storage is accessed, this is the particular storage.
boolean	isCancelled()	Determines if the event is cancelled.
boolean	isVisible()	If true, the player tries to open his inventory.
void	setCancelled(boolean cancel)	Cancels this event.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class net.risingworld.api.events.Event

equals, hashCode, isValid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

isVisible

public boolean isVisible()

If true, the player tries to open his inventory. If false, the player tries to close it.

Returns:

true if the player wants to open his inventory, false if he wants to close it.

getStorage

public Storage getStorage()

If a storage is accessed, this is the particular storage. Otherwise, if the player just opens/closes his inventory, null is returned.

Returns:

the optional storage that is accessed, or null if the player just opens/closes his inventory.

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)

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Important: You cannot cancel this event if the player is closing the inventory (in other words, you cannot prevent the player from closing the inventory)

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.