ComputerCraft Wiki - User contributions [en]

Colors (API)

2014-03-18T01:28:43Z

SuicidalSTDz: Fixed grammatical error

The Colors API allows you to manipulate sets of colors. This is useful in conjunction with Bundled Cables from the RedPower mod, RedNet Cables from the MineFactory Reloaded mod, and colors on [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor|Advanced Monitors]].

For the non-American English version just replace 'colors' with 'colours' and it will use the other API, colours—which is exactly the same, except in non-American English (e.g. gray is spelt grey and lightGray is spelt lightGrey).

{{API table|Colors|image=Grid_disk.png|2=

{{API table/row|[[colors.combine]]({{Type|number}} color1, {{Type|number}} color2, ...)|{{type|number}} value|
Combines one or more colors (or sets of colors) into a larger set.
|odd}}

{{API table/row|[[colors.subtract]]({{Type|number}} colors, {{Type|number}} color1, {{Type|number}} color2, ...)|{{type|number}} value|
Removes one or more colors (or sets of colors) from an initial set.
|}}

{{API table/row|[[colors.test]]({{type|number}} colors, {{type|number}} color)|{{type|boolean}} contained|
Tests whether ''color'' is contained within '''colors'''.
|odd}}

}}

'''Note:''' The standard addition (+) and subtraction (-) operators while able to be used on colors instead of colors.combine and colors.subtract should be avoided due to the nature of the colour format. For example<pre>print(colors.white + colors.white)</pre>will output 2 which is orange as opposed to<pre>print(colors.combine(colors.white, colors.white))</pre>will output 1 which is white.

Furthermore, the [[Bit (API)]] may be used on sets of colors. For example,
<pre>
bCableLeft = rs.getBundledInput("left")
bCableRight = rs.getBundledInput("right")

-- Get a number representing colors on in both right and left bundled cables
commonColors = bit.band(bCableLeft, bCableRight)

-- Get all the colors active on either right or left
totalColors = bit.bor(bCableLeft, bCableRight)

-- Get the colors which are active on right, or left, but not both at the same time
exclusiveColors = bit.bxor(bCableLeft, bCableRight)

-- Get the colors that are not active on the left
offColorsA = bit.bnot(bCableLeft)
</pre>

==Colors==
Color constants include, in ascending bit order (including character used in the paint program):

{| class="wikitable" width="200px"
! Color
! Decimal
! Hexadecimal
! Binary
! Paint Default
|-
| colors.white
| align="right" | 1
| align="right" | 0x1
| align="right" | 0000000000000001
| 0
|-
| colors.orange
| align="right" | 2
| align="right" | 0x2
| align="right" | 0000000000000010
| 1
|-
| colors.magenta
| align="right" | 4
| align="right" | 0x4
| align="right" | 0000000000000100
| 2
|-
| colors.lightBlue
| align="right" | 8
| align="right" | 0x8
| align="right" | 0000000000001000
| 3
|-
| colors.yellow
| align="right" | 16
| align="right" | 0x10
| align="right" | 0000000000010000
| 4
|-
| colors.lime
| align="right" | 32
| align="right" | 0x20
| align="right" | 0000000000100000
| 5
|-
| colors.pink
| align="right" | 64
| align="right" | 0x40
| align="right" | 0000000001000000
| 6
|-
| colors.gray
| align="right" | 128
| align="right" | 0x80
| align="right" | 0000000010000000
| 7
|-
| colors.lightGray
| align="right" | 256
| align="right" | 0x100
| align="right" | 0000000100000000
| 8
|-
| colors.cyan
| align="right" | 512
| align="right" | 0x200
| align="right" | 0000001000000000
| 9
|-
| colors.purple
| align="right" | 1024
| align="right" | 0x400
| align="right" | 0000010000000000
| a
|-
| colors.blue
| align="right" | 2048
| align="right" | 0x800
| align="right" | 0000100000000000
| b
|-
| colors.brown
| align="right" | 4096
| align="right" | 0x1000
| align="right" | 0001000000000000
| c
|-
| colors.green
| align="right" | 8192
| align="right" | 0x2000
| align="right" | 0010000000000000
| d
|-
| colors.red
| align="right" | 16384
| align="right" | 0x4000
| align="right" | 0100000000000000
| e
|-
| colors.black
| align="right" | 32768
| align="right" | 0x8000
| align="right" | 1000000000000000
| f
|}
[[Category:APIs]]

