OS (API) - Revision history

Lyqyd: add cancelTimer and cancelAlarm calls.

2015-01-04T06:54:17Z

add cancelTimer and cancelAlarm calls.

MKlegoman357: Fixed/Added links

2014-06-03T22:28:17Z

Fixed/Added links

MKlegoman357: Linked 'os.loadAPI' to its page

2014-06-03T21:06:54Z

Linked 'os.loadAPI' to its page

Oeed: Relinked os.pullEventRaw to it's own page

2014-03-24T20:38:22Z

Relinked os.pullEventRaw to it's own page

LBPHacker: os.pullEvenRaw accepts the target-event parameter, just like os.pullEvent.

2014-01-05T11:29:52Z

os.pullEvenRaw accepts the target-event parameter, just like os.pullEvent.

Immibis: fixed caps

2013-09-14T21:45:36Z

fixed caps

Immibis: use API table template

2013-09-14T21:45:08Z

use API table template

Show changes

Watcher7: Changed nonexistent type int to type number. Changed nonexistent type float to type number. Fixed inconsistent spacing of parentheses around arguments.

2013-07-12T02:05:01Z

Changed nonexistent type int to type number. Changed nonexistent type float to type number. Fixed inconsistent spacing of parentheses around arguments.

Cranium: Undo revision 5679 by Cranium (talk)

2013-05-22T10:15:23Z

Undo revision 5679 by Cranium (talk)

Cranium: Changed int to number

2013-05-22T10:07:28Z

Changed int to number

@@ Line 65: / Line 65: @@
 |[[os.startTimer]]({{Type|number}} timeout)|{{type|number}} timerID
 |Queues an event to be triggered after a number of seconds (<var>timeout</var>). The ID of the timer is returned from this function to differentiate multiple timers. Timers are one-shot; once they have fired an event you will need to start another one if you need a recurring timer.
 |}}
@@ Line 85: / Line 90: @@
 |[[os.setAlarm]]({{type|number}} time)|{{type|number}} alarmID
 |Queues an event to be triggered at the specified in-game <var>time</var>.
 |}}

