| Excerpt |
|---|
Outputs text to the player console associated with the script. |
Syntax
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
console(text[, text[, ...]]); |
Parameters
| Parameter | Type | Mandatory | Description | Game version |
|---|---|---|---|---|
| text | String |  | The text to output to the console. If you pass multiple parameters, each string will be output on a new line.
| 3.1 Beta 1 |
Maximum 255 characters per string.Return values
| Value | Type | Description | Game version |
|---|---|---|---|
undefined | Undefined | No errors occurred, so if the human was watching your script's player then they will have seen the text in the console. | 3.1 Beta 1 |
| <error> | Error |  I assume an error will be thrown if something went wrong deeper in the C++ code. | 3.1 Beta 1 |
Example
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
console("Greetings Commander,", "Welcome to Warzone!"); |
Notes
The following characters are silently removed from strings output to the console: @
If you specify a string greater than 255 characters long, only the first 255 characters will be output – the rest will be silently discarded.
| Div | ||
|---|---|---|
| ||
The console() output is only displayed if the human player uses the Debug Menu to select the player the script is associated with. So, by default, a human player won't see console messages issued by AI bots. |
| Div | ||||||
|---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
| Div | ||||
|---|---|---|---|---|
| ||||
ContentsJump to:
|
| Div | ||
|---|---|---|
| ||
See alsoRelated API features:
Add-on APIs: |