Cli Module - Revision history

Elverion: /* setAttributes */

2015-03-21T17:16:39Z

‎setAttributes

Elverion: /* getAttributes */

2015-03-21T17:16:25Z

‎getAttributes

Elverion at 03:46, 18 February 2015

2015-02-18T03:46:54Z

Elverion: Protected "Cli Module" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2014-09-04T18:14:54Z

Protected "Cli Module" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Elverion: Created page with "The CLI module allows you to modify the look and behavior of the standard console. For more advanced controls, use the Ncurses Module instead. == clear() == '''cli.clear..."

2014-09-04T18:14:41Z

Created page with "The CLI module allows you to modify the look and behavior of the standard console. For more advanced controls, use the Ncurses Module instead. == clear() == '''cli.clear..."

New page

The CLI module allows you to modify the look and behavior of the standard console. For more advanced controls, use the [[Ncurses Module]] instead.

== clear() ==
'''cli.clear()'''

Clears the console window by filling it with blanks.

== resetColor() ==
'''cli.resetColor()'''

Resets the console's foreground(text) and background colors, as well as attributes, back to defaults.

== getColor() ==
'''number cli.getColor()'''

Returns the console's current attribute mask.

== setColor() ==
'''cli.setColor(number foreground[, number background])'''

Modify the console's attribute mask. You should probably use one of the color constants listed.

{|
|-
|cli.BLACK
|-
|cli.BLUE
|-
|cli.GREEN
|-
|cli.CYAN
|-
|cli.RED
|-
|cli.MAGENTA
|-
|cli.YELLOW
|-
|cli.WHITE
|-
|cli.GRAY
|-
|cli.LIGHT_BLUE
|-
|cli.LIGHT_GREEN
|-
|cli.LIGHT_CYAN
|-
|cli.LIGHT_RED
|-
|cli.LIGHT_MAGENTA
|-
|cli.LIGHT_YELLOW
|-
|cli.LIGHT_WHITE
|}

Due to the way attribute masks work, you may also modify the background color by multiplying a color by 16 and adding it to the text color. For example:
<source lang="lua">
cli.setColor(16*cli.LIGHT_WHITE + cli.BLUE); -- This produces blue text against a light white background.
</source>

This is why getColor() only returns one value. The second parameter for setColor() has been added for your convenience.

== getAttributes() ==
'''number winWidth, number winHeight, number buffWidth, number buffHeight, number cursorX, number cursorY system.getConsoleAttributes()'''

Returns a set of console attributes. Values are in characters, not pixels!

== setAttributes() ==
'''system.setConsoleAttributes(number windowWidth, number windowHeight, number bufferWidth, number bufferHeight)'''

Modify the console's attributes. Values should be in characters, not pixels.

@@ Line 76: / Line 76: @@
 == setAttributes ==
-'''system.setConsoleAttributes(number windowWidth, number windowHeight, number bufferWidth, number bufferHeight)'''
+'''cli.setAttributes(number windowWidth, number windowHeight, number bufferWidth, number bufferHeight)'''
 Modify the console's attributes. Values should be in characters, not pixels.

@@ Line 71: / Line 71: @@
 == getAttributes ==
-'''number winWidth, number winHeight, number buffWidth, number buffHeight, number cursorX, number cursorY system.getConsoleAttributes()'''
+'''number winWidth, number winHeight, number buffWidth, number buffHeight, number cursorX, number cursorY cli.getAttributes()'''
 Returns a set of console attributes. Values are in characters, not pixels!
 == setAttributes ==

@@ Line 2: / Line 2: @@
-== clear() ==
+== clear ==
 '''cli.clear()'''
@@ Line 8: / Line 8: @@
-== resetColor() ==
+== resetColor ==
 '''cli.resetColor()'''
@@ Line 14: / Line 14: @@
-== getColor() ==
+== getColor ==
 '''number cli.getColor()'''
@@ Line 20: / Line 20: @@
-== setColor() ==
+== setColor ==
 '''cli.setColor(number foreground[, number background])'''
@@ Line 70: / Line 70: @@
-== getAttributes() ==
+== getAttributes ==
 '''number winWidth, number winHeight, number buffWidth, number buffHeight, number cursorX, number cursorY system.getConsoleAttributes()'''
@@ Line 76: / Line 76: @@
-== setAttributes() ==
+== setAttributes ==
 '''system.setConsoleAttributes(number windowWidth, number windowHeight, number bufferWidth, number bufferHeight)'''
 Modify the console's attributes. Values should be in characters, not pixels.

← Older revision	Revision as of 18:14, 4 September 2014
(No difference)