LogConsole class | output.t[1721]

Log Console output stream. This is a simple wrapper for the system log console, which allows console-style output to be captured to a file, with full processing (HTML expansion, word wrapping, etc) but without displaying anything to the game window.

This class should always be instantiated with transient instances, since the underlying system object doesn't participate in save/restore operations.

`class LogConsole : OutputStream`

Superclass Tree (in declaration order)

`LogConsole`
`OutputStream`
`PreinitObject`
`ModuleExecObject`
`object`

Subclass Tree

(none)

Global Objects

(none)

Summary of Properties

`handle_`

Inherited from `OutputStream` :
`filterList_ justDidPara justDidParaSuppressor myInputManager prefix`

Inherited from `PreinitObject` :
`execBeforeMe reverseGlobalSymbols`

Inherited from `ModuleExecObject` :
`execAfterMe hasInitialized_ isDoingExec_ isExecuted_`

Summary of Methods

`captureToFile closeConsole construct writeFromStream`

Inherited from `OutputStream` :
`addOutputFilter addOutputFilterBelow applyFilters applyTextFilters captureOutput captureOutputIgnoreExit execute inputLineEnd removeOutputFilter setPrefix watchForOutput writeToStream`

``

Inherited from `ModuleExecObject` :
`_execute classExec`

Properties

`handle_` | `output.t[1781]`

our system log console handle

Methods

`captureToFile (filename, charset, width, func)` | `output.t[1729]`

Utility method: create a log file, set up to capture all console output to the log file, run the given callback function, and then close the log file and restore the console output. This can be used as a simple means of creating a file that captures the output of a command.

`closeConsole ( )` | `output.t[1764]`

Close the console. This closes the underlying system log console, which closes the operating system file. No further text can be written to the console after it's closed.

`construct (filename, charset, width)`OVERRIDDEN | `output.t[1744]`

create a log console

`writeFromStream (txt)`OVERRIDDEN | `output.t[1778]`

low-level stream writer - write to our system log console

Adv3Lite Library Reference Manual
Generated on 25/04/2024 from adv3Lite version 2.0