Chat API

Overview

Chat is used to communicate with all players in the game via the in-game chat system.

Chat has two methods for interacting with messages:

• Command Mode – allow players to trigger actions within a script.
• Conversation Mode – allow scripts to engage in multi-message conversations with a player.

From the perspective of your script, each player in the game will be in one of the two modes: Command mode or Conversation mode (not both at the same time). For example, players 1 and 2 might be in Command mode but player 3 might be in conversation mode.

Command mode

In this mode, Chat monitors all incoming messages from a player to look for command keywords. When a keyword is identified, it's associated Command Handler Function is triggered to process the message.

Future development

Allow a specific EggPlant instance to act as the message manager for all allied EggPlants. This way a human player won't get spammed by multiple EggPlants, they can interact with one (automatically chosen) and that will relay relevant commands, etc., on to the other instances.