Class BlockRecordPlayerComponent

Represents a block that can play a record.

Hierarchy (View Summary)

BlockComponent
- BlockRecordPlayerComponent

Index

Constructors

Properties

block typeId componentId

Methods

ejectRecord getRecord isPlaying isValid pauseRecord playRecord setRecord

Constructors

`Private`constructor

new BlockRecordPlayerComponent(): BlockRecordPlayerComponent
Returns BlockRecordPlayerComponent
Overrides BlockComponent.constructor

Properties

`Readonly`block

block: Block

Remarks

Block instance that this component pertains to.

`Readonly`typeId

typeId: string

Remarks

Identifier of the component.

`Static` `Readonly`componentId

componentId: "minecraft:record_player" = 'minecraft:record_player'

Methods

ejectRecord

ejectRecord(): void
Returns void
Remarks
Ejects the currently set record of this record-playing block.

This function can't be called in read-only mode.

Throws
This function can throw errors.

getRecord

getRecord(): ItemStack
Returns ItemStack
Remarks
Gets the currently set record of this record-playing block.

Throws
This function can throw errors.

isPlaying

isPlaying(): boolean
Returns boolean
Remarks
Returns true if the record-playing block is currently playing a record.

Throws
This function can throw errors.

isValid

isValid(): boolean
Returns boolean
Whether the component is valid.

Deprecated
This function is deprecated and will be removed in 2.0.0.

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.

Inherited from BlockComponent.isValid

pauseRecord

pauseRecord(): void
Returns void
Remarks
Pauses the currently playing record of this record-playing block.

This function can't be called in read-only mode.

Throws
This function can throw errors.

playRecord

playRecord(): void
Returns void
Remarks
Plays the currently set record of this record-playing block.

This function can't be called in read-only mode.

Throws
This function can throw errors.

setRecord

setRecord(recordItemType?: string | ItemType, startPlaying?: boolean): void
Parameters
- OptionalrecordItemType: string | ItemType
- OptionalstartPlaying: boolean
  Defaults to: true
Returns void
Remarks
Sets and plays a record based on an item type.

This function can't be called in read-only mode.

Throws
This function can throw errors.