Namespace sandboxe.console
Defined in: docbase.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Collection of references that work with the system console.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
sandboxe.console.clear()
Removes all stored lines of console output.
|
| <static> |
sandboxe.console.error(content)
Prints console output as a error message.
|
| <static> |
sandboxe.console.getLine(i)
Returns the string for the i'th line, starting at 0.
|
| <static> |
sandboxe.console.getNumLines()
Returns the number of lines of output
currently held by the console.
|
| <static> |
sandboxe.console.getOverlayMessageMode()
Gets the overlay message mode.
|
| <static> |
sandboxe.console.info(content)
Prints console output as a info message.
|
| <static> |
sandboxe.console.isLocked()
Returns whether the console is locked.
|
| <static> |
sandboxe.console.isVisible()
Returns whether the console is currently visible
|
| <static> |
sandboxe.console.lock(lockConsole)
Returns whether to lock or unlock the console.
|
| <static> |
sandboxe.console.setOverlayMessageMode(mode)
Sets the overlay message mode for incoming console messages.
|
| <static> |
sandboxe.console.show(showConsole)
Sets whether to show the console.
|
| <static> |
sandboxe.console.system(content)
Prints console output as a system-generated message.
|
| <static> |
sandboxe.console.warning(content)
Prints console output as a warning message.
|
Method Detail
<static>
sandboxe.console.clear()
Removes all stored lines of console output.
<static>
sandboxe.console.error(content)
Prints console output as a error message. If the overlay mode is
not disabled, sending a newline (\\n) will trigger a visual.
- Parameters:
- {String} content
<static>
{String}
sandboxe.console.getLine(i)
Returns the string for the i'th line, starting at 0.
- Parameters:
- {Number} i
- THe line to retrieve.
- Returns:
- {String}
<static>
{Number}
sandboxe.console.getNumLines()
Returns the number of lines of output
currently held by the console.
- Returns:
- {Number}
<static>
{Number}
sandboxe.console.getOverlayMessageMode()
Gets the overlay message mode. THe default is sandboxe.console.messageMode.standard
- Returns:
- {Number} See sandboxe.console.messageMode.
<static>
sandboxe.console.info(content)
Prints console output as a info message. If the overlay mode is
not disabled, sending a newline (\\n) will trigger a visual.
- Parameters:
- {String} content
<static>
{boolean}
sandboxe.console.isLocked()
Returns whether the console is locked. If locked, the console cannot
be shown or hidden through either the keyboard shortcut or the showConsole
function.
- Returns:
- {boolean}
<static>
{boolean}
sandboxe.console.isVisible()
Returns whether the console is currently visible
- Returns:
- {boolean}
<static>
sandboxe.console.lock(lockConsole)
Returns whether to lock or unlock the console.
The default is false.
- Parameters:
- {boolean} lockConsole
- If true, the console is locked (see isLocked)
<static>
sandboxe.console.setOverlayMessageMode(mode)
Sets the overlay message mode for incoming console messages.
- Parameters:
- {Number} mode
- The mode to set. See sandboxe.console.messageMode.
<static>
sandboxe.console.show(showConsole)
Sets whether to show the console.
The console is also showable through the keyboard shortcut Shift+Tab
- Parameters:
- {boolean} showConsole
- If true, shows the console; if false, hides it.
<static>
sandboxe.console.system(content)
Prints console output as a system-generated message. If the overlay mode is
not disabled, sending a newline (\\n) will trigger a visual.
- Parameters:
- {String} content
<static>
sandboxe.console.warning(content)
Prints console output as a warning message. If the overlay mode is
not disabled, sending a newline (\\n) will trigger a visual.
- Parameters:
- {String} content