mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-15 20:50:29 +00:00
Code Issues Releases Wiki Activity
988219ffca
CC-Tweaked/doc/events/modem_message.md
Jonathan Coates 895bc7721a
License CC:T according to the REUSE specification (#1351) 
This adds SPDX license headers to all source code files, following the
REUSE[1] specification. This does not include any asset files (such as
generated JSON files, or textures). While REUSE does support doing so
with ".license" files, for now we define these licences using the
.reuse/dep5 file.

[1]: https://reuse.software/
2023-03-15 21:52:13 +00: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