Difference between revisions of "Disk (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(clarify hasData / hasAudio)
(Updated to API overview v2)
Line 4: Line 4:
 
The Disk API allows you to interact with disk drives.
 
The Disk API allows you to interact with disk drives.
  
−
==Methods==
+
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
−
{| border="1" cellpadding="2" cellspacing="0"
+
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
−
!style="background:#EEE" width="200px"|Method name
+
[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
−
!style="background:#EEE" width="*"|Description
+
Disk (API)
−
|-
+
</td></tr>
−
|[[disk.isPresent|disk.isPresent]]([[string (type)|string]] side )
+
 
−
|Checks the given side for a disk
+
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
−
|-
+
 
−
|[[disk.hasData|disk.hasData]]([[string (type)|string]] side )
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.isPresent|disk.isPresent]]([[string (type)|string]] side )</td>
−
|Checks whether the current disk is a [[Floppy Disk|floppy disk]], as opposed to a [http://www.minecraftwiki.net/wiki/Music_Discs music disk].
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks the given side for a disk</td></tr>
−
|-
+
 
−
|[[disk.getMountPath|disk.getMountPath]]([[string (type)|string]] side )
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.hasData|disk.hasData]]([[string (type)|string]] side )</td>
−
|Returns the directory path on which the disk on '''side''' has been mount (ex. /disk)
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks whether the current disk is a [[Floppy Disk|floppy disk]], as opposed to a [http://www.minecraftwiki.net/wiki/Music_Discs music disk].</td></tr>
−
|-
+
 
−
|[[disk.setLabel|disk.setLabel]]([[string (type)|string]] side, [[string (type)|string]] label )
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.getMountPath|disk.getMountPath]]([[string (type)|string]] side )</td>
−
|Sets the label
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the directory path on which the disk on '''side''' has been mount (ex. /disk)</td></tr>
−
|-
+
 
−
|[[disk.getLabel|disk.getLabel]]([[string (type)|string]] side )
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.setLabel|disk.setLabel]]([[string (type)|string]] side, [[string (type)|string]] label )</td>
−
|Finds label
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the label</td></tr>
−
|-
+
 
−
|-
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.getLabel|disk.getLabel]]([[string (type)|string]] side )</td>
−
|[[disk.getDiskID|disk.getDiskID]]([[string (type)|string]] side )
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Finds label</td></tr>
−
|Finds ID (unique for every disk)
+
 
−
|-
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.getDiskID|disk.getDiskID]]([[string (type)|string]] side )</td>
−
|[[disk.hasAudio|disk.hasAudio]]([[string (type)|string]] side )
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Finds ID (unique for every disk)</td></tr>
−
|Checks whether the current disk is a [http://www.minecraftwiki.net/wiki/Music_Discs music disk], as opposed to a [[Floppy Disk|floppy disk]].
+
 
−
|-
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.hasAudio|disk.hasAudio]]([[string (type)|string]] side )</td>
−
|[[disk.getAudioTitle|disk.getAudioTitle]]([[string (type)|string]] side )
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks whether the current disk is a [http://www.minecraftwiki.net/wiki/Music_Discs music disk], as opposed to a [[Floppy Disk|floppy disk]].</td></tr>
−
|Returns the audio title on the disk
+
 
−
|-
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.getAudioTitle|disk.getAudioTitle]]([[string (type)|string]] side )</td>
−
|[[disk.playAudio|disk.playAudio]]([[string (type)|string]] side )
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the audio title on the disk</td></tr>
−
|Plays the audio
+
 
−
|-
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.playAudio|disk.playAudio]]([[string (type)|string]] side )</td>
−
|[[disk.stopAudio|disk.stopAudio]]([[string (type)|string]] side )
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Plays the audio</td></tr>
−
|Stops the audio
+
 
−
|-
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.stopAudio|disk.stopAudio]]([[string (type)|string]] side )</td>
−
|[[disk.eject|disk.eject]]([[string (type)|string]] side )
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Stops the audio</td></tr>
−
|Ejects the disk.
+
 
−
|}
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[disk.eject|disk.eject]]([[string (type)|string]] side )</td>
 +
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Ejects the disk.</td></tr>
 +
</table>
 +
 
 +
 
 
[[Category:APIs]]
 
[[Category:APIs]]

Revision as of 22:03, 30 November 2012

If you were looking for disks as in Floppies, go to Floppy Disk.


The Disk API allows you to interact with disk drives.

Grid disk.png   Disk (API)

Method NameDescription
disk.isPresent(string side ) Checks the given side for a disk
disk.hasData(string side ) Checks whether the current disk is a floppy disk, as opposed to a music disk.
disk.getMountPath(string side ) Returns the directory path on which the disk on side has been mount (ex. /disk)
disk.setLabel(string side, string label ) Sets the label
disk.getLabel(string side ) Finds label
disk.getDiskID(string side ) Finds ID (unique for every disk)
disk.hasAudio(string side ) Checks whether the current disk is a music disk, as opposed to a floppy disk.
disk.getAudioTitle(string side ) Returns the audio title on the disk
disk.playAudio(string side ) Plays the audio
disk.stopAudio(string side ) Stops the audio
disk.eject(string side ) Ejects the disk.
Retrieved from "https://www.computercraft.info/wiki/index.php?title=Disk_(API)&oldid=4413"