Sending Messages

Agents send messages by adding JSON objects to their messages array. The object is defined as:

{
to: "string" //an agent_id or agent_name
type: "string" //a string that defines the type of the message
data: {} // an object that serves as the payload
}
  • to: An agent id or an agent name. The agent with the corresponding agent_id field or the agent(s) with the corresponding agent_name field will receive the message in the next time step.

You can send a message to multiple agents - multicasting - by sending a message to an agent_name that is shared by multiple agents. For instance, if five agents have the field agent_name set to"forklift", they will all receive a message defined with to: "forklift"

  • type: A user defined string that serves as metadata for the object, describing the message and/or its purpose.

  • data: A user defined object that can contain any arbitrary data.

JavaScript
Python
JavaScript
let messages = state.get("messages");
messages.push({to: "people", type: "greeting", data: {"msg": "hello"}})
state.set("messages", messages)
Python
messages = state.get("messages")
messages.append({"to": "people", "type": "greeting", "data": {"msg": "hello"}})
state.set("messages", messages)

We provide helper functions on the state object for adding messages. state.addMessage() and state.add_message(), for JavaScript and Python, respectively.

JavaScript
Python
JavaScript
state.addMessage("people", "greeting", {"msg": "hello"})
Python
state.add_message("people", "greeting", {"msg": "hello"})