xyz.gmitch215.socketmc.instruction.Instruction

All Implemented Interfaces:: Serializable, Paramaterized

public final class Instruction extends Object implements Serializable, Paramaterized

Represents a SocketMC Instruction to be sent to the client.
All instructions are serialized and sent over the network as byte arrays. They contain an id and a list of parameters that are serialized and sent through the player's channel.

Notes

Instructions are immutable and cannot be modified after creation.
Instructions are serializable and can be sent over the network as byte arrays.
All X, Y, Height, Width, and other measurements used in drawing instructions are in pixels.
Players render things on the screen based on their own FPS (Frames Per Second), hence the provision of timed renderings in milliseconds.
SocketMC v0.1.3 introduced a permission system that allows or disallows specific types of Instructions. If permission is not given, the Instruction will silently fail.

See Also:

Field Summary

Fields

Modifier and Type

Field

Description

static final String

CLOSE_SCREEN

Instruction to close the current GUI screen on the client's screen.

static final String

DISPLAY_TOAST

Instruction to display a toast message on the client's screen.

static final String

DRAW_BEACON_BEAM

Instruction to draw a beacon beam in the world.

static final String

DRAW_BUFFER

Instruction to set the draw buffer for the client.

static final String

DRAW_CONTEXT

Instruction to draw a raw DrawingContext.

static final String

DRAW_ITEMSTACK

Instruction to draw an item on the client's screen.

static final String

DRAW_SHAPE

Instruction to draw a rectangle on the client's screen.

static final String

DRAW_TEXT

Instruction to draw text on the client's screen.

static final String

DRAW_TEXTURE

Instruction to draw a texture on the client's screen.

static final String

EXTERNAL_WINDOW_MESSAGE_BOX

Instruction to display a message box using the OS's native notification system.

static final String

EXTERNAL_WINDOW_POPUP

Instruction to display a notification popup using the OS's native notification system.

static final String

HIDE_PLAYERS

Instruction to hide players from the social interactions menu.

static final String

LOG_MESSAGE

Instruction to log a message in the client's logs.

static final String

MAILTO

Instruction to open an external address in the client's default email application.

static final String

NARRATE

Instruction for the narrator to speak.

static final String

OPEN_BOOK_AND_QUILL

Instruction to open an empty book and quill GUI on the client's screen, allowing for long text input.

static final String

OPEN_LINK

Instruction to open an external link in the client's browser.

static final String

OPEN_SCREEN

Instruction to open a GUI screen on the client's screen.

static final String

OS_BEEP

Instruction to play the beeping noise specific to the client's operating system.

static final String

PING

Instruction to verify SocketMC is present.

static final String

PLAY_AUDIO

Instruction to play audio on the client's device.

static final String

RENDERER

Instruction to modify the functionality of a specific client renderer.

static final String

SET_OVERLAY

Instruction to change the overlay of the client.

static final String

SET_WINDOW_ICON

Instruction to change the native window icon of the client.

static final String

SET_WINDOW_TITLE

Instruction to change the native window title of the client.

static final String

SHOW_PLAYERS

Instruction to show players on the social interactions menu.
Method Summary

Modifier and Type

Method

Description

static @NotNull Instruction

closeScreen()

Creates a CLOSE_SCREEN instruction.

static @NotNull Instruction

displayToast(@NotNull Toast toast)

Creates a DISPLAY_TOAST instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, long millis)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Color color, int yOffset, float beamRadius, float glowRadius, long millis)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Color color, int yOffset, float beamRadius, float glowRadius, @NotNull Duration duration)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Color color, int yOffset, long millis)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Color color, int yOffset, @NotNull Duration duration)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Color color, long millis)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Color color, @NotNull Duration duration)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBeaconBeam(int x, int y, int z, int height, @NotNull Duration duration)

Creates a DRAW_BEACON_BEAM instruction.

static @NotNull Instruction

drawBuffer(@NotNull RenderBuffer buffer, long millis)

Creates a DRAW_BUFFER instruction.

static @NotNull Instruction

drawBuffer(@NotNull RenderBuffer buffer, @NotNull Duration duration)

Creates a DRAW_BUFFER instruction.

static @NotNull Instruction

drawContext(@NotNull DrawingContext context, long millis)

Creates a DRAW_CONTEXT instruction.

static @NotNull Instruction

drawContext(@NotNull DrawingContext context, @NotNull Duration duration)

Creates a DRAW_CONTEXT instruction.

static @NotNull Instruction

drawGradientRect(int x, int y, int width, int height, @NotNull Color from, int fromAlpha, @NotNull Color to, int toAlpha, int z, long millis)

Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").

static @NotNull Instruction

drawGradientRect(int x, int y, int width, int height, @NotNull Color from, int fromAlpha, @NotNull Color to, int toAlpha, int z, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").

static @NotNull Instruction

drawGradientRect(int x, int y, int width, int height, @NotNull Color from, int fromAlpha, @NotNull Color to, int toAlpha, long millis)

Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").

static @NotNull Instruction

drawGradientRect(int x, int y, int width, int height, @NotNull Color from, int fromAlpha, @NotNull Color to, int toAlpha, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").

static @NotNull Instruction

drawGradientRect(int x, int y, int width, int height, @NotNull Color from, @NotNull Color to, long millis)

Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").

static @NotNull Instruction

drawGradientRect(int x, int y, int width, int height, @NotNull Color from, @NotNull Color to, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").

static @NotNull Instruction

drawHorizontalLine(int x, int y, int width, long millis)

Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").

static @NotNull Instruction

drawHorizontalLine(int x, int y, int width, @NotNull Color color, int alpha, long millis)

Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").

static @NotNull Instruction

drawHorizontalLine(int x, int y, int width, @NotNull Color color, int alpha, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").

static @NotNull Instruction

drawHorizontalLine(int x, int y, int width, @NotNull Color color, long millis)

Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").

static @NotNull Instruction

drawHorizontalLine(int x, int y, int width, @NotNull Color color, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").

static @NotNull Instruction

drawHorizontalLine(int x, int y, int width, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").

static @NotNull Instruction

drawItemStack(@NotNull NBTTag item, int x, int y, int guiOffset, int randomSeed, long millis)

Creates a DRAW_ITEMSTACK instruction.

static @NotNull Instruction

drawItemStack(@NotNull NBTTag item, int x, int y, int guiOffset, int randomSeed, @NotNull Duration duration)

Creates a DRAW_ITEMSTACK instruction.

static @NotNull Instruction

drawItemStack(@NotNull NBTTag item, int x, int y, int guiOffset, long millis)

Creates a DRAW_ITEMSTACK instruction.

static @NotNull Instruction

drawItemStack(@NotNull NBTTag item, int x, int y, int guiOffset, @NotNull Duration duration)

Creates a DRAW_ITEMSTACK instruction.

static @NotNull Instruction

drawItemStack(@NotNull NBTTag item, int x, int y, long millis)

Creates a DRAW_ITEMSTACK instruction.

static @NotNull Instruction

drawItemStack(@NotNull NBTTag item, int x, int y, @NotNull Duration duration)

Creates a DRAW_ITEMSTACK instruction.

static @NotNull Instruction

drawRect(int x, int y, int width, int height, long millis)

Creates a DRAW_SHAPE instruction for a rectangle ("fill").

static @NotNull Instruction

drawRect(int x, int y, int width, int height, @NotNull Color color, int alpha, long millis)

Creates a DRAW_SHAPE instruction for a rectangle ("fill").

static @NotNull Instruction

drawRect(int x, int y, int width, int height, @NotNull Color color, int alpha, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a rectangle ("fill").

static @NotNull Instruction

drawRect(int x, int y, int width, int height, @NotNull Color color, long millis)

Creates a DRAW_SHAPE instruction for a rectangle ("fill").

static @NotNull Instruction

drawRect(int x, int y, int width, int height, @NotNull Color color, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a rectangle ("fill").

static @NotNull Instruction

drawRect(int x, int y, int width, int height, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a rectangle ("fill").

static @NotNull Instruction

drawText(int x, int y, @NotNull String text, long millis)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, @NotNull String text, @NotNull Duration duration)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, int argb, boolean dropShadow, long millis)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, int argb, boolean dropShadow, @NotNull Duration duration)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, @NotNull Color color, int alpha, boolean dropShadow, long millis)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, @NotNull Color color, int alpha, boolean dropShadow, @NotNull Duration duration)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, @NotNull Color color, int alpha, long millis)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, @NotNull Color color, int alpha, @NotNull Duration duration)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, @NotNull Color color, long millis)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, String text, @NotNull Color color, @NotNull Duration duration)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, @NotNull Text text, long millis)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawText(int x, int y, @NotNull Text text, @NotNull Duration duration)

