Class CustomItemType

Hierarchy (View Summary)

ItemType
- CustomItemType

Constructors

constructor

new CustomItemType(
identifier: string,
options?: Partial<ItemTypeOptions>,
): CustomItemType
Create a new custom item type.
Parameters
- identifier: string
  The identifier of the item type.
- Optionaloptions: Partial<ItemTypeOptions>
  The options of the item type.
Returns CustomItemType
Overrides ItemType.constructor
- Defined in packages/core/src/item/identity/custom.ts:14

Properties

creativeCategory

creativeCategory: CreativeItemCategory

creativeGroup

creativeGroup: string

`Readonly`identifier

identifier: string

The identifier of the item type.

`Readonly`network

network: number

The network of the item type.

`Readonly`properties

properties: CompoundTag

The nbt properties definition of the item type. This contains the vanilla component definitions.

`Readonly`traits

traits: Map<string, typeof ItemStackTrait> = ...

The traits that are bound to the item type. These traits are used to define custom behavior for the item type.

`Static`AIR

AIR: ItemType

`Protected` `Static`networkId

networkId: number = 20000

`Static` `Readonly`types

types: Map<string, ItemType> = ...

A collective registry of all item types.

Accessors

components

get components(): ItemTypeComponentCollection
The vanilla components of the item type.

Returns ItemTypeComponentCollection
Inherited from ItemType.components
- Defined in packages/core/src/item/identity/type.ts:135

isStackable

get isStackable(): boolean
Whether the item type is stackable.

Returns boolean
Inherited from ItemType.isStackable
- Defined in packages/core/src/item/identity/type.ts:128

Methods

addTag

addTag(...tags: string[]): this
Add a tag to the item type.
Parameters
- ...tags: string[]
  The tags to add.
Returns this
The item type instance.
Inherited from ItemType.addTag
- Defined in packages/core/src/item/identity/type.ts:320

getIsComponentBased

getIsComponentBased(): boolean
Get whether the item type is component based.

Returns boolean
True if the item type is component based, false otherwise.
Inherited from ItemType.getIsComponentBased
- Defined in packages/core/src/item/identity/type.ts:210

getTags

getTags(): string[]
Get the tags of the item type.

Returns string[]
The tags of the item type.
Inherited from ItemType.getTags
- Defined in packages/core/src/item/identity/type.ts:279

getToolTier

getToolTier(): ItemTypeToolTier
Get the tier of the item type.

Returns ItemTypeToolTier
The tier of the item type.

Note
This method evaluates the item type tags to determine the tier.
Inherited from ItemType.getToolTier
- Defined in packages/core/src/item/identity/type.ts:436

getVersion

getVersion(): number
Get the version of the item type.

Returns number
The version of the item type.
Inherited from ItemType.getVersion
- Defined in packages/core/src/item/identity/type.ts:227

hasTag

hasTag(tag: string): boolean
Check if the item type has a tag.
Parameters
- tag: string
  The tag to check.
Returns boolean
True if the item type has the tag, false otherwise.
Inherited from ItemType.hasTag
- Defined in packages/core/src/item/identity/type.ts:381

isAxe

isAxe(): boolean
Whether the item type is a axe.

Returns boolean
True if the item type is a axe, false otherwise.

Note
This method evaluates if the item type contains the minecraft:is_axe tag.
Inherited from ItemType.isAxe
- Defined in packages/core/src/item/identity/type.ts:400

isHoe

isHoe(): boolean
Whether the item type is a hoe.

Returns boolean
True if the item type is a hoe, false otherwise.

Note
This method evaluates if the item type contains the minecraft:is_hoe tag.
Inherited from ItemType.isHoe
- Defined in packages/core/src/item/identity/type.ts:418

isPickaxe

isPickaxe(): boolean
Whether the item type is a pickaxe.

Returns boolean
True if the item type is a pickaxe, false otherwise.

Note
This method evaluates if the item type contains the minecraft:is_pickaxe tag.
Inherited from ItemType.isPickaxe
- Defined in packages/core/src/item/identity/type.ts:391

isShovel

isShovel(): boolean
Whether the item type is a shovel.

Returns boolean
True if the item type is a shovel, false otherwise.

Note
This method evaluates if the item type contains the minecraft:is_shovel tag.
Inherited from ItemType.isShovel
- Defined in packages/core/src/item/identity/type.ts:409

isSword

isSword(): boolean
Whether the item type is a sword.

Returns boolean
True if the item type is a sword, false otherwise.

Note
This method evaluates if the item type contains the minecraft:is_sword tag.
Inherited from ItemType.isSword
- Defined in packages/core/src/item/identity/type.ts:427

registerTrait

registerTrait(trait: typeof ItemStackTrait): this
Register a trait to the item type.
Parameters
- trait: typeof ItemStackTrait
  The trait to register.
