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.

Minecraft 成就提示通知组件。 创建临时的成就提示通知，显示在玩家屏幕右上角。 使用动态成就创建和自动清理机制。

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 / 提示样式:

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) / 图标的 Minecraft 物品 ID（不含 "minecraft:" 前缀）
    private final org.bukkit.NamespacedKey
    key
    Unique key for this advancement, auto-generated UUID / 此成就的唯一键，自动生成 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 / 此成就的唯一键，自动生成 UUID

    • icon

      private final String icon
      The Minecraft item ID for the icon (without "minecraft:" prefix) / 图标的 Minecraft 物品 ID（不含 "minecraft:" 前缀）

    • 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

  • 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.

      向指定玩家显示提示通知。 提示将在 10 tick（0.5 秒）后自动撤销，以清理临时成就。

      Parameters:
      player - the target player / 目标玩家
      icon - the Minecraft item ID for the icon (e.g., "diamond", "emerald") 图标的 Minecraft 物品 ID（如 "diamond"、"emerald"）
      message - the toast message, use "|" for line breaks 提示消息，使用 "|" 换行
      style - the visual style of the toast / 提示的视觉样式