@@ Line 2: / Line 2: @@
-{{API table|Os|image=Grid disk.png|2=
+{{API table|OS|image=Grid disk.png|2=
 {{API table/row
@@ Line 15: / Line 15: @@
 {{API table/row
-|[[os.getComputerLabel]]()|{{type|string}} label
+|[[os.getComputerLabel]]()|{{type|string}}/{{type|nil}} label
-|Returns the label of this computer. [[os.computerLabel]]() also behaves exactly the same as [[os.getComputerLabel]](). <!-- what does it return if there's no label? -->
+|Returns the label of this computer. [[os.computerLabel]]() also behaves exactly the same as [[os.getComputerLabel]]().
 |odd}}
 {{API table/row
-|[[os.setComputerLabel]]({{type|string}} label)|{{type|nil}}
+|[[os.setComputerLabel]]({{type|string}}/{{type|nil}} label)|{{type|nil}}
 |Set the label of this computer.
 |}}
 {{API table/row
-|[[os.run]]({{type|table}} environment, {{type|string}} program path [, {{type|string}} arguments])|{{type|nil}}
+|[[os.run]]({{type|table}} environment, {{type|string}} programPath [, {{type|string}} arguments])
 |An advanced way of starting programs. A started program will have a given <var>environment</var> table which determines what functions it has available, as well as any variables it will be able to access by default. You may prefer to use the [[Shell (API)]] unless you need to do something special.
 |odd}}
 {{API table/row
-|[[os.loadAPI]]({{type|string}} name)
+|[[os.loadAPI]]({{type|string}} path)
 |{{type|boolean}} success
 |Loads a Lua script as an API in its own namespace. It will be available to '''all''' programs that run on the terminal.}}
 {{API table/row
-|[[#APIs|os.unloadAPI]]({{type|string}} name)|{{type|nil}}
+|[[os.unloadAPI]]({{type|string}} name)|{{type|nil}}
 |Unloads a previously loaded API.
 |odd}}
 {{API table/row
-|[[os.pullEvent]]({{type|string}}/{{type|nil}} target-event)|any
+|[[os.pullEvent]]([<nowiki/>{{type|string}} target-event])
-|Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[Os.pullEvent|os.pullEvent]](target-event) returns the event and any parameters the event may have. If a <var>target-event</var> is specified, the computer will not break for any other events (except termination).
+|{{type|string}} event, param1, param2, ...
 |}}
 {{API table/row
-|[[os.pullEventRaw]]({{type|string}}/{{type|nil}} target-event)|any
+|[[os.pullEventRaw]]([<nowiki/>{{type|string}} target-event])
-|Advanced version of pullEvent(). Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[os.pullEventRaw|os.pullEventRaw]](target-event) returns the event and any parameters the event may have. Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not raise an error if a 'terminate' event is received.
+|{{type|string}} event, param1, param2, ...
 |odd}}
 {{API table/row
 |[[os.queueEvent]]({{type|string}} event, param1, param2, ...)|{{type|nil}}
-|Adds an event to the event queue with the name <var>event</var> and the given parameters
+|Adds an event to the event queue with the name <var>event</var> and the given parameters.
 |}}
 {{API table/row
 |[[os.clock]]()|{{type|number}} time
-|Returns the amount of time since the computer was started.
+|Returns the amount of time since the in-game computer was started.
 |odd}}
@@ Line 76: / Line 79: @@
 {{API table/row
 |[[os.day]]()|{{type|number}} day
-|Return the current in-game day (the number of days since the world was created).
+|Return the current in-game day (the number of in-game days since the world was created).
 |odd}}

@@ Line 30: / Line 30: @@
 {{API table/row
-|[[#APIs|os.loadAPI]]({{type|string}} name)|{{type|nil}}
+|[[os.loadAPI]]({{type|string}} name)
-|Loads a Lua script as an API in its own namespace (see example). It will be available to '''all''' programs that run on the terminal.
+|{{type|boolean}} success
-|}}
+|Loads a Lua script as an API in its own namespace. It will be available to '''all''' programs that run on the terminal.}}
 {{API table/row
@@ Line 40: / Line 40: @@
 {{API table/row
-|[[Os.pullEvent|os.pullEvent]]({{type|string}}/{{type|nil}} target-event)|any
+|[[os.pullEvent]]({{type|string}}/{{type|nil}} target-event)|any
 |Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[Os.pullEvent|os.pullEvent]](target-event) returns the event and any parameters the event may have. If a <var>target-event</var> is specified, the computer will not break for any other events (except termination).
 |}}
 {{API table/row
-|[[os.pullEventRaw|os.pullEventRaw]]({{type|string}}/{{type|nil}} target-event)|any
+|[[os.pullEventRaw]]({{type|string}}/{{type|nil}} target-event)|any
 |Advanced version of pullEvent(). Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[os.pullEventRaw|os.pullEventRaw]](target-event) returns the event and any parameters the event may have. Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not raise an error if a 'terminate' event is received.
 |odd}}

@@ Line 45: / Line 45: @@
 {{API table/row
-|[[#pullEvent|os.pullEventRaw]]({{type|string}}/{{type|nil}} target-event)|any
+|[[os.pullEventRaw|os.pullEventRaw]]({{type|string}}/{{type|nil}} target-event)|any
-|Advanced version of pullEvent(). Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[#pullEvent|os.pullEventRaw]](target-event) returns the event and any parameters the event may have. Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not raise an error if a 'terminate' event is received.
+|Advanced version of pullEvent(). Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[os.pullEventRaw|os.pullEventRaw]](target-event) returns the event and any parameters the event may have. Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not raise an error if a 'terminate' event is received.
 |odd}}

@@ Line 45: / Line 45: @@
 {{API table/row
-|[[#pullEvent|os.pullEventRaw]]()|any
+|[[#pullEvent|os.pullEventRaw]]({{type|string}}/{{type|nil}} target-event)|any
-|Advanced version of pullEvent(). [[#pullEvent|os.pullEventRaw]]() will block until an event occurs, and then returns the event (any any parameters the event may have). Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not raise an error if a 'terminate' event is received.
+|Advanced version of pullEvent(). Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[#pullEvent|os.pullEventRaw]](target-event) returns the event and any parameters the event may have. Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not raise an error if a 'terminate' event is received.
 |odd}}

@@ Line 10: / Line 10: @@
 {{API table/row
-|[[os.getComputerId]]()|{{type|number}} id
+|[[os.getComputerID]]()|{{type|number}} id
 |Returns the unique ID of this computer. [[os.computerID]]() also behaves exactly the same as [[os.getComputerID]]().
 |}}

@@ Line 18: / Line 18: @@
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the label of this computer. [[os.computerLabel]]() also behaves exactly the same as [[os.getComputerLabel]]().</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.setComputerLabel]]( {{type|string}} label )</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.setComputerLabel]]({{type|string}} label)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Set the label of this computer.</td></tr>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.run]]( {{type|table}} environment, {{type|string}} program path [, {{type|string}} arguments] )</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.run]]({{type|table}} environment, {{type|string}} program path [, {{type|string}} arguments])</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">An advanced way of starting programs. A started program will have a given <var>environment</var> table which determines what functions it has available, as well as any variables it will be able to access by default. You may prefer to use the [[Shell (API)]] unless you need to do something special.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#APIs|os.loadAPI]]( {{type|string}} name )</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#APIs|os.loadAPI]]({{type|string}} name)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Loads a Lua script as an API in its own namespace (see example). It will be available to '''all''' programs that run on the terminal.</td></tr>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#APIs|os.unloadAPI]]( {{type|string}} name )</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#APIs|os.unloadAPI]]({{type|string}} name)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Unloads a previously loaded API.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Os.pullEvent|os.pullEvent]]( {{type|string}} target-event )</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Os.pullEvent|os.pullEvent]]({{type|string}} target-event)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[Os.pullEvent|os.pullEvent]]( target-event ) returns the event and any parameters the event may have. If a <var>target-event</var> is specified, the computer will not break for any other events (except termination).</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[Os.pullEvent|os.pullEvent]](target-event) returns the event and any parameters the event may have. If a <var>target-event</var> is specified, the computer will not break for any other events (except termination).</td></tr>
 <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#pullEvent|os.pullEventRaw]]()</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Advanced version of pullEvent(). [[#pullEvent|os.pullEventRaw]]() will block until an event occurs, and then returns the event (any any parameters the event may have). Unlike [[Os.pullEvent|os.pullEvent]]( target-event ), this function will not break for system events, and can be used to handle termination events.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Advanced version of pullEvent(). [[#pullEvent|os.pullEventRaw]]() will block until an event occurs, and then returns the event (any any parameters the event may have). Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not break for system events, and can be used to handle termination events.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.queueEvent]]( {{type|string}} event, param1, param2, ... )</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.queueEvent]]({{type|string}} event, param1, param2, ...)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Adds an event to the event queue with the name <var>event</var> and the given parameters</td></tr>
@@ Line 42: / Line 42: @@
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns CPU time.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.startTimer]]( {{type|int}} timeout )</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.startTimer]]({{Type|number}} timeout)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Queues an event to be triggered after a number of seconds (<var>timeout</var>). The ID of the timer is returned from this function to differentiate multiple timers. Timers are one-shot; once they have fired an event you will need to start another one if you need a recurring timer.</td></tr>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.sleep]]( {{type|int}} timeout )</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.sleep]]({{Type|number}} timeout)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes the system wait a number of seconds before continuing in the program. [[os.sleep]]( timeout ) may also be used as simply "sleep( timeout )".</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes the system wait a number of seconds before continuing in the program. [[os.sleep]](timeout) may also be used as simply "sleep( timeout )".</td></tr>
 <tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.time]]()</td>
@@ Line 54: / Line 54: @@
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current Minecraft day.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.setAlarm]]( {{type|float}} time )</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.setAlarm]]({{Type|number}} time)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Queues an event to be triggered at the specified Minecraft world <var>time</var>.</td></tr>