Class BlockInstrumentComponent`Beta`

Represents the instruments a block can have assigned to it's up and down faces.

Hierarchy (View Summary)

BlockComponent
- BlockInstrumentComponent

Index

Properties

block isValid typeId componentId

Methods

getInstrumentName playInstrumentSound

Properties

`Readonly`block

block: Block

Remarks

Block instance that this component pertains to.

`Readonly`isValid

isValid: boolean

Remarks

Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

`Readonly`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly`componentId

componentId: "minecraft:instrument_sound" = 'minecraft:instrument_sound'

Methods

getInstrumentName

getInstrumentName(face: Direction): string
Parameters
- face: Direction
  the face Direction to get the instrument name for.
Returns string
Returns the name of the instrument for a given valid face Direction.

Remarks
A getter method to get the name of an instrument for a given valid face Direction.

Throws
This function can throw errors.

InvalidArgumentError

LocationInUnloadedChunkError

LocationOutOfWorldBoundariesError
- Defined in @minecraft/server.d.ts:5440

playInstrumentSound

playInstrumentSound(face: Direction, soundOptions?: WorldSoundOptions): void
World mutation
Parameters
- face: Direction
  the face Direction for which instrument sound to play.
- OptionalsoundOptions: WorldSoundOptions
  optional WorldSoundOptions to use when playing the insturment sound; if omitted the default values are used.
Returns void
Remarks
plays the instrument sound for a given valid face Direction at the components block location using optional WorldSoundOptions.

Throws
This function can throw errors.

InvalidArgumentError

LocationInUnloadedChunkError

LocationOutOfWorldBoundariesError
- Defined in @minecraft/server.d.ts:5462

Class BlockInstrumentComponent`Beta`

Hierarchy (View Summary)

Index

Properties

Methods

Properties

`Readonly`block

Remarks

`Readonly`isValid

Remarks

`Readonly`typeId

Remarks

`Static` `Readonly`componentId

Methods

getInstrumentName

Parameters

Returns string

Remarks

Throws

playInstrumentSound

Parameters

Returns void

Remarks

Throws

Settings

On This Page

Class BlockInstrumentComponentBeta

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlyblock

Remarks

ReadonlyisValid

Remarks

ReadonlytypeId

Remarks

Static ReadonlycomponentId

Methods

getInstrumentName

Parameters

Returns string

Remarks

Throws

playInstrumentSound

Parameters

Returns void

Remarks

Throws

Settings

On This Page

Class BlockInstrumentComponent`Beta`

`Readonly`block

`Readonly`isValid

`Readonly`typeId

`Static` `Readonly`componentId