ComputerCraft Wiki - User contributions [en]

Peripheral (API)

2012-10-19T23:08:42Z

Mrblahblah200: Added some continuity to the printers

The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor. 
[[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.

==Methods==
{| class="wikitable"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[peripheral.isPresent]]( side )
|Returns '''true''' if a peripheral is present on ''side''.
|-
|[[peripheral.getType]]( side )
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.
|-
|[[peripheral.getMethods]]( side )
|Returns a table containing all methods for peripheral on ''side''.
|-
|[[peripheral.call]]( side, methodName, param1, param2, ... )
|Sends a function call to peripheral located on ''side''. Return values match those of called method. 
'''Note:''' ''methodName'' is a string.
|-
|[[peripheral.wrap]]( side )
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.: 
m = [[peripheral.wrap]]("left") 
m.someMethod() 
''- is the same as -'' 
[[peripheral.call]]("left","someMethod")
|}

==Events==
{| class="wikitable"
!style="background:#EEE" width="210px"|Event name
!style="background:#EEE" width="*"|Description
!style="background:#EEE" width="*"|Parameters
|-
|peripheral
|Fired when peripheral is attached
|side
|-
|peripheral_detach
|Fired when peripheral is removed
|side
|}
==Monitor==
List of methods:

'''''monitor'' stands for the variable you wrapped the monitor to.'''
''Example:'' monitor = peripheral.wrap( "top" )

{| class="wikitable"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[term.write|''monitor''.write]]()
|Write to the Monitor's screen.
|-
|[[term.scroll|''monitor''.scroll]]( n )
|Scrolls the monitor screen.
|-
|[[term.setCursorPos|''monitor''.setCursorPos]]( x, y )
|Sets the cursor position on the Monitor.
|-
|[[term.setCursorBlink|''monitor''.setCursorBlink]]( b )
|Enables or disables cursor blinking.
|-
|[[term.getCursorPos|''monitor''.getCursorPos]]()
|Returns two arguments containing the x and the y position of the cursor on the Monitor.
|-
|[[term.getSize|''monitor''.getSize]]()
|Returns two arguments containing the x and the y values stating the size of the Monitor.
|-
|[[term.clear|''monitor''.clear]]()
|Clears the Monitor.
|-
|[[term.clearLine|''monitor''.clearLine]]()
|Clears the line the cursor is on.
|-
|''monitor''.setTextScale( scale )
|Sets the size of the text on the Monitor. Textscale can be between 1.0 and 5.0, with increments of 0.5
|}
==Printer==
List of methods:

'''''printer'' stands for the variable you wrapped the printer to.'''
''Example:'' printer = peripheral.wrap( "right" )

{| class="wikitable"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|''printer''.[[printer.newPage|newPage]]()
|Starts a new page. Returns true if page got started, false if not.
|-
|''printer''.[[printer.endPage|endPage]]()
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.
|-
|''printer''.[[printer.write|write]]( text )
|Writes text to the paper, works the same way as [[term.write()]]
|-
|''printer''.[[printer.setPageTitle|setPageTitle]]( text )
|Sets the title of the page.
|-
|''printer''.[[printer.getPaperLevel|getPaperLevel]]()
|Returns the amount of paper available in the paper tray.
|-
|''printer''.[[printer.getInkLevel|getInkLevel]]()
|Returns the amount of ink in the ink slot.
|-
|''printer''.[[printer.getCursorPos|getCursorPos]]()
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]
|-
|''printer''.[[printer.setCursorPos|setCursorPos]]( x, y )
|Sets the cursor pos.
|-
|''printer''.[[printer.getPageSize|getPageSize]]()
|Returns the size of the paper, works the same way as [[term.getSize()]]
|}

==Computers==
List of methods:

'''''computer'' stands for the variable you wrapped the computer to.'''
''Example:'' computer = peripheral.wrap( "top" )

{| class="wikitable"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|''computer''.turnOn()
|Turns on the Computer or Turtle.
|-
|''computer''.shutdown()
|Shuts off the Computer or Turtle.
|-
|''computer''.reboot()
|Reboots the Computer or Turtle.
|-
|''computer''.getID()
|Gets the ID of the Computer or Turtle.
|}
[[Category:APIs]]

Textutils (API)

2012-10-15T17:31:04Z

Mrblahblah200:

Text utilities is used to mess around with text easier.

Its functions include:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[textutils.slowPrint|textutils.slowPrint( text , nRate)]]
|Slowly prints the text. Only difference is, it leaves a line after it.
|-
|[[textutils.slowWrite|textutils.slowWrite( text , nRate)]]
|Slowly writes the text.
|-
|[[textutils.formatTime|textutils.formatTime( time, bTwentyFourHour)]]
|Put a time into it, and it spews it out in a different format. For example:
local nTime = os.time()

print(textutils.formatTime( nTime, false ))
|-
|[[textutils.tabulate|textutils.tabulate( table, table2, so on)]]
|Prints tables in an ordered form. Each table is a row, columns' width is auto-adjusted.
|-
|[[textutils.pagedTabulate|textutils.pagedTabulate( table, table2, so on)]]
|<no description given>
|-
|[[textutils.pagedPrint|textutils.pagedPrint( string, lines-to-print-before-confirmation )]]
|Prints a string onto the screen, but waiting for confirmation before scrolling down.
|-
|[[textutils.serialize|textutils.serialize( t )]]
|Returns a string representation of the table t for storage or transmission.
|-
|[[textutils.unserialize|textutils.unserialize( s )]]
|Returns a table reassembled from the string s.
|-
|[[textutils.urlEncode|textutils.urlEncode( str )]]
|Makes a string safe to encode into an url. [[http://www.w3schools.com/tags/ref_urlencode.asp]].
|}

[[Category:APIs]]

Textutils (API)

2012-10-15T17:30:20Z

Mrblahblah200: Added a few descriptions, as well as adding the function textutils.pagedPrint(), which is not in the description of the official help screen.

Text utilities is used to mess around with text easier.

Its functions include:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[textutils.slowPrint|textutils.slowPrint( text , nRate)]]
|Slowly prints the text. Only difference is, it leaves a line after it.
|-
|[[textutils.slowWrite|textutils.slowWrite( text , nRate)]]
|Slowly writes the text.
|-
|[[textutils.formatTime|textutils.formatTime( time, bTwentyFourHour)]]
|Put a time into it, and it spews it out in a different format. For example:
local nTime = os.time()

print(textutils.formatTime( nTime, false ))
|-
|[[textutils.tabulate|textutils.tabulate( table, table2, so on)]]
|Prints tables in an ordered form. Each table is a row, columns' width is auto-adjusted.
|-
|[[textutils.pagedTabulate|textutils.pagedTabulate( table, table2, so on)]]
|<no description given>
|-
|[[textutils.pagedPrint|textutils.pagedPrint( string, lines-to-print-before-confirmation )]]
|Prints a string onto the screen, but waiting for confirmation before scrolling down.
|-
|[[textutils.serialize|textutils.serialize( t )]]
|Returns a string representation of the table t for storage or transmission.
|-
|[[textutils.unserialize|textutils.unserialize( s )]]
|Returns a table reassembled from the string s.
|-
|[[textutils.urlEncode|textutils.urlEncode( str )]]
|Makes a string safe to encode into an url. Spaces are replaced with +s. Unsafe characters such as '\', '£' and '}' are translated into ASCII code and preceeded with a % for transmission. For reference visit [[http://www.w3schools.com/tags/ref_urlencode.asp]].
|}

[[Category:APIs]]

Os.pullEvent

2012-10-12T19:51:15Z

Mrblahblah200: added () to os.pullEvent title. It was bugging my OCD...

{{lowercase}}
{{Function
|name=os.pullEvent()
|args=[[string]] only-event-to-accept
|api=os
|returns=event, parameters
|addon=ComputerCraft
|desc=Yields computer until event occurs
|examples=
{{Example
|desc=The program requires to wait for a keypress to do something:
|code=[[function]] clear()
[[term.clear]]()
[[term.setCursorPos]] (1,1)
end
while true do
clear()
[[print]] ("Press E to do something.")
local event, param1 = os.pullEvent ("char") -- limit os.pullEvent to the char event
if param1 == "e" then -- if the returned value was 'e'
clear()
[[write]] ("Name: ")
local name = [[read]]()
[[print]] (name)
break
else
clear()
[[print]] ("Wrong button!")
[[sleep]] (1.5) -- I don't like a whole 2 seconds but 1 second is too short
end
end
}}
}}

== How it Works ==
When os.pullEvent() is called, regardless of whether it has variables to set, the computer is yielded until an event occurs. An event is anything the computer can use as input, such as a button being pushed on the keyboard or a redstone input.
When said event occurs, the event's name is placed in the first variable (the variable 'event' in the section below). With the event comes returned values, and, depending on the event type, there can be different amounts and different data types of returned values.

For example, the event "char" returns "char" as the event and (let's say E was pressed) the first parameter will be set to "e", although whether or not Shift was pressed can change that "e" to an "E" as well.

The event "redstone" only returns the event type since any other information needed can be retrieved with [[redstone.getInput]].

=== Common Syntax ===
<pre>
event, param1, param2, param3 = os.pullEvent()
</pre>

==Event Types==
{| class="wikitable" width="100%"
! rowspan="2" | Name
! rowspan="2" | Description
! colspan="6" | Parameters
|-
! 1
! 2
! 3
! 4
! 5
! 6
|-
!char
|Fired when text is typed on the keyboard
|the letter typed
|
|
|
|
|
|-
!key
|Fired when a key is pressed on the keyboard
|numerical keycode
|
|
|
|
|
|-
!timer
|Fired when a timeout started by os.startTimer() completes
|Value of the timer as returned by os.startTimer()
|
|
|
|
|
|-
!alarm
|Fired when a time passed to os.setAlarm() is reached
|Value of the alarm as returned by os.setAlarm()
|
|
|
|
|
|-
!redstone
|Fired when the state of any of the redstone inputs change
|
|
|
|
|
|
|-
!disk
|Fired when a disk is inserted into an adjacent disk drive
|side
|
|
|
|
|
|-
!disk_eject
|Fired when a disk is removed from an adjacent disk drive
|side
|
|
|
|
|
|-
!peripheral
|Fired when peripheral is attached
|side
|
|
|
|
|
|-
!peripheral_detach
|Fired when peripheral is removed
|side
|
|
|
|
|
|-
!rednet_message
|Fired when a rednet message is received from the [[Rednet_(API)|rednet API]]
|senderID
|message
|distanceTravelled
|
|
|
|-
!http_success
|Fired when an attempt to recieve text from / post text on a website is successful
|url of the site
|text on the site
|
|
|
|
|-
!http_failure
|Fired when an attempt to recieve text from / post text on a website is unsuccessful
|url of the site
|
|
|
|
|
|-
!click
|Fired when a mouse button is pressed. This includes mousewheel movements.
|x coordinate
|y coordinate
|mouse button
|
|
|}

== Guides ==
[http://www.computercraft.info/forums2/index.php?/topic/1516-ospullevent-what-is-it-and-how-is-it-useful/page__view__findpost__p__11156 ''Onionnion's Guide on os.pullEvent()'']

Os.pullEvent

2012-10-03T21:29:37Z

Mrblahblah200: moved Os.pullEvent to Os.pullEvent() over redirect

#REDIRECT [[Os.pullEvent()]]