Class ContainerSlotBeta

Betaamount

Readonly BetaisStackable

Readonly BetaisValid

BetakeepOnDeath

BetalockMode

Readonly BetamaxAmount

Optional BetanameTag

Readonly Betatype

Readonly BetatypeId

clearDynamicProperties

• clearDynamicProperties(): void
  Beta

  Returns void

  Remarks

  Clears all dynamic properties that have been set on this item stack.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

getCanDestroy

• getCanDestroy(): string[]
  Beta

  Returns string[]

  Remarks

  Returns whether the item within this container slot can be destroyed.

  Throws

  This function can throw errors.

  InvalidContainerSlotError

getCanPlaceOn

• getCanPlaceOn(): string[]
  Beta

  Returns string[]

  Remarks

  Returns if the item in this container slot can be placed on.

  Throws

  This function can throw errors.

  InvalidContainerSlotError

getDynamicProperty

• getDynamicProperty(identifier: string): string | number | boolean | Vector3
  Beta

  Parameters

  • identifier: string

    The property identifier.

  Returns string | number | boolean | Vector3

  Returns the value for the property, or undefined if the property has not been set.

  Remarks

  Returns a property value.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

getDynamicPropertyIds

• getDynamicPropertyIds(): string[]
  Beta

  Returns string[]

  A string array of the dynamic properties set on this entity.

  Remarks

  Returns the available set of dynamic property identifiers that have been used on this item stack.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

getDynamicPropertyTotalByteCount

• getDynamicPropertyTotalByteCount(): number
  Beta

  Returns number

  Remarks

  Returns the total size, in bytes, of all the dynamic properties that are currently stored for this entity. This includes the size of both the key and the value. This can be useful for diagnosing performance warning signs - if, for example, an entity has many megabytes of associated dynamic properties, it may be slow to load on various devices.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

getItem

• getItem(): ItemStack
  Beta

  Returns ItemStack

  Returns a copy of the item in the slot. Returns undefined if the slot is empty.

  Remarks

  Creates an exact copy of the item stack, including any custom data or properties.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

getLore

• getLore(): string[]
  Beta

  Returns string[]

  An array of lore strings. If the item does not have lore, returns an empty array.

  Remarks

  Returns the lore value - a secondary display string - for an ItemStack.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

getTags

• getTags(): string[]
  Beta

  Returns string[]

  Returns all tags for the item in the slot. Return an empty array if the the slot is empty.

  Remarks

  Returns all tags for the item in the slot.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

hasItem

• hasItem(): boolean
  Beta

  Returns boolean

  Remarks

  Returns true if this slot has an item.

  Throws

  This function can throw errors.

  InvalidContainerSlotError

hasTag

• hasTag(tag: string): boolean
  Beta

  Parameters

  • tag: string

    The item tag.

  Returns boolean

  Returns false when the slot is empty or the item in the slot does not have the given tag.

  Remarks

  Returns whether the item in the slot slot has the given tag.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

isStackableWith

• isStackableWith(itemStack: ItemStack): boolean
  Beta

  Parameters

  • itemStack: ItemStack

    The ItemStack that is being compared.

  Returns boolean

  Returns whether this item stack can be stacked with the given itemStack.

  Remarks

  Returns whether this item stack can be stacked with the given itemStack. This is determined by comparing the item type and any custom data and properties associated with the item stacks. The amount of each item stack is not taken into consideration.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

setCanDestroy

• setCanDestroy(blockIdentifiers?: string[]): void
  Beta

  Parameters

  • OptionalblockIdentifiers: string[]

    The list of blocks, given by their identifiers.

  Returns void

  Remarks

  The list of block types this item can break in Adventure mode. The block names are displayed in the item's tooltip. Setting the value to undefined will clear the list.

  This function can't be called in read-only mode.

  Throws

  Throws if the slot's container is invalid. Also throws if any of the provided block identifiers are invalid.

  Error

  InvalidContainerSlotError

setCanPlaceOn

• setCanPlaceOn(blockIdentifiers?: string[]): void
  Beta

  Parameters

  • OptionalblockIdentifiers: string[]

    The list of blocks, given by their identifiers.

  Returns void

  Remarks

  The list of block types this item can be placed on in Adventure mode. This is only applicable to block items. The block names are displayed in the item's tooltip. Setting the value to undefined will clear the list.

  This function can't be called in read-only mode.

  Throws

  Throws if the slot's container is invalid. Also throws if any of the provided block identifiers are invalid.

  Error

  InvalidContainerSlotError

setDynamicProperties

• setDynamicProperties(
      values: Record<string, string | number | boolean | Vector3>,
  ): void
  Beta

  Parameters

  • values: Record<string, string | number | boolean | Vector3>

    A Record of key value pairs of the dynamic properties to set.

  Returns void

  Remarks

  Sets multiple dynamic properties with specific values.

  Throws

  This function can throw errors.

  Error

  InvalidContainerSlotError

setDynamicProperty

• setDynamicProperty(
      identifier: string,
      value?: string | number | boolean | Vector3,
  ): void
  Beta

  Parameters

  • identifier: string

    The property identifier.
  • Optionalvalue: string | number | boolean | Vector3

    Data value of the property to set.

  Returns void

  Remarks

  Sets a specified property to a value.

  Throws

  Throws if the slot's container is invalid.

  Error

  InvalidContainerSlotError

setItem

• setItem(itemStack?: ItemStack): void
  Beta

  Parameters

  • OptionalitemStack: ItemStack

    The ItemStack to be placed in the slot.

  Returns void

  Remarks

  Sets the given ItemStack in the slot, replacing any existing item.

  This function can't be called in read-only mode.

  Throws

  Throws if the slot's container is invalid.

  InvalidContainerSlotError

setLore

• setLore(loreList?: string[]): void
  Beta

  Parameters

  • OptionalloreList: string[]

    A list of lore strings. Setting this argument to undefined will clear the lore.

  Returns void

  Remarks

  Sets the lore value - a secondary display string - for an ItemStack.

  This function can't be called in read-only mode.

  Throws

  Throws if the slot's container is invalid.

  Error

  InvalidContainerSlotError