console module

Core framework Console Desktop

The console module allows for management and control of the console window

Property Description Access Type
console.bgcolor Get/set console background color readwrite string
console.color Get/set console foreground color readwrite string
console.cursor Get/set cursor visibility readwrite boolean
console.echo Get/set ECHO mode for console stdout readwrite boolean string
console.font Get/set current console font readwrite string
console.fontsize Get/set current console font size readwrite number
console.fullscreen Get/set console fullscreen mode readwrite boolean
console.height Get console height readonly number
console.keyhit Checks if a key has been pressed readonly boolean
console.stderr Get/set console stderr standard file readwrite
console.stdin Get/set console stdin standard file readwrite
console.stdout Get/set console stdout standard file readwrite
console.title Get/set console window title readwrite string
console.visible Checks if the console window is visible readwrite boolean
console.width Get console width readonly number
console.x Get/set cursor x position readwrite number
console.y Get/set cursor y position readwrite number
Functions Description Return value
console.clear() Clear console screen -
console.hide() Hide the console window -
console.inverse() Swap foreground with background console color -
console.locate() Set console cursor position -
console.read() Read input from console.stdin string
console.readchar() Read a key from console string boolean
console.readln() Read a line from console.stdin string
console.readmouse() Read console mouse events number number string nil
console.reset() Reset console colors to default -
console.show() Show the console window -
console.write() Write to console.stdout -
console.writecolor() Write colored characters to console.stdout -
console.writeln() Write to console.stdout with newline -