Returns this
The item type instance.
Inherited from ItemType.registerTrait
- Defined in packages/core/src/item/identity/type.ts:245

removeTag

removeTag(...tags: string[]): this
Remove a tag from the item type.
Parameters
- ...tags: string[]
  The tags to remove.
Returns this
The item type instance.
Inherited from ItemType.removeTag
- Defined in packages/core/src/item/identity/type.ts:351

setIsComponentBased

setIsComponentBased(value: boolean): void
Set whether the item type is component based.
Parameters
- value: boolean
  True to set the item type as component based, false otherwise.
Returns void
Inherited from ItemType.setIsComponentBased
- Defined in packages/core/src/item/identity/type.ts:218

setTags

setTags(tags: string[]): this
Set the tags of the item type.
Parameters
- tags: string[]
  The tags to set.
Returns this
The item type instance.
Inherited from ItemType.setTags
- Defined in packages/core/src/item/identity/type.ts:301

setVersion

setVersion(version: number): void
Set the version of the item type.
Parameters
- version: number
  The version to set.
Returns void
Inherited from ItemType.setVersion
- Defined in packages/core/src/item/identity/type.ts:235

unregisterTrait

unregisterTrait(trait: string | typeof ItemStackTrait): this
Unregister a trait from the item type.
Parameters
- trait: string | typeof ItemStackTrait
  The trait to unregister, or the identifier of the trait.
Returns this
The item type instance.
Inherited from ItemType.unregisterTrait
- Defined in packages/core/src/item/identity/type.ts:261

`Static`get

get(identifier: string): null | ItemType
Get the item type from the registry.
Parameters
- identifier: string
Returns null | ItemType
Inherited from ItemType.get
- Defined in packages/core/src/item/identity/type.ts:470

`Static`getAll

getAll(): ItemType[]
Get all item types from the registry.

Returns ItemType[]
Inherited from ItemType.getAll
- Defined in packages/core/src/item/identity/type.ts:488

`Static`getByNetwork

getByNetwork(network: number): null | ItemType
Get the item type from the network.
Parameters
- network: number
  The network to get the item type from.
Returns null | ItemType
Inherited from ItemType.getByNetwork
- Defined in packages/core/src/item/identity/type.ts:478

`Static`resolve

resolve(type: BlockType): null | ItemType
Resolve the item type from the block type.
Parameters
- type: BlockType
  The block type to resolve.
Returns null | ItemType
Inherited from ItemType.resolve
- Defined in packages/core/src/item/identity/type.ts:496

`Static`toNetworkInstance

toNetworkInstance(
    type: ItemType,
    stackSize?: number,
    nbt?: null | CompoundTag,
): NetworkItemInstanceDescriptor
Convert the item type to a network instance.
Parameters
- type: ItemType
  The item type to convert.
- stackSize: number = 1
  The stack size of the item type, default 1.
- nbt: null | CompoundTag = null
  The NBT of the item type, default null.
Returns NetworkItemInstanceDescriptor
The network item instance descriptor.
Inherited from ItemType.toNetworkInstance
- Defined in packages/core/src/item/identity/type.ts:518

`Static`toNetworkStack

toNetworkStack(type: ItemType): NetworkItemStackDescriptor
Converts the item type to a network item stack descriptor.
Parameters
- type: ItemType
  The item type to convert.
Returns NetworkItemStackDescriptor
The network item stack descriptor.

Note
Method is used on the protocol level.
Inherited from ItemType.toNetworkStack
- Defined in packages/core/src/item/identity/type.ts:555

Class CustomItemType

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CustomItemType

Properties

creativeCategory

creativeGroup

Readonlyidentifier

Readonlynetwork

Readonlyproperties

Readonlytraits

StaticAIR

Protected StaticnetworkId

Static Readonlytypes

Accessors

components

Returns ItemTypeComponentCollection

isStackable

Returns boolean

Methods

addTag

Parameters

Returns this

getIsComponentBased

Returns boolean

getTags

Returns string[]

getToolTier

Returns ItemTypeToolTier

Note

getVersion

Returns number

hasTag

Parameters

Returns boolean

isAxe

Returns boolean

Note

isHoe

Returns boolean

Note

isPickaxe

Returns boolean

Note

isShovel

Returns boolean

Note

isSword

Returns boolean

Note

registerTrait

Parameters

Returns this

removeTag

Parameters

Returns this

setIsComponentBased

Parameters

Returns void

setTags

Parameters

Returns this

setVersion

Parameters

Returns void

unregisterTrait

Parameters

Returns this

Staticget

Parameters

Returns null | ItemType

StaticgetAll

Returns ItemType[]

`Readonly`identifier

`Readonly`network

`Readonly`properties

`Readonly`traits

`Static`AIR

`Protected` `Static`networkId

`Static` `Readonly`types

`Static`get

`Static`getAll

`Static`getByNetwork

`Static`resolve

`Static`toNetworkInstance

`Static`toNetworkStack