Package xyz.gmitch215.socketmc.screen

Class Overlay

java.lang.Object

xyz.gmitch215.socketmc.screen.Overlay

All Implemented Interfaces:

Serializable

public final class Overlay
extends Object
implements Serializable

Represents an overlay to be displayed over the screen.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Overlay(@NotNull DrawingContext context, boolean pauseScreen)	Constructs a new overlay.

Method Summary

Modifier and Type	Method	Description
@NotNull DrawingContext	getContext()	Gets the immutable drawing context of this overlay.
boolean	isPauseScreen()	Returns whether this overlay should pause the game.
void	setPauseScreen(boolean pauseScreen)	Sets whether this overlay should pause the game.

Methods inherited from class java.lang.Object

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

Constructor Details

Overlay

public Overlay(@NotNull
 @NotNull DrawingContext context,
 boolean pauseScreen)

Constructs a new overlay.

Parameters:

context - The drawing context to use on the overlay.

pauseScreen - Whether this overlay should pause the game.

Method Details

getContext

@NotNull
public @NotNull DrawingContext getContext()

Gets the immutable drawing context of this overlay.

Returns:

The Drawing Context.

isPauseScreen

public boolean isPauseScreen()

Returns whether this overlay should pause the game.

Returns:

true if the game should be paused, false otherwise.

setPauseScreen

public void setPauseScreen(boolean pauseScreen)

Sets whether this overlay should pause the game.

Parameters:

pauseScreen - true if the game should be paused, false otherwise.