Bit (API)

2014-03-18T01:23:38Z

SuicidalSTDz: Fixed grammatical error

The Bit API is for manipulating numbers using bitwise binary operations.

All of these functions treat the numbers as 32-bit integers, and will raise an error if an input number is greater than 4,294,967,295.

{{API table|Bit|image=Grid disk.png|2=

{{API table/row
|[[bit.blshift]]({{type|number}} n, {{type|number}} bits)|{{type|number}} value
|Shifts a number left by a specified number of bits.
|odd}}

{{API table/row
|[[bit.brshift]]({{type|number}} n, {{type|number}} bits)|{{type|number}} value
|Shifts a number right arithmetically by a specified number of bits.
|}}

{{API table/row
|[[bit.blogic_rshift]]({{type|number}} n, {{type|number}} bits)|{{type|number}} value
|Shifts a number right logically by a specified number of bits.
|odd}}

{{API table/row
|[[bit.bxor]]({{type|number}} m, {{type|number}} n)|{{type|number}} value
|Computes the bitwise exclusive OR of two numbers.
|}}

{{API table/row
|[[bit.bor]]({{type|number}} m, {{type|number}} n)|{{type|number}} value
|Computes the bitwise inclusive OR of two numbers.
|odd}}

{{API table/row
|[[bit.band]]({{type|number}} m, {{type|number}} n)|{{type|number}} value
|Computes the bitwise AND of two numbers.
|}}

{{API table/row
|[[bit.bnot]]({{type|number}} n)|{{type|number}} value
|Computes the bitwise NOT of a number.
|odd}}

}}

= Deprecated Functions =
{{Deprecated
|plural=yes
|type=These functions
}}

{{API table|Bit|image=Grid disk.png|2=

{{API table/row
|[[bit.tobits]]({{type|number}} n)|{{type|table}} bit_tbl
|Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values.
|odd}}

{{API table/row
|[[bit.tonumb]]({{type|table}} bit_tbl)|{{type|number}} value
|Converts an array (numerically-indexed table) of 0 and 1 values representing a number in binary into that number.
|odd}}

}}

[[Category:APIs]]

Turtle.refuel

2013-06-04T14:50:12Z

SuicidalSTDz: Added integer tag and prettied up the arg description

{{lowercase}}
{{Function
|name=turtle.refuel
|args={{type|int}} amount of fuel items in current slot to consume
|api=turtle
|returns=[[boolean_(type)|boolean]] true if fuel, else false.
|addon=ComputerCraft
|desc=Fills the turtle with fuel.
|examples=
{{Example
|desc=Fills the turtle with fuel
|code=turtle.refuel( 4 )
|output=Tries to refuel with up to 4 items, returns true if it is a fuel and false if not.
}}
{{Example
|desc=Used in the command-line, the below code will tell the turtle to fuel itself using all inventory slots (1, 16)
|code=refuel all
|output=To complete
}}
}}

== Fuel Values ==
Fuel values for different items.

