Package net.minestom.server.event.inventory

Class InventoryOpenEvent

java.lang.Object

net.minestom.server.event.inventory.InventoryOpenEvent

All Implemented Interfaces:

Event, CancellableEvent, EntityEvent, EntityInstanceEvent, InstanceEvent, InventoryEvent, PlayerEvent, PlayerInstanceEvent

public class InventoryOpenEvent
extends Object
implements InventoryEvent, PlayerInstanceEvent, CancellableEvent

Called when a player open an Inventory.

Executed by Player.openInventory(Inventory).

Constructor Summary

Constructors

Constructor	Description
InventoryOpenEvent(@Nullable Inventory inventory, @NotNull Player player)

Method Summary

Modifier and Type	Method	Description
@Nullable Inventory	getInventory()	Gets the inventory to open, this could have been change by the setInventory(Inventory).
@NotNull Player	getPlayer()	Gets the player who opens the inventory.
boolean	isCancelled()	Gets if the Event should be cancelled or not.
void	setCancelled(boolean cancel)	Marks the Event as cancelled or not.
void	setInventory(@Nullable Inventory inventory)	Changes the inventory to open.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minestom.server.event.trait.EntityInstanceEvent

getInstance

Methods inherited from interface net.minestom.server.event.trait.PlayerEvent

getEntity

Constructor Details

InventoryOpenEvent

public InventoryOpenEvent(@Nullable
 @Nullable Inventory inventory,
 @NotNull
 @NotNull Player player)

Method Details

getPlayer

@NotNull
public @NotNull Player getPlayer()

Gets the player who opens the inventory.

Specified by:

getPlayer in interface PlayerEvent

Returns:

the player who opens the inventory

getInventory

@Nullable
public @Nullable Inventory getInventory()

Gets the inventory to open, this could have been change by the setInventory(Inventory).

Specified by:

getInventory in interface InventoryEvent

Returns:

the inventory to open, null to just close the current inventory if any

setInventory

public void setInventory(@Nullable
 @Nullable Inventory inventory)

Changes the inventory to open.

To do not open any inventory see setCancelled(boolean).

Parameters:

inventory - the inventory to open

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Gets if the Event should be cancelled or not.

Specified by:

isCancelled in interface CancellableEvent

Returns:

true if the event should be cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: CancellableEvent

Marks the Event as cancelled or not.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancel - true if the event should be cancelled, false otherwise