SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias RankInventoryItemsRequest

    RankInventoryItemsRequest: Message<"soulfire.v1.RankInventoryItemsRequest"> & {
        areas: InventoryArea[];
        equipmentSlot?: string;
        excludedEnchantmentIds: string[];
        kind: InventoryRecommendationKind;
        limit: number;
        preferHighDurability: boolean;
        preferHotbar: boolean;
        preferredEnchantmentIds: string[];
        scope?: InventoryScope;
        selector?: ItemSelector;
        targetBlock?: BlockPosition;
    }

    Type Declaration

    • areas: InventoryArea[]

      from field: repeated soulfire.v1.InventoryArea areas = 4;

    • OptionalequipmentSlot?: string

      Required when kind is ARMOR, such as "head", "chest", "legs", or "feet".

      from field: optional string equipment_slot = 6;

    • excludedEnchantmentIds: string[]

      Removes candidates carrying any listed enchantment.

      from field: repeated string excluded_enchantment_ids = 10;

    • kind: InventoryRecommendationKind

      from field: soulfire.v1.InventoryRecommendationKind kind = 2;

    • limit: number

      Defaults to 10 and may not exceed 100.

      from field: uint32 limit = 7;

    • preferHighDurability: boolean

      Prefers a higher remaining durability ratio for damageable items.

      from field: bool prefer_high_durability = 11;

    • preferHotbar: boolean

      Adds a small preference for already selectable hotbar items.

      from field: bool prefer_hotbar = 8;

    • preferredEnchantmentIds: string[]

      Adds a score bonus for each matching enchantment.

      from field: repeated string preferred_enchantment_ids = 9;

    • Optionalscope?: InventoryScope

      from field: soulfire.v1.InventoryScope scope = 1;

    • Optionalselector?: ItemSelector

      from field: optional soulfire.v1.ItemSelector selector = 3;

    • OptionaltargetBlock?: BlockPosition

      Required when kind is TOOL.

      from field: optional soulfire.v1.BlockPosition target_block = 5;

    from message soulfire.v1.RankInventoryItemsRequest

    Settings
    Member Visibility