{| class="wikitable sortable"
! Item
! Movement gained
! Added by
|-
| Biofuel Can
| 520
| IndustrialCraft
|-
| Scrap
| 15
| IndustrialCraft
|-
| Coalfuel Can
| 1520
| IndustrialCraft
|-
| Wooden Scaffolding
| 15
| IndustrialCraft
|-
| Peat
| 80
| Forestry
|-
| Sugar Cane
| 0
| Vanilla
|-
| Wooden Tools
| 10
| Vanilla
|-
| Lava
| 1000
| Vanilla
|-
| Blaze Rod
| 120
| Vanilla
|-
| Wood Blocks
| 15
| Vanilla
|-
| Sticks
| 5
| Vanilla
|-
| Coal/Charcoal
| 80
| Vanilla
|-
| Mushroom Blocks
| 15
| Vanilla
|-
| Coal Coke
| 320
| Railcraft
|}

1.41:

The formula for calculating the movement gain from a fuel is "((fuel / 100) * 6)".
Where fuel is the items burn time in ticks in a regular furnace and "/" is integer division.

1.42+:

Formula changed to ((fuel * 6) / 100).
This will give more accurate movement values.

1.48:

Formula changed to ((fuel * 5) / 100)
== Trivia ==

[[Category:Lua_Core_Functions]]

Term.clear

2013-06-04T14:40:09Z

SuicidalSTDz: Cleaned up return value, code example description, and added a new example of possible uses with term.clear (there are no args for term.clear and by putting 'none' it could be misleading to new members)

{{lowercase}}
{{Function
|name=term.clear
|returns=[[nil]]
|api=term
|addon=ComputerCraft
|desc=Clears the screen
|examples=
{{Example
|desc=Clears any text on the console or monitor, also sets the cursor to position (1, 1) on the screen.
|code=term.clear() term.setCursorPos(1,1)
}}
{{Example
|desc=Turns the screen a specified colour
|code=term.setBackgroundColor(colors.blue) term.clear()
}}
}}

[[Category:API_Functions]]

Advanced Monitor

2013-06-04T06:01:03Z

SuicidalSTDz: Clarified damage value

{{Block
|name=Advanced Monitor
|image=Iso_Advanced_Monitor.png
|id=4094
|damage-value=Un-used
|is-peripheral=Yes
|peripheral-api=Term (API)
}}
The Advanced Monitor is a new, improved version of the [[Monitor]].

In contrast with the standard [[Monitor]], the Advanced Monitor has the ability to show colored text and programs on the screen, and the Advanced Monitor is golden (like the [[Advanced Computer]]), rather than the default stone grey color of the standard [[Monitor]].

For a list of the available colors on both [[Advanced Computer|Advanced Computers]] and the [[Advanced Monitor|Advanced Monitors]], see [[Colors_(API)#Colors|Colors API]].

==Recipe==
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=glass_pane |C2=Gold_Ingot
|A3=Gold_Ingot |B3=Gold_Ingot |C3=Gold_Ingot
|Output=Advanced_Monitor |OA=4
}}

