Difference between revisions of "Term.setBackgroundColor"

Latest revision as of 12:26, 28 June 2015

Function term.setBackgroundColor
Changes the background color of the terminal. For ease of use, it is best to use the color codes provided in the colors API. Note that non-advanced systems only have black and white displays, though the background color may still be set to either of these four colors: black, white, gray and light gray. Also available as term.setBackgroundColour for British spelling. See also: term.getBackgroundColor()
Syntax	term.setBackgroundColor(number color code)
Returns	nil
Part of	ComputerCraft
API	term

Example
Writes text with a gray background.
Code	term.setBackgroundColor( colors.gray ) print( "I have a gray background" )

@@ Line 1: / Line 1: @@
 {{lowercase}}
 {{Function
-|name=Term.setBackgroundColor
+|name=term.setBackgroundColor
-|args= [[Colors#Colors|color]] code
+|args={{type|number}} color code
-|returns=None
+|returns={{type|nil}}
 |api=term
 |addon=ComputerCraft
-|desc=changes the color of the background of your terminal/monitor (For common use add the decimal code of the color) [Need screen refresh,with term.clear() by example]
+|desc=Changes the background color of the terminal. For ease of use, it is best to use the color codes provided in the [[colors (API)|colors API]]. Note that non-advanced systems only have black and white displays, though the background color may still be set to either of these four colors: black, white, gray and light gray. Also available as '''term.setBackgroundColour''' for British spelling.
+<br>
+See also: [[term.getBackgroundColor]]()
 |examples=
 {{Example
-|desc=Makes the background of the monitor grey,and clear screen for updating |code=term.setBackgroundColor(128)<br>term.clear()
+|desc=Writes text with a gray background.
+|code= '''term.setBackgroundColor( [[Colors_(API)|colors.gray]] )'''
+ [[print]]( "I have a gray background" )
 }}
 }}
+[[Category:API_Functions]]