Difference between revisions of "Peripheral.wrap"

From ComputerCraft Wiki
Jump to: navigation, search
m (My definition of "prints the name of the device" isn't "handle.shutdown()". :P)
m
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
{{Function
 
{{Function
 
|name=peripheral.wrap
 
|name=peripheral.wrap
|args= [[string (type)|(string)]] side
+
|args= {{type|string}} side
|returns=A handle to the peripheral on ''side''.
+
|returns={{type|table}} handle with all functions a peripheral has
 
|api=peripheral
 
|api=peripheral
 
|addon=ComputerCraft
 
|addon=ComputerCraft
|desc=Returns a handle to a peripheral that can then be used to call methods, as if using peripheral.call(side, method)
+
|desc=Returns a table containing functions pointing to the peripheral's methods, which can then be called as if using peripheral.call(side, method). If no peripheral is found at the specified side, returns {{type|nil}} instead.
 
|examples=
 
|examples=
 
{{Example
 
{{Example
 
|desc=Shuts down the computer or turtle on the right side of the calling machine.
 
|desc=Shuts down the computer or turtle on the right side of the calling machine.
|code=local handle = peripheral.wrap("right") handle.shutdown()
+
|code= local computer = '''peripheral.wrap("right")'''
 +
computer.shutdown()
 
|output=Shuts down any computer to the right of the computer/turtle.
 
|output=Shuts down any computer to the right of the computer/turtle.
 
}}
 
}}

Latest revision as of 17:24, 10 April 2014


Grid Redstone.png  Function peripheral.wrap
Returns a table containing functions pointing to the peripheral's methods, which can then be called as if using peripheral.call(side, method). If no peripheral is found at the specified side, returns nil instead.
Syntax peripheral.wrap(string side)
Returns table handle with all functions a peripheral has
Part of ComputerCraft
API peripheral

Examples

Grid paper.png  Example
Shuts down the computer or turtle on the right side of the calling machine.
Code
local computer = peripheral.wrap("right")
computer.shutdown()
Output Shuts down any computer to the right of the computer/turtle.