Package me.remigio07.chatplugin.api.server.event.gui

Class GUIOpenEvent

java.lang.Object

me.remigio07.chatplugin.api.server.event.gui.GUIEvent

me.remigio07.chatplugin.api.server.event.gui.GUIOpenEvent

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, ChatPluginPlayerEvent, ChatPluginServerPlayerEvent

public class GUIOpenEvent
extends GUIEvent
implements CancellableEvent, ChatPluginServerPlayerEvent

Represents an event called just before a GUI is opened to a player.

See Also:

• SinglePageGUI.open(ChatPluginServerPlayer, boolean)
• FillableGUI.open(ChatPluginServerPlayer, int, boolean)

Constructor Summary

Constructors

Constructor	Description
GUIOpenEvent(GUI gui, ChatPluginServerPlayer player, int page, boolean openActions)	Constructs a new GUI open event.

Method Summary

Modifier and Type	Method	Description
int	getPage()	Gets the page opened to the player.
ChatPluginServerPlayer	getPlayer()	Gets the player involved with this event.
boolean	isCancelled()	Checks if this event has been cancelled and will not be executed.
boolean	isOpenActions()	Checks if open actions have been performed while opening.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

Methods inherited from class me.remigio07.chatplugin.api.server.event.gui.GUIEvent

getGUI

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.remigio07.chatplugin.api.common.event.ChatPluginEvent

call

Constructor Details

GUIOpenEvent

public GUIOpenEvent(GUI gui,
 ChatPluginServerPlayer player,
 int page,
 boolean openActions)

Constructs a new GUI open event.

Parameters:

gui - GUI involved

player - Player involved

page - Page involved

openActions - Whether open actions have been performed

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Checks if this event has been cancelled and will not be executed.

Specified by:

isCancelled in interface CancellableEvent

Returns:

Whether this event is cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Sets the cancellation state of this event.

It will be passed through other registered listeners even if it is cancelled, but it will not be executed.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - Whether this event should be cancelled

getPlayer

public ChatPluginServerPlayer getPlayer()

Description copied from interface: ChatPluginServerPlayerEvent

Gets the player involved with this event.

Specified by:

getPlayer in interface ChatPluginPlayerEvent

Specified by:

getPlayer in interface ChatPluginServerPlayerEvent

Returns:

Player involved

getPage

public int getPage()

Gets the page opened to the player.

Will return 0 for SinglePageGUIs

.

Returns:

GUI's page

isOpenActions

public boolean isOpenActions()

Checks if open actions have been performed while opening.

Returns:

Whether open actions have been performed