Difference between revisions of "Disk.getID"

From ComputerCraft Wiki
Jump to: navigation, search
(Int linking fix; awkward phrasing re-phrased.)
(Changing int to number)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{lowercase}}
 
{{lowercase}}
 
{{Function
 
{{Function
|name=disk.getDiskID
+
|name=disk.getID
|args=[[string (type)|string]] side
+
|args={{Type|string}} side
 
|api=disk
 
|api=disk
|returns=[[int (type)|int]] disk ID
+
|returns={{Type|number}} the disk ID, or [[nil]] if the drive does not contain a [[Floppy Disk]]
 
|addon=ComputerCraft
 
|addon=ComputerCraft
 +
|desc=Returns a number which uniquely identifies the disk in the drive and which is the name of the directory in the world’s <code>computer/disk</code> directory containing the disk’s data.
 
|examples=
 
|examples=
 
{{Example
 
{{Example
 
|desc=Prints the ID of the disk.
 
|desc=Prints the ID of the disk.
|code=print(disk.getDiskID("bottom"))
+
|code=print(disk.getID("bottom"))
 
|output=The ID of the disk (side varies).
 
|output=The ID of the disk (side varies).
 
}}
 
}}
 
}}
 
}}
 
  
 
[[Category:API_Functions]]
 
[[Category:API_Functions]]

Latest revision as of 14:27, 18 July 2013


Grid Redstone.png  Function disk.getID
Returns a number which uniquely identifies the disk in the drive and which is the name of the directory in the world’s computer/disk directory containing the disk’s data.
Syntax disk.getID(string side)
Returns number the disk ID, or nil if the drive does not contain a Floppy Disk
Part of ComputerCraft
API disk

Examples

Grid paper.png  Example
Prints the ID of the disk.
Code
print(disk.getID("bottom"))
Output The ID of the disk (side varies).