Enum Class CloseReason

java.lang.Object

java.lang.Enum<CloseReason>

me.agent.vgui.api.CloseReason

All Implemented Interfaces:

Serializable, Comparable<CloseReason>, Constable

public enum CloseReason
extends Enum<CloseReason>

Why a View was closed.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	The player closed the window themselves (e.g. pressed Esc).
DISCONNECT	The player disconnected from the proxy.
OVERRIDDEN	A backend server opened or closed a window, taking over the player's screen.
SERVER	A plugin closed the view via VGuiService.close(Player).
SHUTDOWN	The proxy is shutting down.
SWITCHED	The view was replaced by another proxy view opening for the same player.

Method Summary

Modifier and Type	Method	Description
static CloseReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CloseReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLIENT

public static final CloseReason CLIENT

The player closed the window themselves (e.g. pressed Esc).

SERVER

public static final CloseReason SERVER

A plugin closed the view via VGuiService.close(Player).

SWITCHED

public static final CloseReason SWITCHED

The view was replaced by another proxy view opening for the same player.

OVERRIDDEN

public static final CloseReason OVERRIDDEN

A backend server opened or closed a window, taking over the player's screen.

DISCONNECT

public static final CloseReason DISCONNECT

The player disconnected from the proxy.

SHUTDOWN

public static final CloseReason SHUTDOWN

The proxy is shutting down.

Method Details

values

public static CloseReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CloseReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null