SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias DialogItem

    DialogItem: Message<"soulfire.v1.DialogItem"> & {
        count: number;
        description?: string;
        height: number;
        itemId: string;
        showDecoration: boolean;
        showTooltip: boolean;
        width: number;
    }

    Item display element in a dialog body.

    Type Declaration

    • count: number

      Item count/stack size to display.

      from field: int32 count = 2;

    • Optionaldescription?: string

      Optional description text below the item.

      from field: optional string description = 3;

    • height: number

      Display height in pixels. Range: 1-256, default: 16.

      from field: int32 height = 7;

    • itemId: string

      Minecraft item identifier. Example: "minecraft:diamond", "minecraft:netherite_sword"

      from field: string item_id = 1;

    • showDecoration: boolean

      Whether to show the item frame decoration around the item. Default: true.

      from field: bool show_decoration = 4;

    • showTooltip: boolean

      Whether to show the item tooltip on hover. Default: true.

      from field: bool show_tooltip = 5;

    • width: number

      Display width in pixels. Range: 1-256, default: 16.

      from field: int32 width = 6;

    from message soulfire.v1.DialogItem