==Using an Advanced Monitor==
The Advanced Monitor behaves exactly the same as the standard [[Monitor]] - except the Advanced Monitor is able to render text with a foreground and background [[Colors (API)#color|color]].

The Advanced Monitor introduces two new methods: ''[[term.setTextColor|monitor.setTextColor]]([[colors (API)#colors|color]])'' and ''[[term.setBackgroundColor|monitor.setBackgroundColor]]([[colors (API)#colors|color]])''. These functions allow you to draw text with a specific foreground and background color. Please note that both spellings of the word color are accepted.

To use an Advanced Monitor, you need to either call a method directly using [[peripheral.call]](), or, wrap the monitor using the [[Peripheral_(API)|Peripheral API]]. Wrapped monitors provide all functions listed in the [[Term_(API)|Term API]], with the exception of [[Monitor.setTextScale|monitor.setTextScale(size)]], which is native to monitors only.

For this example, we have an Advanced Monitor connected to the top of our [[Computer]]:

-- Immediately invoke a method without wrapping
peripheral.call("top", "write", "Hello World!")

-- You can also "wrap" the peripheral side to a variable:
local monitor = peripheral.wrap("top")
monitor.write("Hello World!")

{{BlocksItemsList}}
[[Category:Blocks]]

Printer.getPaperLevel

2013-06-03T21:10:58Z

SuicidalSTDz: Fixed integer tag and added a better description for returned value

{{lowercase}}
{{Function
|name=printer.getPaperLevel
|args=none
|returns=[[int (type)|int]] the amount of paper in the printer
|api=printer
|addon=ComputerCraft
|desc=Returns the total amount of paper in the printer.
|examples=
{{Example
|desc=Prints paper level
|code=print(printer.getPaperLevel())
}}
}}

[[Category:Lua_Core_Functions]]

Os.time

2013-06-03T21:05:10Z

SuicidalSTDz: Added float tag

{{lowercase}}
{{Function
|name=os.time
|returns=[[Float_(type)|float]] The current in-game time.
|api=OS
|addon=ComputerCraft
|desc=Returns the current in-game time.
|examples=
{{Example
|desc=Prints current time in 12 hour format (with AM and PM).
|code=local time = os.time() time = textutils.formatTime(time, false) print("The time is "..time)
}}
{{Example
|desc=Prints current time in 24 hour format.
|code=local time = os.time() time = textutils.formatTime(time, true) print("The time is "..time)
}}
|notes=
* You must use textutils.formatTime() if you want to print the time in readable form.
}}

[[Category:Lua_Core_Functions]]

Os.day

2013-06-03T20:58:58Z

SuicidalSTDz: Added integer tag

{{lowercase}}
{{Function
|name=os.day
|returns=[[int (type)|int]] The current in-game day.
|api=OS
|addon=ComputerCraft
|desc=Returns the current in-game day.
|examples=
{{Example
|desc=Prints current day.
|code=local day = os.day() print(day)
}}
}}
[[Category:Lua_Core_Functions]]

Printer.getPageSize

2013-06-03T20:55:54Z

SuicidalSTDz: Added integer tag

{{lowercase}}
{{Function
|name=printer.getPageSize
|returns=[[int (type)|int]] Width and Height of the Page in the Printer
|api=printer
|addon=ComputerCraft
|desc=Returns the size of the page.
|examples=
{{Example
|desc=Prints the size of a page.
|code=local x, y = printer.getPageSize() print(x ..", ".. y)
|output=<width>, <height>
}}
}}

[[Category:Lua_Core_Functions]]

Term.getSize

2013-06-03T20:51:33Z

SuicidalSTDz: Added integer tag

{{lowercase}}
{{Function
|name=term.getSize
|returns=[[int (type)|int]] the width and height of the terminal window.
|api=term
|addon=ComputerCraft
|desc=Returns the width and height of the terminal window.
|examples=
{{Example
|desc=Sets the cursor position to the edge of the terminal window.
|code=local w, h = term.getSize() term.setCursorPos(w,1)
}}
}}

[[Category:API_Functions]]

Term.isColor

2013-06-03T20:43:24Z

SuicidalSTDz: Added boolean tag

{{lowercase}}
{{Function
|name=term.isColor
|returns=[[boolean_(type)|boolean]] returns true if it's an advanced computer.
|api=term
|addon=ComputerCraft
|desc=Returns true if it's an advanced computer.
|examples=
{{Example
|desc=This program verifies if the computer can display colors. If it can, the computer clears the screen and changes the background to lime, otherwise, it turns computer off.
|code=local isAdvanced = term.isColor and term.isColor() if isAdvanced then term.setBackgroundColor(colors.lime) term.clear() else os.shutdown() end
}}
}}

[[Category:API_Functions]]

Turtle.suck

2013-06-03T20:38:41Z

SuicidalSTDz: Added boolean tag

{{lowercase}}
{{Function
|name=turtle.suck
|args=
|returns=[[boolean_(type)|boolean]] true if at least one item was moved into the turtle's inventory; false otherwise.
|api=turtle
|addon=ComputerCraft
|desc=If an item is in the square directly in front of the turtle, it picks up one of those items.
If a chest is in the square directly in front of the turtle, it picks up the items from the first non-empty slot, moving from top left to bottom right.
The items are moved into the currently selected slot, if there is room.
If the currently selected slot is filled up before all of the items are picked up, the remaining items are put in the next available slot.
If the currently selected slot is 16, it will loop around and try slot 1, and so on.

|examples=
{{Example
|desc=Picks up some items.
|code=turtle.suck()
}}
}}

[[Category:Lua_Core_Functions]]

Turtle.compareUp

2013-06-03T20:20:10Z

SuicidalSTDz: Added a better description for returned value

{{lowercase}}
{{Function
|name=turtle.compareUp
|args=
|api=turtle
|returns=[[boolean_(type)|boolean]] returns true if the block above the turtle is the same as the one in the selected slot, false otherwise
|addon=ComputerCraft
|desc=Detects if the block in above is the same as the one in the selected Slot.
|examples=
{{Example
|desc=Detects if the block above is the same as the one in the selected Slot.
|code=turtle.compareUp()
}}
}}

[[Category:Lua_Core_Functions]]

Turtle.refuel

2013-04-08T15:45:50Z

SuicidalSTDz:

{{lowercase}}
{{Function
|name=turtle.refuel
|args=count
|api=turtle
|returns=[[boolean_(type)|boolean]] true if fuel, else false.
|addon=ComputerCraft
|desc=Fills the turtle with fuel.
|examples=
{{Example
|desc=Fills the turtle with fuel
|code=turtle.refuel( 4 )
|output=Tries to refuel with up to 4 items, returns true if it is a fuel and false if not.
}}
{{Example
|desc=Used in the command-line, the below code will tell the turtle to fuel itself using all inventory slots (1, 16)
|code=refuel all
|output=To complete
}}
}}

== Fuel Values ==
Fuel values for different items.

{| class="wikitable sortable"
! Item
! Movement gained
! Added by
|-
| Biofuel Can
| 520
| IndustrialCraft
|-
| Scrap
| 15
| IndustrialCraft
|-
| Coalfuel Can
| 1520
| IndustrialCraft
|-
| Wooden Scaffolding
| 15
| IndustrialCraft
|-
| Peat
| 80
| Forestry
|-
| Sugar Cane
| 0
| Vanilla
|-
| Wooden Tools
| 10
| Vanilla
|-
| Lava
| 1000
| Vanilla
|-
| Blaze Rod
| 120
| Vanilla
|-
| Wood Blocks
| 15
| Vanilla
|-
| Sticks
| 5
| Vanilla
|-
| Coal/Charcoal
| 80
| Vanilla
|-
| Mushroom Blocks
| 15
| Vanilla
|-
| Coal Coke
| 320
| Railcraft
|}

1.41:

The formula for calculating the movement gain from a fuel is "((fuel / 100) * 6)".
Where fuel is the items burn time in ticks in a regular furnace and "/" is integer division.

1.42+:

Formula changed to ((fuel * 6) / 100).
This will give more accurate movement values.

1.48:

Formula changed to ((fuel * 5) / 100)
== Trivia ==

[[Category:Lua_Core_Functions]]

Turtle.refuel

2013-04-08T15:44:28Z

SuicidalSTDz: Added a command-line example of turtle.refuel since users are clueless about it's existance

{{lowercase}}
{{Function
|name=turtle.refuel
|args=count
|api=turtle
|returns=[[boolean_(type)|boolean]] true if fuel, else false.
|addon=ComputerCraft
|desc=Fills the turtle with fuel.
|examples=
{{Example
|desc=Fills the turtle with fuel
|code=turtle.refuel( 4 )
|output=Tries to refuel with up to 4 items, returns true if it is a fuel and false if not.
}}
{{Example
|desc=Fuels itself using all inventory slots (1, 16)
|code=refuel all
|output=To complete
}}
}}

== Fuel Values ==
Fuel values for different items.

{| class="wikitable sortable"
! Item
! Movement gained
! Added by
|-
| Biofuel Can
| 520
| IndustrialCraft
|-
| Scrap
| 15
| IndustrialCraft
|-
| Coalfuel Can
| 1520
| IndustrialCraft
|-
| Wooden Scaffolding
| 15
| IndustrialCraft
|-
| Peat
| 80
| Forestry
|-
| Sugar Cane
| 0
| Vanilla
|-
| Wooden Tools
| 10
| Vanilla
|-
| Lava
| 1000
| Vanilla
|-
| Blaze Rod
| 120
| Vanilla
|-
| Wood Blocks
| 15
| Vanilla
|-
| Sticks
| 5
| Vanilla
|-
| Coal/Charcoal
| 80
| Vanilla
|-
| Mushroom Blocks
| 15
| Vanilla
|-
| Coal Coke
| 320
| Railcraft
|}

1.41:

The formula for calculating the movement gain from a fuel is "((fuel / 100) * 6)".
Where fuel is the items burn time in ticks in a regular furnace and "/" is integer division.

1.42+:

Formula changed to ((fuel * 6) / 100).
This will give more accurate movement values.

1.48:

Formula changed to ((fuel * 5) / 100)
== Trivia ==

[[Category:Lua_Core_Functions]]

Paintutils (API)

2013-03-29T16:40:17Z

SuicidalSTDz: Function pages are all added

{{NeedsWork|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}

Paintutils is an API to draw and load images

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Paintutils (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]](path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]](image, x, y)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (x, y) where image is an image object.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]](x, y, colour)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (x, y) in the colour specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]](startX, startY, endX, endY, colour)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (startX, startY) to (endX, endY) in the colour specified.</td></tr>

