ComputerCraft Wiki - User contributions [en]

Modem (API)

2014-05-18T15:47:17Z

Awsmazinggenius: typo, it said "bollean" instead of "boolean"

:''This page is for the modem API. For the blocks, see [[Modem]].''

{{PeripheralAPI}}

Modem channels are essentially networks which can be [[modem.open|opened]], [[modem.close|closed]] and [[modem_message_(event)|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)|Rednet API]].

This is not an actual API called "modem". This is the API for [[peripheral.wrap|wrapped]] modem peripherals.

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

{{API table/row
|[[modem.isOpen|''modem''.isOpen]]({{type|number}} channel)
|{{type|boolean}} isChannelOpen
|Checks to see if ''channel'' is open.
|odd}}

{{API table/row
|[[modem.open|''modem''.open]]({{type|number}} channel)
|{{type|nil}}
|Opens ''channel'' to allow for listening. The channel specified must be larger than 0 and less than 65535.}}

{{API table/row
|[[modem.close|''modem''.close]]({{type|number}} channel)
|{{type|nil}}
|Closes an open channel to disallow listening.
|odd}}

{{API table/row
|[[modem.closeAll|''modem''.closeAll]]()
|{{type|nil}}
|Closes all open channels.}}

{{API table/row
|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|string}} message)
|{{type|nil}}
|Transmits a message on the specified channel.
|odd}}

{{API table/row
|[[modem.isWireless|''modem''.isWireless]]()
|{{type|boolean}} isWireless
|Returns if the modem is wireless or wired.}}

}}

{{Event
|name=modem_message
|return1={{type|string}} modemSide
|return2={{type|number}} senderChannel
|return3={{type|number}} replyChannel
|return4={{type|string}} message
|return5={{type|number}} distance
|desc=Fired when a modem message is received.}}

==Sending Messages==
Sending messages is simple and does not require that you open any channels. Simply use the transmit function like so:
local modem = [[peripheral.wrap]]("right") --Wraps the modem on the right side.

[[modem.transmit]](3, 1, "Hello world!")
[[peripheral.call]]("right", "transmit", 3, 1, "This will also work!")

What did that do? First I wrapped the peripheral in order to interact with it. Second, I used [[modem.transmit]](channel, replyChannel, message) in order to send my message. In case you were wondering, the reply channel is captured by the listening computer and suggests which channel they should reply on.

==Receiving Messages==
Receiving messages requires that you be familiar with events. As of this moment, there is no API which cuts out events from the process. Here is an example of how to receive messages:
local modem = [[peripheral.wrap]]("left")
[[modem.open]](3)--Open channel 3 so that we can listen on it
local event, modemSide, senderChannel,
replyChannel, message, senderDistance = [[os.pullEvent]]("modem_message")

print("I just received a message from: "..senderChannel)
print("I should apparently reply on: "..replyChannel)
print("The modem receiving this is located on the "..modemSide.." side")
print("The message was: "..message)
print("The sender is: "..senderDistance.." blocks away from me.")

So what did I do? Quite simply, I called [[os.pullEvent]]() with the string argument "modem_message", which blocks all other events from being returned. When the "modem_message" event is captured, it returns the arguments: event, modemSide, senderChannel, replyChannel, message, senderDistance. I captured these and then printed them out.

== Modem Limitations ==
* You can only open 128 channels at any given time.
* The maximum channel you can open is 65535.
* You can listen on more than one channel at a time. For example, if the modem has channel 3 and channel 5 open, and somebody sends a message on channel 5, the modem will receive it. If a message is sent on channel 3, the modem will also receive the message.
* Sending messages does not require you to open any channels prior to sending it.
* If you aren't receiving a message when you think you should, check to make sure that you have opened the channel first.
* Modems and channels are not secure - if you are sending a message using the Modem API, messages are still available to any computer listening on the sent channel.

[[Category:Peripheral APIs]]

User:Awsmazinggenius

2014-03-28T22:58:02Z

Awsmazinggenius: Created page with "So yeah, I just made this page so I wouldn't be a red link. If I think of something useful, I'll put it here. ~~~~"

So yeah, I just made this page so I wouldn't be a red link. If I think of something useful, I'll put it here.
[[User:Awsmazinggenius|awsmazinggenius]] 22:58, 28 March 2014 (GMT)

Pocket Computer

2014-03-28T22:57:08Z

Awsmazinggenius: Replaced "right-click" with "use key" (people change their controls to weird things) and added a note about the default right-click.

