SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    PluginMetric: Message<"soulfire.v1.PluginMetric"> & {
        displayName: string;
        icon?: string;
        key: string;
        unit: string;
        value: number;
    }

    A single named metric reported by a plugin (a counter or a gauge).

    Type Declaration

    • displayName: string

      Human-friendly label for display (e.g. "Diamonds mined").

      from field: string display_name = 2;

    • Optionalicon?: string

      Optional icon hint for the client (e.g. a Minecraft item id like "minecraft:diamond", or a lucide icon name). Absent if not provided.

      from field: optional string icon = 5;

    • key: string

      Stable machine key for the metric (e.g. "diamonds_mined").

      from field: string key = 1;

    • unit: string

      Optional unit shown next to the value (e.g. "blocks", "ms"). May be empty.

      from field: string unit = 4;

    • value: number

      Current value. Counters accumulate; gauges reflect the latest set value.

      from field: double value = 3;

    from message soulfire.v1.PluginMetric