Skip to content

ReceiveResult

Result of consuming a queued message. Returned by: comms.receive(), comms.wait()

FieldReturnsMeaning
.statusstring"ok" (a message was consumed), "empty" (no id requested, queue empty; nothing consumed), "not_found" (requested id absent), "invalid_channel"
.messagestringPlayer-readable explanation
.packetCommsMessage or NoneThe consumed message when "ok"; when an id was requested, the packet has exactly that id