@ascentbv/ts-common - v1.0.123
    Preparing search index...

    Class BlockRecordPlayerComponent

    Represents a block that can play a record.

    Hierarchy (View Summary)

    Index

    Properties

    block componentId isValid typeId

    Methods

    ejectRecord getRecord isPlaying pauseRecord playRecord setRecord

    Properties

    block: Block

    Block instance that this component pertains to.

    componentId: "minecraft:record_player" = 'minecraft:record_player'
    isValid: boolean

    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.

    typeId: string

    Identifier of the component.

    Methods

    • Returns void

      Ejects the currently set record of this record-playing block.

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

      This function can throw errors.

    • Returns ItemStack | undefined

      Gets the currently set record of this record-playing block.

      This function can throw errors.

    • Returns boolean

      Returns true if the record-playing block is currently playing a record.

      This function can throw errors.

    • Returns void

      Pauses the currently playing record of this record-playing block.

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

      This function can throw errors.

    • Returns void

      Plays the currently set record of this record-playing block.

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

      This function can throw errors.

    • Parameters

      • OptionalrecordItemType: string | ItemType
      • OptionalstartPlaying: boolean

        Defaults to: true

      Returns void

      Sets and plays a record based on an item type.

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

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods