Difference between revisions of "Os.pullEvent"

From ComputerCraft Wiki
Jump to: navigation, search
(→‎Event Types)
(→‎Event Types)
Line 61: Line 61:
 
![[char]]
 
![[char]]
 
|Fired when text is typed on the keyboard
 
|Fired when text is typed on the keyboard
−
|the letter typed
+
|(string)the letter typed
 
|
 
|
 
|
 
|
Line 70: Line 70:
 
![[key]]
 
![[key]]
 
|Fired when a key is pressed on the keyboard
 
|Fired when a key is pressed on the keyboard
−
|numerical keycode
+
|(number)numerical [[http://computercraft.info/wiki/index.php?title=Raw_key_events|keycode]]
 
|
 
|
 
|
 
|
Line 79: Line 79:
 
![[timer]]
 
![[timer]]
 
|Fired when a timeout started by os.startTimer() completes
 
|Fired when a timeout started by os.startTimer() completes
−
|Value of the timer as returned by os.startTimer()
+
|(number)Value of the timer as returned by os.startTimer()
 
|
 
|
 
|
 
|
Line 88: Line 88:
 
![[alarm]]
 
![[alarm]]
 
|Fired when a time passed to os.setAlarm() is reached
 
|Fired when a time passed to os.setAlarm() is reached
−
|Value of the alarm as returned by os.setAlarm()
+
|(number)Value of the alarm as returned by os.setAlarm()
 
|
 
|
 
|
 
|
Line 106: Line 106:
 
![[disk]]
 
![[disk]]
 
|Fired when a disk is inserted into an adjacent disk drive
 
|Fired when a disk is inserted into an adjacent disk drive
−
|side
+
|(string)side
 
|
 
|
 
|
 
|
Line 115: Line 115:
 
![[disk_eject]]
 
![[disk_eject]]
 
|Fired when a disk is removed from an adjacent disk drive
 
|Fired when a disk is removed from an adjacent disk drive
−
|side
+
|(string)side
 
|
 
|
 
|
 
|
Line 124: Line 124:
 
![[peripheral]]
 
![[peripheral]]
 
|Fired when peripheral is attached
 
|Fired when peripheral is attached
−
|side
+
|(string)side
 
|
 
|
 
|
 
|
Line 133: Line 133:
 
![[peripheral_detach]]
 
![[peripheral_detach]]
 
|Fired when peripheral is removed
 
|Fired when peripheral is removed
−
|side
+
|(string)side
 
|
 
|
 
|
 
|
Line 142: Line 142:
 
![[rednet_message]]
 
![[rednet_message]]
 
|Fired when a rednet message is received from the [[Rednet_(API)|rednet API]]
 
|Fired when a rednet message is received from the [[Rednet_(API)|rednet API]]
−
|senderID
+
|(number)senderID
−
|message
+
|(string)message
−
|distanceTravelled
+
|(number)distance travelled
 
|
 
|
 
|
 
|
Line 150: Line 150:
 
|-
 
|-
 
![[http_success]]
 
![[http_success]]
−
|Fired when an attempt to recieve text from / post text on a website is successful
+
|Fired when an attempt to receieve text from / post text on a website is successful
−
|url of the site
+
|(string)url of the site
−
|text on the site
+
|(table)text on the site
 
|
 
|
 
|
 
|
Line 159: Line 159:
 
|-
 
|-
 
![[http_failure]]
 
![[http_failure]]
−
|Fired when an attempt to recieve text from / post text on a website is unsuccessful
+
|Fired when an attempt to receive text from / post text on a website is unsuccessful
−
|url of the site
+
|(string)url of the site
 
|
 
|
 
|
 
|
Line 169: Line 169:
 
![[mouse_click]]
 
![[mouse_click]]
 
|Fired when a mouse button is pressed
 
|Fired when a mouse button is pressed
−
|mouse button
+
|(number)mouse button
−
|x coordinate
+
|(number)x coordinate
−
|y coordinate
+
|(number)y coordinate
 
|
 
|
 
|
 
|
Line 178: Line 178:
 
![[mouse_scroll]]
 
![[mouse_scroll]]
 
|Fired when a mousewheel is scrolled.
 
|Fired when a mousewheel is scrolled.
−
|scroll direction (-1 for up, 1 for down)
+
|(number)scroll direction (-1 for up, 1 for down)
−
|x coordinate
+
|(number)x coordinate(in screen chars)
−
|y coordinate
+
|(number)y coordinate(in screen chars)
 
|
 
|
 
|
 
|
Line 186: Line 186:
 
![[mouse_drag]]
 
![[mouse_drag]]
 
|Fired when the mouse is moved after clicking.
 
|Fired when the mouse is moved after clicking.
−
|x coordinate
+
|(number)x coordinate(in screen chars)
−
|y coordinate
+
|(number)y coordinate(in screen chars)
 
|
 
|
 
|
 
|

Revision as of 15:27, 5 November 2012


Grid Redstone.png  Function os.pullEvent
Yields computer until event occurs
Syntax os.pullEvent(string only-event-to-accept)
Returns event, parameters
Part of ComputerCraft
API os

Examples

Grid paper.png  Example
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

event, param1, param2, param3 = os.pullEvent()

Event Types

Name Description Parameters
1 2 3 4 5 6
char Fired when text is typed on the keyboard (string)the letter typed
key Fired when a key is pressed on the keyboard (number)numerical [[1]]
timer Fired when a timeout started by os.startTimer() completes (number)Value of the timer as returned by os.startTimer()
alarm Fired when a time passed to os.setAlarm() is reached (number)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 (string)side
disk_eject Fired when a disk is removed from an adjacent disk drive (string)side
peripheral Fired when peripheral is attached (string)side
peripheral_detach Fired when peripheral is removed (string)side
rednet_message Fired when a rednet message is received from the rednet API (number)senderID (string)message (number)distance travelled
http_success Fired when an attempt to receieve text from / post text on a website is successful (string)url of the site (table)text on the site
http_failure Fired when an attempt to receive text from / post text on a website is unsuccessful (string)url of the site
mouse_click Fired when a mouse button is pressed (number)mouse button (number)x coordinate (number)y coordinate
mouse_scroll Fired when a mousewheel is scrolled. (number)scroll direction (-1 for up, 1 for down) (number)x coordinate(in screen chars) (number)y coordinate(in screen chars)
mouse_drag Fired when the mouse is moved after clicking. (number)x coordinate(in screen chars) (number)y coordinate(in screen chars)

Guides

Onionnion's Guide on os.pullEvent()

Retrieved from "https://www.computercraft.info/wiki/index.php?title=Os.pullEvent&oldid=3631"