Class BlockTypeMaterialInstancesComponent

Refrence the wiki for more information: https://wiki.bedrock.dev/blocks/block-components.html#material-instances

Hierarchy (View Summary)

BlockTypeComponent
- BlockTypeMaterialInstancesComponent

Index

Constructors

Properties

collection identifier materials type identifier

Accessors

Methods

createMaterialInstance removeMaterialInstance

Constructors

constructor

new BlockTypeMaterialInstancesComponent(
block: BlockPermutation<keyof BlockState> | BlockType<keyof BlockState>,
options?: Partial<BlockTypeMaterialInstancesComponentOptions>,
): BlockTypeMaterialInstancesComponent
Create a new material instances property for a block definition.
Parameters
- block: BlockPermutation<keyof BlockState> | BlockType<keyof BlockState>
  The block definition that this property will be attached to.
- Optionaloptions: Partial<BlockTypeMaterialInstancesComponentOptions>
  The options for the material instances property.
Returns BlockTypeMaterialInstancesComponent
Overrides BlockTypeComponent.constructor
- Defined in packages/core/src/block/identity/components/material-instances.ts:52

Properties

`Protected` `Readonly`collection

collection: BlockTypeComponentCollection

The properties collection of the block type.

`Readonly`identifier

identifier: string = ...

The component identifier of the block type.

`Readonly`materials

materials: CompoundTag<unknown>

The material instances of the block.

`Protected` `Readonly`type

type: BlockType

The block type of the component.

`Static` `Readonly`identifier

identifier: "minecraft:material_instances"

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

createMaterialInstance

createMaterialInstance(
key: string,
options: Partial<MaterialInstanceOptions>,
): void
Create a new material instance.
Parameters
- key: string
  The key of the material instance.
- options: Partial<MaterialInstanceOptions>
  The options for the material instance.
Returns void
- Defined in packages/core/src/block/identity/components/material-instances.ts:82

removeMaterialInstance

removeMaterialInstance(key: string): void
Remove a material instance.
Parameters
- key: string
Returns void
- Defined in packages/core/src/block/identity/components/material-instances.ts:114