| | 1 | The Console class and console object facilitates control of the engine console from script. The console object is unique, no other objects of class Console exist. |
| | 2 | |
| | 3 | = Console Methods = |
| | 4 | |
| | 5 | == write == |
| | 6 | * '''Overview:''' |
| | 7 | * Writes a message to the console. |
| | 8 | * '''Syntax:''' |
| | 9 | * write( ... ); |
| | 10 | * Example: console.write (string) |
| | 11 | * '''Parameters:''' |
| | 12 | * Any number of values of any type. |
| | 13 | * '''Returns:''' |
| | 14 | * None. |
| | 15 | * '''Notes:''' |
| | 16 | * write converts each of its arguments to a string, then concatenates these strings together before sending the result to the console. No linebreaks are inserted if the length of the text exceeds the width of the screen, any excess text will be lost. |
| | 17 | * writeConsole (string) is an equivalent function. |
| | 18 | |
| | 19 | = Console Properties = |
| | 20 | |
| | 21 | == visible == |
| | 22 | * '''Overview:''' |
| | 23 | * Gets or sets a value which determines whether the console is visible. |
| | 24 | * '''Type:''' |
| | 25 | * boolean |
| | 26 | * '''Notes:''' |
| | 27 | * The slide in/slide out animation will be triggered if the console changes state. |
| | 28 | |
| | 29 | = Console Global Objects = |
| | 30 | |
| | 31 | == console == |
| | 32 | * '''Overview:''' |
| | 33 | * Gets the !JavaScript object encapsulating the console singleton. |
| | 34 | * Read-only. |
| | 35 | * '''Type:''' |
| | 36 | * Console |
| | 37 | |
| | 38 | = Console Global Functions = |
| | 39 | |
| | 40 | == writeConsole == |
| | 41 | * '''Overview:''' |
| | 42 | * Write values to the console. |
| | 43 | * '''Syntax:''' |
| | 44 | * writeConsole("string", 1234); |
| | 45 | * '''Parameters:''' |
| | 46 | * any number of any type. |
| | 47 | * '''Returns:''' |
| | 48 | * |
| | 49 | * '''Notes:''' |
| | 50 | * Each argument is converted to a string and then written to the log. |
