mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-17 23:34:51 +00:00
Code Issues Releases Wiki Activity
0ff58cdc3e
CC-Tweaked/doc/events/modem_message.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

1.2 KiB
Raw 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]|[nil]: The distance between the sender and the receiver in blocks, or [nil] if the message was sent between dimensions.

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