</table>

[[Category:APIs]]

Os.pullEvent

2013-03-29T16:23:28Z

SuicidalSTDz: Added an example of os.pullEvent as a function iterator in for loops

{{lowercase}}
{{Function
|name=os.pullEvent
|args=[{{type|string}} filter]
|api=OS
|returns={{type|string}} event, variable parameters(see table below)
|addon=ComputerCraft
|desc=Waits (yields) until an event occurs
|examples=
{{Example
|desc=The program requires to wait for a keypress to do something:
|code=[[Function (type)|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!")
[[os.sleep|sleep]] (1.5) -- I don't like a whole 2 seconds but 1 second is too short
end
end
}}
{{Example
|desc=This script shows how the os.pullEvent function can be used as an iterator instead of using a while loop:
|code=for event, param1 in os.pullEvent do --this will continuously fire an event without the use of a while loop
[[print]]("Event: "..event)
[[print]]("Param1: "..param1)
end
[[User:SuicidalSTDz|SuicidalSTDz]] 20:23, 29 March 2013 (MSK)
}}
}}

=== Common syntax ===

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

Note: This is one of the most commonly used functions that can return multiple values.
It works like any other function call (such as "input = read()") except that you can get more than one piece of information back.

== How it works ==
When os.pullEvent() is called, the computer waits until an event occurs.
Events can be triggered by several different things, such as a key being pressed or a redstone input changing.
They are usually triggered by ComputerCraft itself, when it needs to notify the computer that something happened.
They can also be triggered by peripherals, or by your program calling [[os.queueEvent]].

More complicated input, such as "the user typing a line of text," does ''not'' correspond to an event.
[[read]] handles this inside itself by waiting for the user to press a key, then updating the screen, moving the cursor, etc.

Events have a type (which is a string) and 0-5 parameters (which are often but not always strings).
No built-in events use more than 3 parameters.

When an event occurs, the event type, followed by the parameters, will be returned. If you have:

event, button, x, y = os.pullEvent()

and the user clicks the mouse at coordinates 5,4 then:
* event will be set to "mouse_click" (the event type)
* button will be set to 0 (the first parameter)
* x will be set to 5 (the second parameter)
* y will be set to 4 (the third parameter)

Note that in this example, we didn't specify a filter. If you specify a filter, then all events of different types will be ignored.
If the user inserts a disk, instead of clicking the mouse, then event will be "disk", button will be the side the disk drive is on, and x and y will be nil.

If we wanted to only wait for mouse clicks we could use:

event, button, x, y = os.pullEvent("mouse_click")

which will ignore any events that are not mouse clicks.

If you assign more variables than necessary, the extra ones will be set to nil.
If you assign fewer variables than necessary, the extra parameters will be discarded.

==Event types==
{| class="wikitable" width="100%"
! rowspan="2" | Name
! rowspan="2" | Description
! colspan="3" | Parameters
|-
! 1 !! 2 !! 3
|-
! scope="row" | [[char (event)|char]]
|Fired when text is typed on the keyboard
| {{type|string}} the letter typed
|
|
|-
! scope="row" | [[key (event)|key]]
|Fired when a key is pressed on the keyboard
|{{type|number}} numerical keycode
|
|
|-
! scope="row" | [[timer (event)|timer]]
|Fired when a timeout started by [[os.startTimer]]() completes
|{{type|number}} Value of the timer as returned by os.startTimer()
|
|
|-
! scope="row" | [[alarm (event)|alarm]]
|Fired when a time passed to [[os.setAlarm]]() is reached
|{{type|number}} Value of the alarm as returned by os.setAlarm()
|
|
|-
! scope="row" | [[redstone (event)|redstone]]
|Fired when the state of any of the redstone inputs change
|
|
|
|-
! scope="row" | [[terminate (event)|terminate]]
|Fired when a combination of keys CTRL and T is pressed and held for three seconds.
You will not normally see this event, as it is handled inside os.pullEvent.
|
|
|
|-
! scope="row" | [[disk (event)|disk]]
|Fired when a disk is inserted into an adjacent disk drive
|{{type|string}} side
|
|
|-
! scope="row" | [[disk_eject (event)|disk_eject]]
|Fired when a disk is removed from an adjacent disk drive
|{{type|string}} side
|
|
|-
! scope="row" | [[peripheral (event)|peripheral]]
|Fired when peripheral is attached
|{{type|string}} side
|
|
|-
! scope="row" | [[peripheral_detach (event)| peripheral_detach]]
|Fired when peripheral is removed
|{{type|string}} side
|
|
|-
! scope="row" | [[rednet_message (event)|rednet_message]]
|Fired when a rednet message is received from the [[Rednet_(API)|rednet API]]
|{{type|number}} senderID
|{{type|string}} message
|{{type|number}} distance travelled
|-
! scope="row" | [[http_success (event)|http_success]]
|Fired when an attempt to receive text from / post text on a website is successful.
You will not normally see this event as it is handled inside http.get.
|{{type|string}} url of the site
|{{type|table}} text on the site
|
|-
! scope="row" | [[http_failure (event)|http_failure]]
|Fired when an attempt to receive text from / post text on a website is unsuccessful
You will not normally see this event as it is handled inside http.get.
|{{type|string}} url of the site
|
|
|-
! scope="row" | [[mouse_click (event)|mouse_click]]
|Fired when a mouse button is pressed
|{{type|number}} mouse button
|{{type|number}} x coordinate
|{{type|number}} y coordinate
|-
! scope="row" | [[mouse_scroll (event)|mouse_scroll]]
|Fired when a mousewheel is scrolled.
|{{type|number}} scroll direction (-1 for up, 1 for down)
|{{type|number}} x coordinate(in screen chars)
|{{type|number}} y coordinate(in screen chars)
|-
! scope="row" | [[mouse_drag (event)|mouse_drag]]
|Fired when the mouse is moved after clicking.
|{{type|number}} mouse button
|{{type|number}} x coordinate(in screen chars)
|{{type|number}} y coordinate(in screen chars)
|-
! scope="row" | [[monitor_touch (event)|monitor_touch]]
|Fired when a player right click on an advanced monitor connected.
|{{type|string}} side
|{{type|number}} x coordinate(in screen chars)
|{{type|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()'']

[[Category:Lua_Core_Functions]]

Shell.aliases

2013-03-29T13:15:14Z

SuicidalSTDz:

{{lowercase}}
{{Function
|name=shell.aliases
|api=Shell
|returns=A table containing default and set aliases.
|addon=ComputerCraft
|desc=Returns a table containing the default aliases and user specified aliases
|examples=
{{Example
|desc=This code will return all set aliases
|code= for k,v in pairs(shell.aliases()) do print(v) end
}}
}}

[[Category:API_Functions]]

Shell.aliases

2013-03-29T13:12:53Z

SuicidalSTDz:

Shell.aliases

2013-03-29T13:09:27Z

SuicidalSTDz: Created page with "{{lowercase}} {{Function |name=shell.aliases |args=string path |api=Shell |returns=A table containing default and set aliases. If a path is specified, it will return a tab..."

{{lowercase}}
{{Function
|name=shell.aliases
|args=[[string]] path
|api=Shell
|returns=A table containing default and set aliases. If a path is specified, it will return a table in which all the contents are part of that specific api/path
|addon=ComputerCraft
|desc=Returns a table containing the default aliases and user specified aliases
|examples=
{{Example
|desc=This code will define a path, 'fs', for shell.aliases to use. This wll return all functions relating to the 'fs' api
|code= for k,v in pairs(shell.aliases("fs")) do print(v) end
}}
}}
[[Category:API_Functions]]

Timer (event)

2013-03-29T12:40:34Z

SuicidalSTDz: May need more work

{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 16:11, 30 November 2012 (MSK)''}}

{{Event
|name=timer
|desc=Fired when a timer completes.
|return1=The timer's numerical representation value (returned when [[os.startTimer|os.startTimer()]] is initially called).
}}
{{Example
|desc=This code will continuously start an internal timer and fire an event. If the event is not the timer, then it will break the loop
|code= while true do os.startTimer(1) event = os.pullEvent() if event == "timer" then print("Too slow!") else print("Darn, you beat me!") break end end
}}

Paintutils.drawLine

2013-03-29T12:07:11Z

SuicidalSTDz:

{{lowercase}}
{{Function
|name=paintutils.drawLine
|args=[[int (type)|int]] startX, [[int (type)|int]] startY, [[int (type)|int]] endX, [[int (type)|int]] endY, [[colour (API)|colour]] colour
|api=paintutils
|returns=To complete
|addon=ComputerCraft
|desc=Draw a line on the screen from (startX startY) to (endX endY)
|examples=
{{Example
|desc=This code will draw a red line from the position (1, 2) to the position (3, 4)
|code=line = [[paintutils.drawLine]](1, 2, 3, 4, [[colour (API)|colour]].red)
}}
}}

[[Category:API_Functions]]

Paintutils.drawLine

2013-03-29T12:05:43Z

SuicidalSTDz: Created page with "{{lowercase}} {{Function |name=paintutils.drawLine |args=int startX, int startY, int endX, int endY, [[colour (AP..."

{{lowercase}}
{{Function
|name=paintutils.drawLine
|args=[[int (type)|int]] startX, [[int (type)|int]] startY, [[int (type)|int]] endX, [[int (type)|int]] endY, [[colour (API)|colour]] colour
|api=paintutils
|returns=To complete
|addon=ComputerCraft
|desc=Draw a line on the screen from (startX startY) to (endX endY)
|examples=
{{Example
|desc=This code will draw a red line from the position (1,2) to the position (2,4)
|code=line = [[paintutils.drawLine]](1, 2, 2, 4, [[colour (API)|colour]].red)
}}
}}

[[Category:API_Functions]]