mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-11-02 06:32:59 +00:00
Code Issues Releases Wiki Activity
Files
ca37dbb591b94a2f6f90c6fb63e5d1fcc993305c
CC-Tweaked/doc/events/modem_message.md
Jonathan Coates 70a24d371d Update build.gradle to more closely match CC:T's 
- Adds cct-javadoc fun and renables checkstyle (yay?)
 - Fixes a few javadoc and formatting issues
 - Cherry pick the docs so illuaminate doesn't complain
2021-11-27 09:32:25 +00:00

829 B
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}: The distance between the sender and the receiver, in blocks (decimal).

Example

Prints a message when one is sent:

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