Package xyz.gmitch215.socketmc.screen

Class DefaultScreen

java.lang.Object

xyz.gmitch215.socketmc.screen.AbstractScreen

xyz.gmitch215.socketmc.screen.DefaultScreen

All Implemented Interfaces:

Serializable, Narratable, DataHolder

public final class DefaultScreen
extends AbstractScreen
implements DataHolder

Represents default screens built-in to the client.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultScreen	ADVANCEMENTS	Represents the advancements screen.
static final DefaultScreen	OPTIONS	Represents the options menu.
static final DefaultScreen	PAUSE	Represents the pause menu.
static final DefaultScreen	SHARE_TO_LAN	Represents the share to Local-Access-Network (LAN) menu.
static final DefaultScreen	STATS	Represents the player statistics screen.
static final DefaultScreen	TITLE	Represents the title screen.

Method Summary

Modifier and Type	Method	Description
static @NotNull DefaultScreen	alert(@NotNull Text title, @NotNull Text message)	Creates a new alert menu.
static @NotNull DefaultScreen	alert(@NotNull Text title, @NotNull Text message, @Nullable Text button)	Creates a new alert menu.
static @NotNull DefaultScreen	death()	Creates a new death screen.
static @NotNull DefaultScreen	death(@Nullable Text causeOfDeath)	Creates a new death screen.
static @NotNull DefaultScreen	death(@Nullable Text causeOfDeath, boolean hardcore)	Creates a new death screen.
static @NotNull DefaultScreen	disconnected(@NotNull Text title, @NotNull Text reason)	Creates a new disconnected screen.
static @NotNull DefaultScreen	disconnected(@NotNull Text title, @NotNull Text reason, @Nullable Text button)	Creates a new disconnected screen.
static @NotNull DefaultScreen	error(@NotNull Text title, @NotNull Text message)	Creates a new error screen.
static @NotNull Set<DefaultScreen>	getAllScreens()	Gets all the default screens built-in to the client.
Map<String,Object>	getData()	Gets an immutable copy for the data for this object.
@NotNull String	getIdentifier()	Gets the identifier for this default screen.
@NotNull String	getTitleJSON()	Gets the title of this screen.
static @NotNull DefaultScreen	message(@NotNull Text message)	Creates a new message screen.
String	toString()

Methods inherited from class xyz.gmitch215.socketmc.screen.AbstractScreen

fromByteArray, getNarrationMessageJSON, toByteArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface xyz.gmitch215.socketmc.util.DataHolder

data, data, data, data

Field Details

TITLE

public static final DefaultScreen TITLE

Represents the title screen.

PAUSE

public static final DefaultScreen PAUSE

Represents the pause menu.

OPTIONS

public static final DefaultScreen OPTIONS

Represents the options menu.

SHARE_TO_LAN

public static final DefaultScreen SHARE_TO_LAN

Represents the share to Local-Access-Network (LAN) menu.

ADVANCEMENTS

public static final DefaultScreen ADVANCEMENTS

Represents the advancements screen.

STATS

public static final DefaultScreen STATS

Represents the player statistics screen.

Method Details

getIdentifier

@NotNull
public @NotNull String getIdentifier()

Gets the identifier for this default screen.

Returns:

Screen Identifier

getData

public Map<String,Object> getData()

Description copied from interface: DataHolder

Gets an immutable copy for the data for this object.

Specified by:

getData in interface DataHolder

Returns:

Screen Data

getTitleJSON

@NotNull
public @NotNull String getTitleJSON()

Description copied from class: AbstractScreen

Gets the title of this screen.

Specified by:

getTitleJSON in class AbstractScreen

Returns:

Title in JSON Format

alert

@NotNull
public static @NotNull DefaultScreen alert(@NotNull
 @NotNull Text title,
 @NotNull
 @NotNull Text message)
                                    throws IllegalArgumentException

Creates a new alert menu.

Parameters:

title - Menu Title

message - Alert Message

Returns:

Alert Menu

Throws:

IllegalArgumentException - if title or message are null

alert

@NotNull
public static @NotNull DefaultScreen alert(@NotNull
 @NotNull Text title,
 @NotNull
 @NotNull Text message,
 @Nullable
 @Nullable Text button)
                                    throws IllegalArgumentException

Creates a new alert menu.

Parameters:

title - Menu Title

message - Alert Message

button - OK Button Text

Returns:

Alert Menu

Throws:

IllegalArgumentException - if title or message are null

disconnected

@NotNull
public static @NotNull DefaultScreen disconnected(@NotNull
 @NotNull Text title,
 @NotNull
 @NotNull Text reason)
                                           throws IllegalArgumentException

Creates a new disconnected screen.

Parameters:

title - Screen Title

reason - Disconnection Reason

Returns:

Disconnected Screen

Throws:

IllegalArgumentException - if title or reason are null

disconnected

@NotNull
public static @NotNull DefaultScreen disconnected(@NotNull
 @NotNull Text title,
 @NotNull
 @NotNull Text reason,
 @Nullable
 @Nullable Text button)
                                           throws IllegalArgumentException

Creates a new disconnected screen.

Parameters:

title - Screen Title

reason - Disconnection Reason

button - Return Button Text

Returns:

Disconnected Screen

Throws:

IllegalArgumentException - if title or reason are null

message

@NotNull
public static @NotNull DefaultScreen message(@NotNull
 @NotNull Text message)
                                      throws IllegalArgumentException

Creates a new message screen.

Parameters:

message - Message to Display

Returns:

Message Screen

Throws:

IllegalArgumentException - if message is null

death

@NotNull
public static @NotNull DefaultScreen death()

Creates a new death screen.

Returns:

Death Screen

death

@NotNull
public static @NotNull DefaultScreen death(@Nullable
 @Nullable Text causeOfDeath)

Creates a new death screen.

Parameters:

causeOfDeath - Cause of Death

Returns:

Death Screen

death

@NotNull
public static @NotNull DefaultScreen death(@Nullable
 @Nullable Text causeOfDeath,
 boolean hardcore)

Creates a new death screen.

Parameters:

causeOfDeath - Cause of Death

hardcore - Whether they died in hardcore mode

Returns:

Death Screen

error

@NotNull
public static @NotNull DefaultScreen error(@NotNull
 @NotNull Text title,
 @NotNull
 @NotNull Text message)
                                    throws IllegalArgumentException

Creates a new error screen.

Parameters:

title - Screen Title

message - Error Message

Returns:

Error Screen

Throws:

IllegalArgumentException - if title or message are null

getAllScreens

@NotNull
public static @NotNull Set<DefaultScreen> getAllScreens()

Gets all the default screens built-in to the client.

Returns:

Default Screens

toString

public String toString()

Overrides:

toString in class Object