Difference between revisions of "Term.setBackgroundColor"

From ComputerCraft Wiki
Jump to: navigation, search
m (Moved to CAT:APIFunctions)
(Updated/Improved)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
{{Function
 
{{Function
 
|name=term.setBackgroundColor
 
|name=term.setBackgroundColor
|args= [[Colors#Colors|color]] code
+
|args={{type|number}} color code
|returns=None
+
|returns={{type|nil}}
 
|api=term
 
|api=term
 
|addon=ComputerCraft
 
|addon=ComputerCraft
|desc=Changes the background color of text subsequently written to the screen. For ease of use, it is best to use the color codes provided in the colors API.
+
|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=
 
|examples=
 
{{Example
 
{{Example
|desc=Makes the background of the monitor grey
+
|desc=Writes text with a gray background.
|code=term.setBackgroundColor(colors.gray)
+
|code= '''term.setBackgroundColor( [[Colors_(API)|colors.gray]] )'''
 +
[[print]]( "I have a gray background" )
 
}}
 
}}
 
}}
 
}}
  
 
[[Category:API_Functions]]
 
[[Category:API_Functions]]

Latest revision as of 12:26, 28 June 2015


Grid Redstone.png  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

Examples

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