chat.toBabel()

Compiles a Babel format message, ready for sending to your AI buddies...

Syntax

var result = chat.toBabel(message[, dialect[, data[, replacer]]]);

Parameter	Type	Notes	API Version
message	String	A basic message to send to the recipient, eg. "help"	1.0
dialect	String	The dialect of your Babel message – this is usually an abbreviation of the name of your AI, or "ai" if using the Standard Dialect. Default: `"ai"` (standard dialect)	1.0
data	Variant	Optionally send data of any type with the message. Try and keep it small, it's being squeezed in to a chat message after all Supported data types include: Any JS API Objects, including Game objects, or standard Javascript types such as Array, Object, String, Number, Boolean. You can also send `null` or `undefined`. Functions are automatically excluded from the compiled data. Note: It helps if you specify Data types when sending custom objects. Only enumerable "own" properties (and their values, recursively) will be sent. Default: `undefined`	1.0
replacer	Function Array	Optionally specify a JSON replacer function or array to filter out properties you don't want to send. Will be ignored if data is a DROID, STRUCTURE, FEATURE, RESEARCH_DATA or PLAYER_DATA object (as internal replacers are used for those to minimise amount of data transmitted).	1.0

Value	Type	Notes	API Version
<result>	String	The message, dialect and data compiled in to a Babel-formatted string, ready for sending to a friendly AI via chat().	1.0
<error>	Error	Invalid parameters passed to function. Be sure to use Error Handling.	1.0

var message = chat.toBabel("defend", "ai", someStructureObj);
 
chat(someAIplayer, message);

Requires:

Topics:

Data types — Babel supports most types of data...
Error Dialect — A specific dialect for reporting errors within Babel...
Babel on Warzone 3.1 — Babel handles Warzone 3.1 gracefully...
Position-like Objects — If your data has {x, y} properties, Babel treats it like a Position object...
chat.toBabel() — Compiles a Babel format message, ready for sending to your AI buddies...
chat.isBabel() — Quickly determine if a received message is in Babel format...
chat.fromBabel() — Converts a Babel format message in to an array...
Handling Dialects — Some ideas on how to handle multiple dialects...