ComputerCraft Wiki - User contributions [en]

ComputerCraft Wiki:Autoconfirmed users

2012-03-24T16:48:05Z

AyrA: Created the Page

This is a Group containing Users, that confirmed their E-Mail Address

OS (API)

2012-03-24T16:46:40Z

AyrA: added Links

''You may be looking for alternative OS's for ComputerCraft. If so, go to the [[list of oses|list of OSes]].''

The Operating System API allows for interfacing with the Lua based Operating System itself.
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[os.version()]]
|Returns the version of the OS the computer is running.
|-
|[[os.computerID()]]
|Returns the unique ID of this computer.
|-
|[[os.run( environment, programpath, arguments )]]
|An advanced way of starting programs. A started program will have a given
Environment 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.
|-
|[[#api|os.loadAPI( name )]]
|Loads a lua script as an API, making it available to all programs.
|-
|[[#api|os.unloadAPI( name )]]
|Unloads a previously loaded API.
|-
|[[#pullEvent|os.pullEvent()]]
|Blocks until the computer has detected an event, then returns the event.
|-
|[[#pullEvent|os.pullEventRaw()]]
|Advanced version of pullEvent().
|-
|[[os.queueEvent()]]
|<no description given>
|-
|[[os.clock()]]
|Returns CPU time.
|-
|[[os.startTimer( timeout )]]
|Queues an event to be triggered after a number of seconds.
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.
|-
|[[os.sleep( timeout )]]
|Makes the system wait a number of seconds before continuing in the program.
May also be used as simply "sleep( timeout )".
|-
|[[os.time()]]
|Returns the current Minecraft world time.
|-
|[[os.setAlarm( time )]]
|Queues an event to be triggered at the specific Minecraft world time.
|-
|[[os.shutdown()]]
|Turns off the computer.
|-
|[[os.reboot()]]
|Reboots the computer.
|}

== <div id="api">API</div> ==

API are programs which are loaded in to the OS itself, and expose functions
which other programs may use. The stock [[Category:APIs|APIs that ship with
ComputerCraft]] are loaded in this way, and may be replaced by a computer's
user or programs.

== <div id="pullEvent">os.pullEvent()</div> ==

os.pullEvent() causes the current program to pause, retrieving the next event
from the computer's queue of events. If there is no event to read, then the
program will stall until such an event becomes available. Note that if a
program has not attempted to pull an event in the past ten seconds, it will
be forcefully terminated to prevent CPU waste in SMP environments.

pullEvent returns the name of the event that was read, as well as up to
five parameters:

<code>
local event, p1, p2, p3, p4, p5 = os.pullEvent()
</code>

os.pullEvent() is usually run inside a 'while true do' loop.

An advanced version of this method <code>os.pullEventRaw</code> bypasses the
normal handling of events from the OS. You may use this to act on the
"Terminate" event (triggered when holding Ctrl-T) for custom termination logic.

[[Category:APIs]]

Rednet.broadcast

2012-03-24T16:43:57Z

AyrA: Created the Page

{{lowercase}}
{{Function
|name=rednet.broadcast
|args=[[string]] message
|returns=[[boolean]] success code. True if a message has been sent, false if not. "true" does not guarantee, that any computer was reachable!
|api=rednet
|addon=ComputerCraft
|desc=Sends a message to all Computer in Range. (see [[rednet.send( receiverID, message )]] and [[rednet.receive( timeout )]].
|examples=
{{Example
|desc=Sends a Message to all Computers (assuming a modem is attached and open)
|code=rednet.broadcast("ComputerCraft")
}}
}}

Rednet.send

2012-03-24T16:40:56Z

AyrA: Created the Page

{{lowercase}}
{{Function
|name=rednet.send
|args=[[int]] receiverID, [[string]] message
|returns=[[boolean]] success code. True if a message has been sent, false if not. "true" does not guarantee, that the destination was reachable!
|api=rednet
|addon=ComputerCraft
|desc=Sends a message to a Computer. (see [[rednet.broadcast( message )]] and [[rednet.receive( timeout )]]. To get the id from a computer see [[os.computerID()]].
|examples=
{{Example
|desc=Sends a Message to the Computer with the ID 22 (assuming a modem is attached and open)
|code=rednet.send(22,"ComputerCraft")
}}
}}

Os.computerID

2012-03-24T16:33:20Z

AyrA:

{{lowercase}}
{{Function
|name=os.computerID
|returns=the ID of the Computer
|api=os
|addon=ComputerCraft
|desc=returns the ID of the computer this command is executed on.
|examples=
{{Example
|desc=prints the Computer ID
|code=term.write(os.computerID())
}}
}}

Os.computerID

2012-03-24T16:33:05Z

AyrA:

{{lowercase}}
{{Function
|name=os.computerID()
|returns=the ID of the Computer
|api=os
|addon=ComputerCraft
|desc=returns the ID of the computer this command is executed on.
|examples=
{{Example
|desc=prints the Computer ID
|code=term.write(os.computerID())
}}
}}

Os.computerID

2012-03-24T16:32:42Z

AyrA: Created the Page

{{lowercase}}
{{Function
|name=os.computerID()
|args=none
|returns=the ID of the Computer
|api=os
|addon=ComputerCraft
|desc=returns the ID of the computer this command is executed on.
|examples=
{{Example
|desc=prints the Computer ID
|code=term.write(os.computerID())
}}
}}

Rednet.receive

2012-03-24T16:29:01Z

AyrA:

{{lowercase}}
{{Function
|name=rednet.receive( timeout )
|args=A number representing the seconds to wait or leave empty to wait unlimited
|returns=a tuple where the first value is the sending computers id and the second the message string
|api=rednet
|addon=ComputerCraft
|desc=Waits till timeout or another computer send a message to this computer. (see [[rednet.broadcast( message )]] and [[rednet.send( receiverID, message )]]. To get the id from a computer see [[os.computerID()]]. In case a Timeout occurs the return id and message are set to nil
|examples=
{{Example
|desc=waits unlimited till someone sends a message to this computer and displays it
|code=senderId, message = rednet.receive()term.write(message)
}}
}}