ComputerCraft Wiki - User contributions [en]

Os.pullEvent

2012-11-05T15:30:14Z

Pharap:

{{lowercase}}
{{Function
|name=os.pullEvent
|args=([[string]]) only-event-to-accept
|api=os
|returns=(string)event, variable parameters(see table below)
|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
|(string)the letter typed
|
|
|
|
|
|-
![[key]]
|Fired when a key is pressed on the keyboard
|(number)numerical keycode
|
|
|
|
|
|-
![[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)|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 ==
[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-11-05T15:28:42Z

Pharap: /* Event Types */

{{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
|(string)the letter typed
|
|
|
|
|
|-
![[key]]
|Fired when a key is pressed on the keyboard
|(number)numerical keycode
|
|
|
|
|
|-
![[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)|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 ==
[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-11-05T15:27:32Z

Pharap: /* Event Types */

{{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
|(string)the letter typed
|
|
|
|
|
|-
![[key]]
|Fired when a key is pressed on the keyboard
|(number)numerical [[http://computercraft.info/wiki/index.php?title=Raw_key_events|keycode]]
|
|
|
|
|
|-
![[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)|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 ==
[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-30T12:53:43Z

Pharap: new event discovered

{{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
|
|
|
|
|
|-
!mouse_click
|Fired when a mouse button is pressed
|mouse button
|x coordinate
|y coordinate
|
|
|
|-
!mouse_scroll
|Fired when a mousewheel is scrolled.
|scroll direction (-1 for up, 1 for down)
|x coordinate
|y coordinate
|
|
|-
!mouse_drag
|Fired when the mouse is moved after clicking.
|x coordinate
|y coordinate
|
|
|
|}

== 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.queueEvent

2012-10-30T10:12:03Z

Pharap:

{{lowercase}}
{{Function
|name=os.queueEvent
|args=[[string]] eventName, param1, param2, param3
|api=os
|addon=ComputerCraft
|desc=Adds an event <var>eventName</var> with the specified parameters to the event queue.
|examples=
{{Example
|desc=The program adds an event which it will eventually pull.
|code=
function clear()
term.clear()
term.setCursorPos(1,1) end
os.queueEvent("abc", 2, "meow")
while true do
local event, param1, param2 = os.pullEvent()
if event == "abc" then
print("ABC EVENT! Parameters: "..param1.." / " ..param2)
else
print("Event: " .. event )
end
end
}}
}}
{{Example
|desc=To easily have a redstone and a key input do the same,<br />
it queues a key event with the appropriate key if a redstone event happens.
|code=
while true do
local event, param1 = os.pullEvent()
if event == "redstone" then
if rs.getInput("left") then
os.queueEvent("key",28)
end
elseif event == "key" then
if param1 == 28 then
print("Hello")
end
end
end
}}

Os.queueEvent

2012-10-30T10:09:35Z

Pharap: Fixing code

{{lowercase}}
{{Function
|name=os.queueEvent
|args=[[string]] eventName, param1, param2, param3
|api=os
|addon=ComputerCraft
|desc=Adds an event <var>eventName</var> with the specified parameters to the event queue.
|examples=
{{Example
|desc=The program adds an event which it will eventually pull.
|code=function clear()
term.clear()
term.setCursorPos (1,1)
end
os.queueEvent("abc", 2, "meow")
while true do
local event, param1, param2 = os.pullEvent()
if event == "abc" then
print("ABC EVENT! Parameters: "..param1.." / " ..param2)
else
print("Event: " .. event )
end
end
}}
}}
{{Example
|desc=To easily have a redstone and a key input do the same,<br />
it queues a key event with the appropriate key if a redstone event happens.
|code=
while true do
local event, param1 = os.pullEvent()
if event == "redstone" then
if rs.getInput("left") then
os.queueEvent("key",28)
end
elseif event == "key" then
if param1 == 28 then
print("Hello")
end
end
end
}}