out()

(info) This AI is still in early stages of development.

out()

Message output handler.

 

Syntax

out(message[, sdo[, method[, config]]]);

Parameters

Parameter

Type

Mandatory

Description

API Version

Parameter

Type

Mandatory

Description

API Version

message

String

Array of String

The message to output – either a single string or an array of strings.

1.0

sdo

Self Descriptor Object

Optional descriptor object, used to create a prefix to the message before it is output.

If you're using the method or config params, but don't want to use an SDO, specify null.

Default: No prefix

1.0

method

Constant

Constant defining desired output destination:

Default: out.DEFAULT

1.0

config

Variant

Optional method-specific config:

  • If using method out.CHAT, config can be either a specific player ID, ALLIES or ALL_PLAYERS. Defaults to ALLIES.

  • If using method out.ERROR, config can specify a specific error class to use (eg. TypeError). Default: Error

  • If using method out.ASSERT, config is the value being asserted

1.0

Return value

The return value of the output method will be returned (see documentation for out.* constants above for more information).

Example

Output single line of text to console
var self = {file: "foo.js", ver: 1.2}; out("hello", self, out.CONSOLE); // "[foo.js v1.2] hello"
Multi-line output
out(["bob", "jim", "kate"]); // outputs each name on a new line to out.DEFAULT