Creates a DRAW_TEXT instruction.

static @NotNull Instruction

drawTexture(int x, int y, int width, int height, @NotNull Identifier texture, int startLeft, int startTop, int regionWidth, int regionHeight, long millis)

Creates a DRAW_TEXTURE instruction.

static @NotNull Instruction

drawTexture(int x, int y, int width, int height, @NotNull Identifier texture, int startLeft, int startTop, int regionWidth, int regionHeight, @NotNull Duration duration)

Creates a DRAW_TEXTURE instruction.

static @NotNull Instruction

drawTexture(int x, int y, int width, int height, @NotNull Identifier texture, int startLeft, int startTop, long millis)

Creates a DRAW_TEXTURE instruction.

static @NotNull Instruction

drawTexture(int x, int y, int width, int height, @NotNull Identifier texture, int startLeft, int startTop, @NotNull Duration duration)

Creates a DRAW_TEXTURE instruction.

static @NotNull Instruction

drawTexture(int x, int y, int width, int height, @NotNull Identifier texture, long millis)

Creates a DRAW_TEXTURE instruction.

static @NotNull Instruction

drawTexture(int x, int y, int width, int height, @NotNull Identifier texture, @NotNull Duration duration)

Creates a DRAW_TEXTURE instruction.

static @NotNull Instruction

drawVerticalLine(int x, int y, int height, long millis)

Creates a DRAW_SHAPE instruction for a vertical line ("line_v").

static @NotNull Instruction

drawVerticalLine(int x, int y, int height, @NotNull Color color, int alpha, long millis)

Creates a DRAW_SHAPE instruction for a vertical line ("line_v").

static @NotNull Instruction

