Class BlockTypeDisplayNameComponent

Hierarchy (View Summary)

BlockTypeComponent
- BlockTypeDisplayNameComponent

Index

Constructors

Properties

collection identifier type identifier

Accessors

Methods

getDisplayName setDisplayName

Constructors

constructor

new BlockTypeDisplayNameComponent(
block: BlockPermutation<keyof BlockState> | BlockType<keyof BlockState>,
value?: string,
): BlockTypeDisplayNameComponent
Create a new display name component for a block type.
Parameters
- block: BlockPermutation<keyof BlockState> | BlockType<keyof BlockState>
  The block type or permutation that the component will be attached to.
- Optionalvalue: string
  The display name of the block type.
Returns BlockTypeDisplayNameComponent
Overrides BlockTypeComponent.constructor
- Defined in packages/core/src/block/identity/components/display-name.ts:16

Properties

`Protected` `Readonly`collection

collection: BlockTypeComponentCollection

The properties collection of the block type.

`Readonly`identifier

identifier: string = ...

The component identifier of the block type.

`Protected` `Readonly`type

type: BlockType

The block type of the component.

`Static` `Readonly`identifier

identifier: "minecraft:display_name"

The component identifier of the block type.

Accessors

`Protected`component

get component(): CompoundTag<unknown>
The component value of the block type.

Returns CompoundTag<unknown>
Inherited from BlockTypeComponent.component
- Defined in packages/core/src/block/identity/components/component.ts:32

Methods

getDisplayName

getDisplayName(): string
Get the display name of the block type.

Returns string
The display name of the block type.
- Defined in packages/core/src/block/identity/components/display-name.ts:27

setDisplayName

setDisplayName(value: string): void
Set the display name of the block type.
Parameters
- value: string
  The display name of the block type.
Returns void
- Defined in packages/core/src/block/identity/components/display-name.ts:39