Add-On Documentation
  • Preparing search index...
  • The search index is not available
8Crafter's Server Utilities API
  • 8Crafter's Server Utilities API
  • Globals
  • modules
  • cmdutils
  • getItemFromParsedSlot

Function getItemFromParsedSlot

  • getItemFromParsedSlot<
        Options extends
            {
                container?: Container;
                cursor?: PlayerCursorInventoryComponent;
                equipment?: EntityEquippableComponent;
                selectedSlotIndex?: number;
            },
    >(
        slot: number | EquipmentSlot | "~" | "cursor",
        options: Options,
    ):
        | undefined
        | (
            Options["cursor"] extends PlayerCursorInventoryComponent
                ? undefined
                | ItemStack
                : undefined
        )
        | (
            Options["container"] extends Container
                ? undefined
                | ItemStack
                : undefined
        )
        | (
            Options["equipment"] extends EntityEquippableComponent
                ? undefined
                | ItemStack
                : undefined
        )

    Type Parameters

    • Options extends {
          container?: Container;
          cursor?: PlayerCursorInventoryComponent;
          equipment?: EntityEquippableComponent;
          selectedSlotIndex?: number;
      }

    Parameters

    • slot: number | EquipmentSlot | "~" | "cursor"
    • options: Options

    Returns
        | undefined
        | (
            Options["cursor"] extends PlayerCursorInventoryComponent
                ? undefined
                | ItemStack
                : undefined
        )
        | (
            Options["container"] extends Container
                ? undefined
                | ItemStack
                : undefined
        )
        | (
            Options["equipment"] extends EntityEquippableComponent
                ? undefined
                | ItemStack
                : undefined
        )

    • Defined in modules/command_utilities/functions/getItemFromParsedSlot.ts:3

Settings

Member Visibility
Add-On Documentation
8Crafter's Server Utilities API
  • Loading...

Generated using TypeDoc