drive

This type is used to represent a disk drive peripheral.

Drivers that use this type

• peripheral_drive: Implements for disk drive peripherals.

Properties

• state: {audio: string?, label: string?, id: number?}? {get}: Information about the current inserted disk, if one is available.

Methods

• setLabel(label: string?): Sets the label of the disk, if a disk is currently inserted. Throws otherwise.
• play(): Plays the current music disc if one is inserted. Throws otherwise.
• stop(): Stops the current music disc if one is inserted.
• eject(): Ejects the disk that is currently in the drive.
• insert(path: string): On CraftOS-PC: Changes the path of the disk that is currently inserted in the drive. (Requires root)

Events

• disk: Sent when a disk is inserted into the drive.
  • device: string: The path of the drive that sent the message
• disk_eject: Sent when a disk is removed from the drive.
  • device: string: The path of the drive that sent the message