{{Block
|name=Pocket Computer
|image=Pocket_Computer_Large.png
|id=31709
|damage-value=The ID of the Computer.
|is-peripheral=No
}}
Pocket Computers, added in 1.6, are computers than are held as an inventory item, allowing you to use them on the move. To use a Pocket Computer, hold it in your hand and press the "use" key (this is a right-click by default). Both advanced and standard versions are available. It is also possible to craft Pocket Computers with wireless modems built in, this allows you to control your machines from anywhere or even [http://www.computercraft.info/forums2/index.php?/topic/17614-ultimate-door-lock-pda-opened-doors/ open doors] for you without having to do anything! When removing from your inventory (dropping, moving in to chest, etc) the computer will stay on for 3-4 seconds. After that time it will turn it self off, you will not loose any data. The screen size of Pocket Computers is 26 wide by 20 high.

If the computer your program is running on is a Pocket Computer 'pocket' will be a blank table.
For example, to check if your program is running on Pocket Computer do:
if pocket then
print('Running on a Pocket Computer')
else
print('Running on a standard Computer')
end
[[Category:Items]]
[[Category:Consoles]]
== Recipes ==
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Golden_Apple |C2=Gold_Ingot
|A3=Gold_Ingot |B3=glass_pane |C3=Gold_Ingot
|Output=Advanced_Pocket_Computer
}}
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Golden Apple |C2=stone
|A3=stone |B3=glass_pane |C3=stone
|Output=Pocket_Computer
}}

Wireless Pocket Computers (inc. Advanced)
{{Crafting grid
|B1=Modem
|B2=Pocket_Computer
|Output=Pocket_Computer
}}
== Usage ==
Hold the Pocket Computer in your hands then right click. To turn it off type 'shutdown' in to the shell.

Pocket Computers also come with a special program, falling, a Tetris game by by GopherAtl.

Below is a ingame screen of a Pocket Computer.

[[File:Pocket_Computer_Screenshot.png]]

{{BlocksItemsList}}

Monitor

2014-03-26T21:29:42Z

Awsmazinggenius: Undo revision 6212 by Awsmazinggenius (talk)

{{Block
|name=Monitor
|image=Iso_Monitor.png
|id=4094
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Term (API)
}}
The '''Monitor''' is a block that can display text on its front side. When several screen blocks are placed on the same plane, it will form a single monitor. The maximum size of a single monitor is 8 blocks wide and 6 blocks tall, and must be placed to be shaped as a rectangle, else it will separate into multiple parts. It is useful for displaying information at a server spawn, showing a program on the monitor, and even showing the status of an IC2 reactor! (provided you have [[OpenCCSensors]] installed)

==Recipe==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=glass_pane |C2=stone
|A3=stone |B3=stone |C3=stone
|Output=Monitor
}}

==Redirecting Programs to a Monitor==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
From the CraftOS shell, type <tt>monitor [top|bottom|left|right|front|back] [a-program-name]</tt>. For example, typing <tt>monitor top hello</tt> would show "Hello world." on the top Monitor.

==Monitor as a Peripheral==
To use a 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 a 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]][[Category:Peripherals]]

Monitor

2014-03-26T21:28:54Z

Awsmazinggenius: Added peripheral api notice and put in the peripheral api category.

{{PeripheralAPI}}
{{Block
|name=Monitor
|image=Iso_Monitor.png
|id=4094
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Term (API)
}}
The '''Monitor''' is a block that can display text on its front side. When several screen blocks are placed on the same plane, it will form a single monitor. The maximum size of a single monitor is 8 blocks wide and 6 blocks tall, and must be placed to be shaped as a rectangle, else it will separate into multiple parts. It is useful for displaying information at a server spawn, showing a program on the monitor, and even showing the status of an IC2 reactor! (provided you have [[OpenCCSensors]] installed)

==Recipe==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=glass_pane |C2=stone
|A3=stone |B3=stone |C3=stone
|Output=Monitor
}}

==Redirecting Programs to a Monitor==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
From the CraftOS shell, type <tt>monitor [top|bottom|left|right|front|back] [a-program-name]</tt>. For example, typing <tt>monitor top hello</tt> would show "Hello world." on the top Monitor.

==Monitor as a Peripheral==
To use a 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 a 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]][[Category:Peripherals]][[Category:Peripheral APIs]]

Talk:ComputerCraft Timeline

2014-03-24T06:19:35Z

Awsmazinggenius:

We need to add the recent updates to ComputerCraft. Perhaps also add the CC Teamspeak to it? --[[User:Cranium|Cranium]] 15:16, 18 July 2013 (GMT)

With the new batch of wiki editors (hooray!) someone needs to update this page. The problem is though is what to add... [[User:Awsmazinggenius|awsmazinggenius]] 06:17, 24 March 2014 (GMT)

Talk:ComputerCraft Timeline

2014-03-24T06:17:52Z

Awsmazinggenius: