Package com.ultikits.ultitools.widgets

Class Toast

java.lang.Object

com.ultikits.ultitools.widgets.Toast

public class Toast
extends Object

A Minecraft advancement toast notification widget.

Creates temporary advancement toast notifications that appear in the top-right corner of the player's screen. Uses dynamic advancement creation and auto-cleanup.

Example Usage:

 // Display a goal-style toast
 Toast.displayTo(player, "diamond", "You found a diamond!", Toast.Style.GOAL);

 // Display a task-style toast
 Toast.displayTo(player, "emerald", "Trade completed!", Toast.Style.TASK);

 // Multi-line message using | separator
 Toast.displayTo(player, "gold_ingot", "Welcome!|Enjoy your stay!", Toast.Style.CHALLENGE);
 

Toast Styles:

• Toast.Style.GOAL - Green background, for completed goals
• Toast.Style.TASK - Yellow background, for tasks
• Toast.Style.CHALLENGE - Purple background, for challenges

Since:

6.0.0

Author:

wisdomme

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Toast.Style	Toast display styles based on Minecraft advancement frame types.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	icon	The Minecraft item ID for the icon (without "minecraft:" prefix)
private final org.bukkit.NamespacedKey	key	Unique key for this advancement, auto-generated UUID
private final String	message	The toast message, use "|" for line breaks
private final Toast.Style	style	The visual style of the toast

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Toast(String icon, String message, Toast.Style style)	Private constructor - use displayTo(Player, String, String, Style) instead.

Method Summary

Modifier and Type	Method	Description
private void	createAdvancement()
static void	displayTo(org.bukkit.entity.Player player, String icon, String message, Toast.Style style)	Displays a toast notification to the specified player.
private void	grantAdvancement(org.bukkit.entity.Player player)
private void	revokeAdvancement(org.bukkit.entity.Player player)
private void	start(org.bukkit.entity.Player player)

Methods inherited from class java.lang.Object

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

Field Details

key

private final org.bukkit.NamespacedKey key

Unique key for this advancement, auto-generated UUID

icon

private final String icon

The Minecraft item ID for the icon (without "minecraft:" prefix)

message

private final String message

The toast message, use "|" for line breaks

style

private final Toast.Style style

The visual style of the toast

Constructor Details

Toast

private Toast(String icon,
 String message,
 Toast.Style style)

Private constructor - use displayTo(Player, String, String, Style) instead.

Parameters:

icon - the Minecraft item ID for the icon

message - the toast message

style - the visual style

Method Details

start

private void start(org.bukkit.entity.Player player)

createAdvancement

private void createAdvancement()

grantAdvancement

private void grantAdvancement(org.bukkit.entity.Player player)

revokeAdvancement

private void revokeAdvancement(org.bukkit.entity.Player player)

displayTo

public static void displayTo(org.bukkit.entity.Player player,
 String icon,
 String message,
 Toast.Style style)

Displays a toast notification to the specified player.

The toast will automatically be revoked after 10 ticks (0.5 seconds) to clean up the temporary advancement.

Parameters:

player - the target player

icon - the Minecraft item ID for the icon (e.g., "diamond", "emerald")

message - the toast message, use "|" for line breaks

style - the visual style of the toast