mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-06-24 22:23:21 +00:00
Code Issues Releases Wiki Activity
mc-1.16.x
CC-Tweaked/doc/events/modem_message.md
Jonathan Coates 932b77d7ee
Rewrite several doc introductions 
Mostly focussing on rednet and modem here. Not sure if I made them any
better, we'll see!
2021-12-21 00:27:07 +00:00

969 B
Raw Permalink Blame History

module: [kind=event] modem_message

The @{modem_message} event is fired when a message is received on an open channel on any @{modem}.

Return Values

  1. @{string}: The event name.
  2. @{string}: The side of the modem that received the message.
  3. @{number}: The channel that the message was sent on.
  4. @{number}: The reply channel set by the sender.
  5. @{any}: The message as sent by the sender.
  6. @{number}: The distance between the sender and the receiver, in blocks.

Example

Wraps a @{modem} peripheral, opens channel 0 for listening, and prints all received messages.

local modem = peripheral.find("modem") or error("No modem attached", 0)
modem.open(0)

while true do
  local event, side, channel, replyChannel, message, distance = os.pullEvent("modem_message")
  print(("Message received on side %s on channel %d (reply to %d) from %f blocks away with message %s"):format(side, channel, replyChannel, distance, tostring(message)))
end