类 ContainerSlot

Represents a slot within a broader container (e.g., entity inventory.)

属性

amount isStackable isValid keepOnDeath lockMode maxAmount nameTag? type typeId

方法

clearDynamicProperties getCanDestroy getCanPlaceOn getDynamicProperty getDynamicPropertyIds getDynamicPropertyTotalByteCount getItem getLore getTags hasItem hasTag isStackableWith setCanDestroy setCanPlaceOn setDynamicProperties setDynamicProperty setItem setLore

属性

世界修改amount

amount: number

备注

Number of the items in the stack. Valid values range between 1-255. The provided value will be clamped to the item's maximum stack size.

抛出

Throws if the value is outside the range of 1-255.

只读isStackable

isStackable: boolean

备注

Returns whether the item is stackable. An item is considered stackable if the item's maximum stack size is greater than 1 and the item does not contain any custom data or properties.

抛出

Throws if the slot's container is invalid.

InvalidContainerSlotError

只读 betaisValid

isValid: boolean

备注

Returns whether the ContainerSlot is valid. The container slot is valid if the container exists and is loaded, and the slot index is valid.

世界修改keepOnDeath

keepOnDeath: boolean

备注

Gets or sets whether the item is kept on death.

抛出

Throws if the slot's container is invalid.

世界修改lockMode

lockMode: ItemLockMode

备注

Gets or sets the item's lock mode. The default value is ItemLockMode.none.

抛出

Throws if the slot's container is invalid.

只读maxAmount

maxAmount: number

备注

The maximum stack size. This value varies depending on the type of item. For example, torches have a maximum stack size of 64, while eggs have a maximum stack size of 16.

抛出

Throws if the slot's container is invalid.

InvalidContainerSlotError

可选 世界修改nameTag

nameTag?: string

备注

Given name of this stack of items. The name tag is displayed when hovering over the item. Setting the name tag to an empty string or undefined will remove the name tag.

抛出

Throws if the slot's container is invalid. Also throws if the length exceeds 255 characters.

只读type

type: ItemType

备注

The type of the item.

抛出

Throws if the slot's container is invalid.

minecraftcommon.EngineError

InvalidContainerSlotError

只读typeId

typeId: string

备注

Identifier of the type of items for the stack. If a namespace is not specified, 'minecraft:' is assumed. Examples include 'wheat' or 'apple'.

抛出

Throws if the slot's container is invalid.

InvalidContainerSlotError

方法

clearDynamicProperties

getCanDestroy

getCanPlaceOn

getDynamicProperty

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

    参数

    • identifier: string

      The property identifier.

    返回 string | number | boolean | Vector3

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

    备注

    Returns a property value.

    抛出

    Throws if the slot's container is invalid.

    InvalidContainerSlotError

getDynamicPropertyIds

  • getDynamicPropertyIds(): string[]

    返回 string[]

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

    备注

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

    抛出

    Throws if the slot's container is invalid.

    InvalidContainerSlotError

getDynamicPropertyTotalByteCount

  • getDynamicPropertyTotalByteCount(): number

    返回 number

    备注

    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 if the slot's container is invalid.

    InvalidContainerSlotError

getItem

getLore

  • getLore(): string[]

    返回 string[]

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

    备注

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

    抛出

    Throws if the slot's container is invalid.

    InvalidContainerSlotError

getTags

  • getTags(): string[]

    返回 string[]

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

    备注

    Returns all tags for the item in the slot.

    抛出

    Throws if the slot's container is invalid.

    InvalidContainerSlotError

hasItem

hasTag

  • hasTag(tag: string): boolean

    参数

    • tag: string

      The item tag.

    返回 boolean

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

    备注

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

    抛出

    Throws if the slot's container is invalid.

    InvalidContainerSlotError

isStackableWith

  • isStackableWith(itemStack: ItemStack): boolean

    参数

    • itemStack: ItemStack

      The ItemStack that is being compared.

    返回 boolean

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

    备注

    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 if the slot's container is invalid.

    InvalidContainerSlotError

setCanDestroy

  • setCanDestroy(blockIdentifiers?: string[]): void
    世界修改

    参数

    • 可选blockIdentifiers: string[]

      The list of blocks, given by their identifiers.

    返回 void

    备注

    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.

    抛出

    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
    世界修改

    参数

    • 可选blockIdentifiers: string[]

      The list of blocks, given by their identifiers.

    返回 void

    备注

    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.

    抛出

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

    Error

    InvalidContainerSlotError

setDynamicProperties

setDynamicProperty

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

    参数

    • identifier: string

      The property identifier.

    • 可选value: string | number | boolean | Vector3

      Data value of the property to set.

    返回 void

    备注

    Sets a specified property to a value.

    抛出

    Throws if the slot's container is invalid.

    Error

    InvalidContainerSlotError

setItem

setLore

  • setLore(loreList?: string[]): void
    世界修改

    参数

    • 可选loreList: string[]

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

    返回 void

    备注

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

    抛出

    Throws if the slot's container is invalid.

    Error

    InvalidContainerSlotError

显示设置

成员可见性

目录

属性
方法