drawVerticalLine(int x, int y, int height, @NotNull Color color, int alpha, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a vertical line ("line_v").

static @NotNull Instruction

drawVerticalLine(int x, int y, int height, @NotNull Color color, long millis)

Creates a DRAW_SHAPE instruction for a vertical line ("line_v").

static @NotNull Instruction

drawVerticalLine(int x, int y, int height, @NotNull Color color, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a vertical line ("line_v").

static @NotNull Instruction

drawVerticalLine(int x, int y, int height, @NotNull Duration duration)

Creates a DRAW_SHAPE instruction for a vertical line ("line_v").

boolean

equals(Object o)

static @NotNull Instruction

externalWindowMessageBox(@NotNull String title, @NotNull String message)

Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction with WindowDialogue.OK.

static @NotNull Instruction

externalWindowMessageBox(@NotNull String title, @NotNull String message, @NotNull WindowDialogue dialogue)

Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction.

static @NotNull Instruction

externalWindowMessageBox(@NotNull String title, @NotNull String message, @NotNull WindowDialogue dialogue, @NotNull WindowIcon icon)

Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction.

static @NotNull Instruction

externalWindowMessageBox(@NotNull String title, @NotNull String message, @NotNull WindowDialogue dialogue, @NotNull WindowIcon icon, boolean cancelDefault)

Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction.

static @NotNull Instruction

externalWindowPopup(@NotNull String title, @NotNull String message)

Creates a EXTERNAL_WINDOW_POPUP instruction.

static @NotNull Instruction

externalWindowPopup(@NotNull String title, @NotNull String message, @NotNull WindowIcon icon)

Creates a EXTERNAL_WINDOW_POPUP instruction.

static @Nullable Instruction

fromByteArray(byte[] instruction)

Deserializes an Instruction from a byte array received over the network.

@NotNull String

getId()

Gets the ID of this instruction.

@Unmodifiable @NotNull List<Object>

getParameters()

Gets an immutable copy of this instruction's parameters.

@NotNull ModPermission

getPermission()

Gets the permission required to execute this instruction.

static @NotNull ModPermission

getPermission(@NotNull String id)

Gets the permission required to execute an instruction by its ID.

int

hashCode()

static @NotNull Instruction

hidePlayers(@NotNull Iterable<UUID> players)

Creates a HIDE_PLAYERS instruction.

static @NotNull Instruction

hidePlayers(@NotNull UUID... players)

Creates a HIDE_PLAYERS instruction.

static String[]

ids()

Gets all the IDs of the instructions in this class.

static @NotNull Instruction

logMessage(@NotNull String message)

Creates a LOG_MESSAGE instruction.

static @NotNull Instruction

mailto(@NotNull String email)

Creates a MAILTO instruction.

static @NotNull Instruction

mailto(@NotNull URI mailto)

Creates a MAILTO instruction.

static @NotNull Instruction

narrate(@NotNull String text)

Creates a NARRATE instruction.

static @NotNull Instruction

narrate(@NotNull String text, boolean interrupt)

Creates a NARRATE instruction.

static @NotNull Instruction

openBookAndQuill()

Creates a OPEN_BOOK_AND_QUILL instruction.

static @NotNull Instruction

openLink(@NotNull URI uri)

Creates a OPEN_LINK instruction.

static @NotNull Instruction

openScreen(@NotNull AbstractScreen screen)

Creates a OPEN_SCREEN instruction.

static @NotNull Instruction

osBeep()

Creates a OS_BEEP instruction.

static @NotNull Instruction

ping()

Creates a PING instruction.

static @NotNull Instruction

playAudio(@NotNull File file)

Creates a PLAY_AUDIO instruction.

static @NotNull Instruction

playAudio(@NotNull InputStream file)

Creates a PLAY_AUDIO instruction.

static @NotNull Instruction

renderer(@NotNull RenderInstruction instruction)

Creates a RENDERER instruction.

static @NotNull Instruction

setOverlay(@Nullable Overlay overlay)

Creates a SET_OVERLAY instruction.

static @NotNull Instruction

setWindowIcon(byte[] icon)

Creates a SET_WINDOW_ICON instruction.

static @NotNull Instruction

setWindowTitle(@NotNull String title)

Creates a SET_WINDOW_TITLE instruction.

static @NotNull Instruction

showPlayers(@NotNull Iterable<UUID> players)

Creates a SHOW_PLAYERS instruction.

static @NotNull Instruction

showPlayers(@NotNull UUID... players)

Creates a SHOW_PLAYERS instruction.

byte[]

toByteArray()

Serializes this Instruction to a byte array to be passed over the network.

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xyz.gmitch215.socketmc.util.Paramaterized
booleanParameter, booleanParameter, doubleParameter, doubleParameter, firstBooleanParameter, firstDoubleParameter, firstFloatParameter, firstIntParameter, firstLongParameter, firstParameter, firstParameter, firstStringParameter, floatParameter, floatParameter, getParameters, intParameter, intParameter, lastBooleanParameter, lastDoubleParameter, lastFloatParameter, lastIntParameter, lastLongParameter, lastParameter, lastParameter, lastStringParameter, longParameter, longParameter, parameter, parameter, parameter, stringParameter, stringParameter

Field Details
- PING
  
  public static final String PING
  
  Instruction to verify SocketMC is present. This then enables events to be sent from the client to the server, if not already enabled.
  See Also:
  
  Constant Field Values
- DRAW_TEXT
  
  public static final String DRAW_TEXT
  
  Instruction to draw text on the client's screen.
  See Also:
  
  Constant Field Values
- DRAW_SHAPE
  
  public static final String DRAW_SHAPE
  
  Instruction to draw a rectangle on the client's screen.
  See Also:
  
  Constant Field Values
- PLAY_AUDIO
  
  public static final String PLAY_AUDIO
  
  Instruction to play audio on the client's device. This supports all audio formats supported by the client, according to its JDK. Most commonly is .wav and .au.
  See Also:
  
  AudioSystem.getAudioFileTypes()
  
  Constant Field Values
- DRAW_BUFFER
  
  public static final String DRAW_BUFFER
  
  Instruction to set the draw buffer for the client. This is used to draw complex shapes on the client's screen.
  See Also:
  
  Constant Field Values
- LOG_MESSAGE
  
  public static final String LOG_MESSAGE
  
  Instruction to log a message in the client's logs. This is not the same thing as the AuditLog API.
  See Also:
  
  Constant Field Values
- DRAW_TEXTURE
  
  public static final String DRAW_TEXTURE
  
  Instruction to draw a texture on the client's screen.
  See Also:
  
  Constant Field Values
- OPEN_BOOK_AND_QUILL
  
  public static final String OPEN_BOOK_AND_QUILL
  
  Instruction to open an empty book and quill GUI on the client's screen, allowing for long text input.
  See Also:
  
  Constant Field Values
- OPEN_SCREEN
  
  public static final String OPEN_SCREEN
  
  Instruction to open a GUI screen on the client's screen.
  See Also:
  
  Constant Field Values
- CLOSE_SCREEN
  
  public static final String CLOSE_SCREEN
  
  Instruction to close the current GUI screen on the client's screen.
  See Also:
  
  Constant Field Values
- RENDERER
  
  public static final String RENDERER
  
  Instruction to modify the functionality of a specific client renderer.
  See Also:
  
  Constant Field Values
- DRAW_BEACON_BEAM
  
  public static final String DRAW_BEACON_BEAM
  
  Instruction to draw a beacon beam in the world.
  See Also:
  
  Constant Field Values
- OPEN_LINK
  
  public static final String OPEN_LINK
  
  Instruction to open an external link in the client's browser.
  See Also:
  
  Constant Field Values
- MAILTO
  
  public static final String MAILTO
  
  Instruction to open an external address in the client's default email application.
  See Also:
  
  Constant Field Values
- DRAW_CONTEXT
  
  public static final String DRAW_CONTEXT
  
  Instruction to draw a raw DrawingContext.
  See Also:
  
  Constant Field Values
- NARRATE
  
  public static final String NARRATE
  
  Instruction for the narrator to speak.
  See Also:
  
  Constant Field Values
- DISPLAY_TOAST
  
  public static final String DISPLAY_TOAST
  
  Instruction to display a toast message on the client's screen.
  See Also:
  
  Constant Field Values
- OS_BEEP
  
  public static final String OS_BEEP
  
  Instruction to play the beeping noise specific to the client's operating system.
  See Also:
  
  Constant Field Values
- EXTERNAL_WINDOW_POPUP
  
  public static final String EXTERNAL_WINDOW_POPUP
  
  Instruction to display a notification popup using the OS's native notification system.
  See Also:
  
  Constant Field Values
- EXTERNAL_WINDOW_MESSAGE_BOX
  
  public static final String EXTERNAL_WINDOW_MESSAGE_BOX
  
  Instruction to display a message box using the OS's native notification system.
  See Also:
  
  Constant Field Values
- SET_WINDOW_TITLE
  
  public static final String SET_WINDOW_TITLE
  
  Instruction to change the native window title of the client.
  See Also:
  
  Constant Field Values
- SET_OVERLAY
  
  public static final String SET_OVERLAY
  
  Instruction to change the overlay of the client.
  See Also:
  
  Constant Field Values
- DRAW_ITEMSTACK
  
  public static final String DRAW_ITEMSTACK
  
  Instruction to draw an item on the client's screen.
  See Also:
  
  Constant Field Values
- SET_WINDOW_ICON
  
  public static final String SET_WINDOW_ICON
  
  Instruction to change the native window icon of the client.
  See Also:
  
  Constant Field Values
- SHOW_PLAYERS
  
  public static final String SHOW_PLAYERS
  
  Instruction to show players on the social interactions menu.
  See Also:
  
  Constant Field Values
- HIDE_PLAYERS
  
  public static final String HIDE_PLAYERS
  
  Instruction to hide players from the social interactions menu.
  See Also:
  
  Constant Field Values
Method Details
- getId
  
  @NotNull public @NotNull String getId()
  
  Gets the ID of this instruction.
  
  Returns:
  
  Instruction ID
- getParameters
  
  @NotNull public @Unmodifiable @NotNull List<Object> getParameters()
  
  Gets an immutable copy of this instruction's parameters.
  
  Specified by:
  
  getParameters in interface Paramaterized
  
  Returns:
  
  Instruction Parameters
- getPermission
  
  @NotNull public @NotNull ModPermission getPermission()
  
  Gets the permission required to execute this instruction.
  
  Returns:
  
  Instruction Permission
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- ids
  
  public static String[] ids()
  
  Gets all the IDs of the instructions in this class.
  
  Returns:
  
  Instruction IDs
- getPermission
  
  @NotNull public static @NotNull ModPermission getPermission(@NotNull @NotNull String id)
  
  Gets the permission required to execute an instruction by its ID.
  
  Parameters:
  
  id - Instruction ID
  
  Returns:
  
  Instruction Permission
- ping
  
  @NotNull public static @NotNull Instruction ping()
  
  Creates a PING instruction.
  
  Returns:
  
  Ping Instruction
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, @NotNull @NotNull String text, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  duration - Time Duration
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, or the text is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, @NotNull @NotNull String text, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, or the text is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, @NotNull @NotNull Color color, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  color - Text Color
  
  duration - Time Duration
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, the text is null, or the color is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, @NotNull @NotNull Color color, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  color - Text Color
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates are negative, the text is null, or the color is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, @NotNull @NotNull Color color, int alpha, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  color - Text Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  duration - Time Duration
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, the text is null, the color is null, or alpha is not 0-255
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, @NotNull @NotNull Color color, int alpha, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  color - Text Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, the text is null, the color is null, or alpha is not 0-255
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, @NotNull @NotNull Color color, int alpha, boolean dropShadow, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  color - Text Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  dropShadow - Whether to Draw a Drop Shadow
  
  duration - Time Duration
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates are negative, the text is null, or the color is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, @NotNull @NotNull Color color, int alpha, boolean dropShadow, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  color - Text Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  dropShadow - Whether to Draw a Drop Shadow
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates are negative, the text is null, or the color is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, int argb, boolean dropShadow, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  argb - Text Color (ARGB)
  
  dropShadow - Whether to Draw a Drop Shadow
  
  duration - Time Duration
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates are negative, the text is null, or the color is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, String text, int argb, boolean dropShadow, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  argb - Text Color (ARGB)
  
  dropShadow - Whether to Draw a Drop Shadow
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates are negative, the text is null, or the color is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, @NotNull @NotNull Text text, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  duration - Time Duration
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, or the text is null
- drawText
  
  @NotNull public static @NotNull Instruction drawText(int x, int y, @NotNull @NotNull Text text, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXT instruction.
  
  Parameters:
  
  x - X Coordinate for Text
  
  y - Y Coordinate for Text
  
  text - Text to Draw
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Text Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or duration are negative, or the text is null
- drawRect
  
  @NotNull public static @NotNull Instruction drawRect(int x, int y, int width, int height, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a rectangle ("fill").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative
- drawRect
  
  @NotNull public static @NotNull Instruction drawRect(int x, int y, int width, int height, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a rectangle ("fill").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative
- drawRect
  
  @NotNull public static @NotNull Instruction drawRect(int x, int y, int width, int height, @NotNull @NotNull Color color, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a rectangle ("fill").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  color - Shape Color
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawRect
  
  @NotNull public static @NotNull Instruction drawRect(int x, int y, int width, int height, @NotNull @NotNull Color color, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a rectangle ("fill").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  color - Shape Color
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawRect
  
  @NotNull public static @NotNull Instruction drawRect(int x, int y, int width, int height, @NotNull @NotNull Color color, int alpha, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a rectangle ("fill").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  color - Shape Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the alpha is not 0-255
- drawRect
  
  @NotNull public static @NotNull Instruction drawRect(int x, int y, int width, int height, @NotNull @NotNull Color color, int alpha, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a rectangle ("fill").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  color - Shape Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the alpha is not 0-255
- drawGradientRect
  
  @NotNull public static @NotNull Instruction drawGradientRect(int x, int y, int width, int height, @NotNull @NotNull Color from, @NotNull @NotNull Color to, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  from - Gradient Start Color
  
  to - Gradient End Color
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the colors are null
- drawGradientRect
  
  @NotNull public static @NotNull Instruction drawGradientRect(int x, int y, int width, int height, @NotNull @NotNull Color from, @NotNull @NotNull Color to, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  from - Gradient Start Color
  
  to - Gradient End Color
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the colors are null
- drawGradientRect
  
  @NotNull public static @NotNull Instruction drawGradientRect(int x, int y, int width, int height, @NotNull @NotNull Color from, int fromAlpha, @NotNull @NotNull Color to, int toAlpha, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  from - Gradient Start Color
  
  fromAlpha - Gradient Start Alpha (0-255 / 0x00 - 0xFF).
  
  to - Gradient End Color
  
  toAlpha - Gradient End Alpha (0-255 / 0x00 - 0xFF).
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the colors are null, or the alphas are not 0-255
- drawGradientRect
  
  @NotNull public static @NotNull Instruction drawGradientRect(int x, int y, int width, int height, @NotNull @NotNull Color from, int fromAlpha, @NotNull @NotNull Color to, int toAlpha, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  from - Gradient Start Color
  
  fromAlpha - Gradient Start Alpha (0-255 / 0x00 - 0xFF).
  
  to - Gradient End Color
  
  toAlpha - Gradient End Alpha (0-255 / 0x00 - 0xFF).
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the colors are null, or the alphas are not 0-255
- drawGradientRect
  
  @NotNull public static @NotNull Instruction drawGradientRect(int x, int y, int width, int height, @NotNull @NotNull Color from, int fromAlpha, @NotNull @NotNull Color to, int toAlpha, int z, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  from - Gradient Start Color
  
  fromAlpha - Gradient Start Alpha (0-255 / 0x00 - 0xFF).
  
  to - Gradient End Color
  
  toAlpha - Gradient End Alpha (0-255 / 0x00 - 0xFF).
  
  z - Shape Z-Index
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the colors are null, or the alphas are not 0-255
- drawGradientRect
  
  @NotNull public static @NotNull Instruction drawGradientRect(int x, int y, int width, int height, @NotNull @NotNull Color from, int fromAlpha, @NotNull @NotNull Color to, int toAlpha, int z, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a gradient rectangle ("gradient").
  
  Parameters:
  
  x - X Coordinate for Shape
  
  y - Y Coordinate for Shape
  
  width - Width of Shape
  
  height - Height of Shape
  
  from - Gradient Start Color
  
  fromAlpha - Gradient Start Alpha (0-255 / 0x00 - 0xFF).
  
  to - Gradient End Color
  
  toAlpha - Gradient End Alpha (0-255 / 0x00 - 0xFF).
  
  z - Shape Z-Index
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the colors are null, or the alphas are not 0-255
- drawVerticalLine
  
  @NotNull public static @NotNull Instruction drawVerticalLine(int x, int y, int height, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a vertical line ("line_v"). The line is 1 pixel wide.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  height - Height of Line
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or dimensions are negative
- drawVerticalLine
  
  @NotNull public static @NotNull Instruction drawVerticalLine(int x, int y, int height, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a vertical line ("line_v"). The line is 1 pixel wide.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  height - Height of Line
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative
- drawVerticalLine
  
  @NotNull public static @NotNull Instruction drawVerticalLine(int x, int y, int height, @NotNull @NotNull Color color, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a vertical line ("line_v"). The line is 1 pixel wide.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  height - Height of Line
  
  color - Line Color
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawVerticalLine
  
  @NotNull public static @NotNull Instruction drawVerticalLine(int x, int y, int height, @NotNull @NotNull Color color, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a vertical line ("line_v"). The line is 1 pixel wide.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  height - Height of Line
  
  color - Line Color
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawVerticalLine
  
  @NotNull public static @NotNull Instruction drawVerticalLine(int x, int y, int height, @NotNull @NotNull Color color, int alpha, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a vertical line ("line_v"). The line is 1 pixel wide.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  height - Height of Line
  
  color - Line Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the alpha is not 0-255
- drawVerticalLine
  
  @NotNull public static @NotNull Instruction drawVerticalLine(int x, int y, int height, @NotNull @NotNull Color color, int alpha, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a vertical line ("line_v"). The line is 1 pixel wide.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  height - Height of Line
  
  color - Line Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the alpha is not 0-255
- drawHorizontalLine
  
  @NotNull public static @NotNull Instruction drawHorizontalLine(int x, int y, int width, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a horizontal line ("line_h"). The line is 1 pixel long.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  width - Width of Line
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or dimensions are negative
- drawHorizontalLine
  
  @NotNull public static @NotNull Instruction drawHorizontalLine(int x, int y, int width, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a horizontal line ("line_h"). The line is 1 pixel long.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  width - Width of Line
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates or dimensions are negative
- drawHorizontalLine
  
  @NotNull public static @NotNull Instruction drawHorizontalLine(int x, int y, int width, @NotNull @NotNull Color color, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a horizontal line ("line_h"). The line is 1 pixel long.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  width - Width of Line
  
  color - Line Color
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawHorizontalLine
  
  @NotNull public static @NotNull Instruction drawHorizontalLine(int x, int y, int width, @NotNull @NotNull Color color, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a horizontal line ("line_h"). The line is 1 pixel long.
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  width - Width of Line
  
  color - Line Color
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawHorizontalLine
  
  @NotNull public static @NotNull Instruction drawHorizontalLine(int x, int y, int width, @NotNull @NotNull Color color, int alpha, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  width - Width of Line
  
  color - Line Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the alpha is not 0-255
- drawHorizontalLine
  
  @NotNull public static @NotNull Instruction drawHorizontalLine(int x, int y, int width, @NotNull @NotNull Color color, int alpha, long millis) throws IllegalArgumentException
  
  Creates a DRAW_SHAPE instruction for a horizontal line ("line_h").
  
  Parameters:
  
  x - X Coordinate for Line
  
  y - Y Coordinate for Line
  
  width - Width of Line
  
  color - Line Color
  
  alpha - Color Alpha (0-255 / 0x00 - 0xFF).
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the alpha is not 0-255
- drawBuffer
  
  @NotNull public static @NotNull Instruction drawBuffer(@NotNull @NotNull RenderBuffer buffer, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_BUFFER instruction.
  
  Parameters:
  
  buffer - Render Buffer
  
  duration - Time Duration
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the buffer is null, or the duration is negative
- drawBuffer
  
  @NotNull public static @NotNull Instruction drawBuffer(@NotNull @NotNull RenderBuffer buffer, long millis) throws IllegalArgumentException
  
  Creates a DRAW_BUFFER instruction.
  
  Parameters:
  
  buffer - Render Buffer
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Shape Instruction
  
  Throws:
  
  IllegalArgumentException - If the buffer is null, or the duration is negative
- playAudio
  
  @NotNull public static @NotNull Instruction playAudio(@NotNull @NotNull File file)
  
  Creates a PLAY_AUDIO instruction.
  
  Parameters:
  
  file - Path to Audio File
  
  Returns:
  
  Play Audio Instruction
- playAudio
  
  @NotNull public static @NotNull Instruction playAudio(@NotNull @NotNull InputStream file) throws IllegalArgumentException, IllegalStateException
  
  Creates a PLAY_AUDIO instruction.
  
  Parameters:
  
  file - Input Stream to Audio File
  
  Returns:
  
  Play Audio Instruction
  
  Throws:
  
  IllegalArgumentException - If the file is null
  
  IllegalStateException - If the file cannot be read
- logMessage
  
  @NotNull public static @NotNull Instruction logMessage(@NotNull @NotNull String message) throws IllegalArgumentException
  
  Creates a LOG_MESSAGE instruction.
  
  Parameters:
  
  message - Message to Log
  
  Returns:
  
  Log Message Instruction
  
  Throws:
  
  IllegalArgumentException - If the message is null or empty
- drawTexture
  
  @NotNull public static @NotNull Instruction drawTexture(int x, int y, int width, int height, @NotNull @NotNull Identifier texture, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXTURE instruction.
  
  Parameters:
  
  x - X Coordinate for Texture
  
  y - Y Coordinate for Texture
  
  width - Width of Texture
  
  height - Height of Texture
  
  texture - Texture Identifier
  
  duration - Time Duration
  
  Returns:
  
  Draw Texture Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the texture is null
- drawTexture
  
  @NotNull public static @NotNull Instruction drawTexture(int x, int y, int width, int height, @NotNull @NotNull Identifier texture, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXTURE instruction.
  
  Parameters:
  
  x - X Coordinate for Texture
  
  y - Y Coordinate for Texture
  
  width - Width of Texture
  
  height - Height of Texture
  
  texture - Texture Identifier
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Texture Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the texture is null
- drawTexture
  
  @NotNull public static @NotNull Instruction drawTexture(int x, int y, int width, int height, @NotNull @NotNull Identifier texture, int startLeft, int startTop, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXTURE instruction.
  
  Parameters:
  
  x - X Coordinate for Texture
  
  y - Y Coordinate for Texture
  
  width - Width of Texture
  
  height - Height of Texture
  
  texture - Texture Identifier
  
  startLeft - The horizontal offset to start drawing from the left of the texture
  
  startTop - The vertical offset to start drawing from the top of the texture
  
  duration - Time Duration
  
  Returns:
  
  Draw Texture Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the texture is null
- drawTexture
  
  @NotNull public static @NotNull Instruction drawTexture(int x, int y, int width, int height, @NotNull @NotNull Identifier texture, int startLeft, int startTop, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXTURE instruction.
  
  Parameters:
  
  x - X Coordinate for Texture
  
  y - Y Coordinate for Texture
  
  width - Width of Texture
  
  height - Height of Texture
  
  texture - Texture Identifier
  
  startLeft - The horizontal offset to start drawing from the left of the texture
  
  startTop - The vertical offset to start drawing from the top of the texture
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Texture Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the texture is null
- drawTexture
  
  @NotNull public static @NotNull Instruction drawTexture(int x, int y, int width, int height, @NotNull @NotNull Identifier texture, int startLeft, int startTop, int regionWidth, int regionHeight, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_TEXTURE instruction.
  
  Parameters:
  
  x - X Coordinate for Texture
  
  y - Y Coordinate for Texture
  
  width - Width of Texture
  
  height - Height of Texture
  
  texture - Texture Identifier
  
  startLeft - The horizontal offset to start drawing from the left of the texture
  
  startTop - The vertical offset to start drawing from the top of the texture
  
  regionWidth - Width of Region to Draw
  
  regionHeight - Height of Region to Draw
  
  duration - Time Duration
  
  Returns:
  
  Draw Texture Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the texture is null
- drawTexture
  
  @NotNull public static @NotNull Instruction drawTexture(int x, int y, int width, int height, @NotNull @NotNull Identifier texture, int startLeft, int startTop, int regionWidth, int regionHeight, long millis) throws IllegalArgumentException
  
  Creates a DRAW_TEXTURE instruction.
  
  Parameters:
  
  x - X Coordinate for Texture
  
  y - Y Coordinate for Texture
  
  width - Width of Texture
  
  height - Height of Texture
  
  texture - Texture Identifier
  
  startLeft - The horizontal offset to start drawing from the left of the texture
  
  startTop - The vertical offset to start drawing from the top of the texture
  
  regionWidth - Width of Region to Draw
  
  regionHeight - Height of Region to Draw
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Texture Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the texture is null
- openBookAndQuill
  
  @NotNull public static @NotNull Instruction openBookAndQuill()
  
  Creates a OPEN_BOOK_AND_QUILL instruction.
  
  Returns:
  
  Open Book and Quill Instruction
- openScreen
  
  @NotNull public static @NotNull Instruction openScreen(@NotNull @NotNull AbstractScreen screen)
  
  Creates a OPEN_SCREEN instruction.
  
  Parameters:
  
  screen - Screen to Open
  
  Returns:
  
  Open Screen Instruction
- closeScreen
  
  @NotNull public static @NotNull Instruction closeScreen()
  
  Creates a CLOSE_SCREEN instruction.
  
  Returns:
  
  Close Screen Instruction
- renderer
  
  @NotNull public static @NotNull Instruction renderer(@NotNull @NotNull RenderInstruction instruction) throws IllegalArgumentException
  
  Creates a RENDERER instruction.
  
  Parameters:
  
  instruction - Render Instruction to use
  
  Returns:
  
  Renderer Instruction
  
  Throws:
  
  IllegalArgumentException - If the render instruction is null, or sub-ordinal is -1
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  duration - Time Duration
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, long millis) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Color color, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  color - Beam Color (default: 0xF9FFFE)
  
  duration - Time Duration
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Color color, long millis) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  color - Beam Color (default: 0xF9FFFE)
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Color color, int yOffset, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  color - Beam Color (default: 0xF9FFFE)
  
  yOffset - Y Offset for Beam
  
  duration - Time Duration
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Color color, int yOffset, long millis) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  color - Beam Color (default: 0xF9FFFE)
  
  yOffset - Y Offset for Beam
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, or the color is null
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Color color, int yOffset, float beamRadius, float glowRadius, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  color - Beam Color (default: 0xF9FFFE)
  
  yOffset - Y Offset for Beam
  
  beamRadius - Beam Radius (default: 0.2F)
  
  glowRadius - Glow Radius (default: 0.25F)
  
  duration - Time Duration
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the radii are negative
- drawBeaconBeam
  
  @NotNull public static @NotNull Instruction drawBeaconBeam(int x, int y, int z, int height, @NotNull @NotNull Color color, int yOffset, float beamRadius, float glowRadius, long millis) throws IllegalArgumentException
  
  Creates a DRAW_BEACON_BEAM instruction.
  
  Parameters:
  
  x - X Coordinate for Beam
  
  y - Y Coordinate for Beam
  
  z - Z Coordinate for Beam
  
  height - Height of Beam
  
  color - Beam Color
  
  yOffset - Y Offset for Beam
  
  beamRadius - Beam Radius
  
  glowRadius - Glow Radius
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Beacon Beam Instruction
  
  Throws:
  
  IllegalArgumentException - If the coordinates, dimensions, or duration are negative, the color is null, or the radii are negative
- openLink
  
  @NotNull public static @NotNull Instruction openLink(@NotNull @NotNull URI uri) throws IllegalArgumentException
  
  Creates a OPEN_LINK instruction.
  
  Parameters:
  
  uri - URI to Open
  
  Returns:
  
  Open Link Instruction
  
  Throws:
  
  IllegalArgumentException - If the URL is null
- mailto
  
  @NotNull public static @NotNull Instruction mailto(@NotNull @NotNull String email) throws IllegalArgumentException
  
  Creates a MAILTO instruction.
  Parameters:
  
  email - Email Address
  
  Returns:
  
  Mailto Instruction
  
  Throws:
  
  IllegalArgumentException - If the email is null, or not a valid email address
  
  See Also:
  
  InstructionUtil.isEmailAddress(String)
- mailto
  
  @NotNull public static @NotNull Instruction mailto(@NotNull @NotNull URI mailto) throws IllegalArgumentException
  
  Creates a MAILTO instruction.
  
  Parameters:
  
  mailto - Mailto URI
  
  Returns:
  
  Mailto Instruction
  
  Throws:
  
  IllegalArgumentException - If the URI is null or not a mailto: URI
- drawContext
  
  @NotNull public static @NotNull Instruction drawContext(@NotNull @NotNull DrawingContext context, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_CONTEXT instruction.
  
  Parameters:
  
  context - Drawing Context to Display
  
  duration - Time Duration
  
  Returns:
  
  Draw Context Instruction
  
  Throws:
  
  IllegalArgumentException - If the context is null, or the duration is negative
- drawContext
  
  @NotNull public static @NotNull Instruction drawContext(@NotNull @NotNull DrawingContext context, long millis) throws IllegalArgumentException
  
  Creates a DRAW_CONTEXT instruction.
  
  Parameters:
  
  context - Drawing Context to Display
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw Context Instruction
  
  Throws:
  
  IllegalArgumentException - If the context is null, or the duration is negative
- narrate
  
  @NotNull public static @NotNull Instruction narrate(@NotNull @NotNull String text) throws IllegalArgumentException
  
  Creates a NARRATE instruction.
  
  Parameters:
  
  text - Text to Narrate
  
  Returns:
  
  Narrate Instruction
  
  Throws:
  
  IllegalArgumentException - If the text is null
- narrate
  
  @NotNull public static @NotNull Instruction narrate(@NotNull @NotNull String text, boolean interrupt) throws IllegalArgumentException
  
  Creates a NARRATE instruction.
  
  Parameters:
  
  text - Text to Narrate
  
  interrupt - Whether to interrupt any current speaking requests
  
  Returns:
  
  Narrate Instruction
  
  Throws:
  
  IllegalArgumentException - If the text is null
- displayToast
  
  @NotNull public static @NotNull Instruction displayToast(@NotNull @NotNull Toast toast) throws IllegalArgumentException
  
  Creates a DISPLAY_TOAST instruction.
  
  Parameters:
  
  toast - Toast to Display
  
  Returns:
  
  Display Toast Instruction
  
  Throws:
  
  IllegalArgumentException - If the toast is null
- osBeep
  
  @NotNull public static @NotNull Instruction osBeep()
  
  Creates a OS_BEEP instruction.
  
  Returns:
  
  OS Beep Instruction
- externalWindowPopup
  
  @NotNull public static @NotNull Instruction externalWindowPopup(@NotNull @NotNull String title, @NotNull @NotNull String message) throws IllegalArgumentException
  
  Creates a EXTERNAL_WINDOW_POPUP instruction.
  
  Parameters:
  
  title - Window Title
  
  message - Window Message
  
  Returns:
  
  External Window Popup Instruction
  
  Throws:
  
  IllegalArgumentException - If the title or message is null or empty
- externalWindowPopup
  
  @NotNull public static @NotNull Instruction externalWindowPopup(@NotNull @NotNull String title, @NotNull @NotNull String message, @NotNull @NotNull WindowIcon icon) throws IllegalArgumentException, UnsupportedOperationException
  
  Creates a EXTERNAL_WINDOW_POPUP instruction.
  
  Parameters:
  
  title - Window Title
  
  message - Window Message
  
  icon - Window Icon
  
  Returns:
  
  External Window Popup Instruction
  
  Throws:
  
  IllegalArgumentException - If the title or message is null or empty, or the icon is null
  
  UnsupportedOperationException - If the icon is WindowIcon.QUESTION
- externalWindowMessageBox
  
  @NotNull public static @NotNull Instruction externalWindowMessageBox(@NotNull @NotNull String title, @NotNull @NotNull String message) throws IllegalArgumentException
  
  Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction with WindowDialogue.OK.
  
  Parameters:
  
  title - Window Title
  
  message - Window Message
  
  Returns:
  
  External Window Message Box Instruction
  
  Throws:
  
  IllegalArgumentException - If the title or message is null or empty
- externalWindowMessageBox
  
  @NotNull public static @NotNull Instruction externalWindowMessageBox(@NotNull @NotNull String title, @NotNull @NotNull String message, @NotNull @NotNull WindowDialogue dialogue) throws IllegalArgumentException
  
  Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction.
  
  Parameters:
  
  title - Window Title
  
  message - Window Message
  
  dialogue - Window Dialogue
  
  Returns:
  
  External Window Message Box Instruction
  
  Throws:
  
  IllegalArgumentException - If the title or message is null or empty, or the dialogue is null
- externalWindowMessageBox
  
  @NotNull public static @NotNull Instruction externalWindowMessageBox(@NotNull @NotNull String title, @NotNull @NotNull String message, @NotNull @NotNull WindowDialogue dialogue, @NotNull @NotNull WindowIcon icon) throws IllegalArgumentException
  
  Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction.
  
  Parameters:
  
  title - Window Title
  
  message - Window Message
  
  dialogue - Window Dialogue
  
  icon - Window Icon
  
  Returns:
  
  External Window Message Box Instruction
  
  Throws:
  
  IllegalArgumentException - If the title or message is null or empty, the dialogue is null, or the icon is null
- externalWindowMessageBox
  
  @NotNull public static @NotNull Instruction externalWindowMessageBox(@NotNull @NotNull String title, @NotNull @NotNull String message, @NotNull @NotNull WindowDialogue dialogue, @NotNull @NotNull WindowIcon icon, boolean cancelDefault) throws IllegalArgumentException
  
  Creates a EXTERNAL_WINDOW_MESSAGE_BOX instruction.
  
  Parameters:
  
  title - Window Title
  
  message - Window Message
  
  dialogue - Window Dialogue
  
  icon - Window Icon
  
  cancelDefault - Whether the cancel button is the default
  
  Returns:
  
  External Window Message Box Instruction
  
  Throws:
  
  IllegalArgumentException - If the title or message is null or empty, the dialogue is null, or the icon is null
- setWindowTitle
  
  @NotNull public static @NotNull Instruction setWindowTitle(@NotNull @NotNull String title) throws IllegalArgumentException
  
  Creates a SET_WINDOW_TITLE instruction.
  
  Parameters:
  
  title - Window Title
  
  Returns:
  
  Set Window Title Instruction
  
  Throws:
  
  IllegalArgumentException - If the title is null or empty
- setOverlay
  
  @NotNull public static @NotNull Instruction setOverlay(@Nullable @Nullable Overlay overlay)
  
  Creates a SET_OVERLAY instruction.
  
  Parameters:
  
  overlay - Overlay to Set, or null to clear the overlay
  
  Returns:
  
  Set Overlay Instruction
- drawItemStack
  
  @NotNull public static @NotNull Instruction drawItemStack(@NotNull @NotNull NBTTag item, int x, int y, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_ITEMSTACK instruction.
  
  Parameters:
  
  item - Item to Draw
  
  x - X Coordinate for Item
  
  y - Y Coordinate for Item
  
  duration - Time Duration
  
  Returns:
  
  Draw ItemStack Instruction
  
  Throws:
  
  IllegalArgumentException - If the item is null, or the coordinates are negative
- drawItemStack
  
  @NotNull public static @NotNull Instruction drawItemStack(@NotNull @NotNull NBTTag item, int x, int y, long millis) throws IllegalArgumentException
  
  Creates a DRAW_ITEMSTACK instruction.
  
  Parameters:
  
  item - Item to Draw
  
  x - X Coordinate for Item
  
  y - Y Coordinate for Item
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw ItemStack Instruction
  
  Throws:
  
  IllegalArgumentException - If the item is null, or the coordinates are negative
- drawItemStack
  
  @NotNull public static @NotNull Instruction drawItemStack(@NotNull @NotNull NBTTag item, int x, int y, int guiOffset, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_ITEMSTACK instruction.
  
  Parameters:
  
  item - Item to Draw
  
  x - X Coordinate for Item
  
  y - Y Coordinate for Item
  
  guiOffset - GUI Offset on the z-axis for its 3D model
  
  duration - Time Duration
  
  Returns:
  
  Draw ItemStack Instruction
  
  Throws:
  
  IllegalArgumentException - If the item is null, or the coordinates are negative
- drawItemStack
  
  @NotNull public static @NotNull Instruction drawItemStack(@NotNull @NotNull NBTTag item, int x, int y, int guiOffset, long millis) throws IllegalArgumentException
  
  Creates a DRAW_ITEMSTACK instruction.
  
  Parameters:
  
  item - Item to Draw
  
  x - X Coordinate for Item
  
  y - Y Coordinate for Item
  
  guiOffset - GUI Offset on the z-axis for its 3D model
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw ItemStack Instruction
  
  Throws:
  
  IllegalArgumentException - If the item is null, or the coordinates are negative
- drawItemStack
  
  @NotNull public static @NotNull Instruction drawItemStack(@NotNull @NotNull NBTTag item, int x, int y, int guiOffset, int randomSeed, @NotNull @NotNull Duration duration) throws IllegalArgumentException
  
  Creates a DRAW_ITEMSTACK instruction.
  
  Parameters:
  
  item - Item to Draw
  
  x - X Coordinate for Item
  
  y - Y Coordinate for Item
  
  guiOffset - GUI Offset on the z-axis for its 3D model
  
  randomSeed - Seed for Randomness in Rendering
  
  duration - Time Duration
  
  Returns:
  
  Draw ItemStack Instruction
  
  Throws:
  
  IllegalArgumentException - If the item is null, or the coordinates are negative
- drawItemStack
  
  @NotNull public static @NotNull Instruction drawItemStack(@NotNull @NotNull NBTTag item, int x, int y, int guiOffset, int randomSeed, long millis) throws IllegalArgumentException
  
  Creates a DRAW_ITEMSTACK instruction.
  
  Parameters:
  
  item - Item to Draw
  
  x - X Coordinate for Item
  
  y - Y Coordinate for Item
  
  guiOffset - GUI Offset on the z-axis for its 3D model
  
  randomSeed - Seed for Randomness in Rendering
  
  millis - Duration to display, in milliseconds
  
  Returns:
  
  Draw ItemStack Instruction
  
  Throws:
  
  IllegalArgumentException - If the item is null, or the coordinates are negative
- setWindowIcon
  
  @NotNull public static @NotNull Instruction setWindowIcon(byte[] icon)
  Creates a SET_WINDOW_ICON instruction.
  
  On Windows/Linux, a .png file must be loaded. The recommended size is 16x16.
  
  On macOS, a .icns file must be loaded.
  
  The library will not make an effort to validate the byte array.
  Parameters:
  
  icon - Icon to Set
  
  Returns:
  
  Set Window Icon Instruction
- showPlayers
  
  @NotNull public static @NotNull Instruction showPlayers(@NotNull @NotNull Iterable<UUID> players)
  
  Creates a SHOW_PLAYERS instruction.
  
  Parameters:
  
  players - Players to Show
  
  Returns:
  
  Show Players Instruction
- showPlayers
  
  @NotNull public static @NotNull Instruction showPlayers(@NotNull @NotNull UUID... players)
  
  Creates a SHOW_PLAYERS instruction.
  
  Parameters:
  
  players - Players to Show
  
  Returns:
  
  Show Players Instruction
- hidePlayers
  
  @NotNull public static @NotNull Instruction hidePlayers(@NotNull @NotNull Iterable<UUID> players)
  
  Creates a HIDE_PLAYERS instruction.
  
  Parameters:
  
  players - Players to Hide
  
  Returns:
  
  Hide Players Instruction
- hidePlayers
  
  @NotNull public static @NotNull Instruction hidePlayers(@NotNull @NotNull UUID... players)
  
  Creates a HIDE_PLAYERS instruction.
  
  Parameters:
  
  players - Players to Hide
  
  Returns:
  
  Hide Players Instruction
- toByteArray
  
  public byte[] toByteArray()
  
  Serializes this Instruction to a byte array to be passed over the network.
  
  Returns:
  
  Byte Array Representation
- fromByteArray
  
  @Nullable public static @Nullable Instruction fromByteArray(byte[] instruction)
  
  Deserializes an Instruction from a byte array received over the network.
  
  Parameters:
  
  instruction - Byte Array Representation
  
  Returns:
  
  Deserialized Instruction

Class Instruction

Notes

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

PING

DRAW_TEXT

DRAW_SHAPE

PLAY_AUDIO

DRAW_BUFFER

LOG_MESSAGE

DRAW_TEXTURE

OPEN_BOOK_AND_QUILL

OPEN_SCREEN

CLOSE_SCREEN

RENDERER

DRAW_BEACON_BEAM

OPEN_LINK

MAILTO

DRAW_CONTEXT

NARRATE

DISPLAY_TOAST

OS_BEEP

EXTERNAL_WINDOW_POPUP

EXTERNAL_WINDOW_MESSAGE_BOX

SET_WINDOW_TITLE

SET_OVERLAY

DRAW_ITEMSTACK

SET_WINDOW_ICON

SHOW_PLAYERS

HIDE_PLAYERS

Method Details

getId

getParameters

getPermission

equals

hashCode

toString

ids

getPermission

ping

drawText

drawText

drawText

drawText

drawText

drawText

drawText

drawText

drawText

drawText

drawText

drawText

drawRect

drawRect

drawRect

drawRect

drawRect

drawRect

drawGradientRect

drawGradientRect

drawGradientRect

drawGradientRect

drawGradientRect

drawGradientRect

drawVerticalLine

drawVerticalLine

drawVerticalLine

drawVerticalLine

drawVerticalLine

drawVerticalLine

drawHorizontalLine

drawHorizontalLine

drawHorizontalLine

drawHorizontalLine

drawHorizontalLine

drawHorizontalLine

drawBuffer