View source for Set.text.attribute

The '''set.text.attribute''' command sets the foreground and background color for the display commands.

== Syntax ==

set.text.attribute([[number|byt]] FG, [[number|byt]] BG);

== Remarks ==

This command sets the foreground and background [[colors]] used by AGI to display text with the '''[[display]]''' or '''[[display.v]]''' commands to '''FG''' and '''BG''' respectively. The [[input line]] also uses the foreground and background colors set by this command. The default foreground color is white, and the default background color is black for both the [[graphics screen]] and the [[text screen]].

When the [[text screen]] is active, both the background color and the foreground color are displayed according to the values set by the '''set.text.attribute''' command. On the [[graphics]] screen, AGI limits the background color to black or white. If the background color is is black, AGI draws text using the set values for background and foreground. If the background color is any value other than black, AGI uses white as the background, and draws text with black foreground (ignoring the set foreground value).

On the [[Hercules Graphics Card (HGC)]] display, there are only two colors available (black and white). When displaying text (on either screen) if the set foreground value is less than or equal to the set background value, AGI draws black text on a white background, otherwise it draws white text on  black background.

The text screen on a Color Graphics Adapter (CGA) display supports sixteen colors, so it will show all combinations of background and foreground color just like Enhanced Graphics Adapter displays. On the graphics screen, CGA only has four colors, so AGI uses a table to choose foreground text colors when the background is black (if background is not black, AGI uses black foreground on white background, same as EGA displays):

{| class="wikitable"
! style="width:150px; text-align:center;" | Foreground<br />Color
! style="width:100px; text-align:center;" | CGA-0
! style="width:100px; text-align:center;" | CGA-1
|-
| style="width:150px; text-align:center;" | 0 (black)
| style="width:100px; text-align:center;" | black
| style="width:100px; text-align:center;" | black
|-
| style="width:150px; text-align:center;" | 1 (blue)
| style="width:100px; text-align:center;" | green
| style="width:100px; text-align:center;" | cyan
|-
| style="width:150px; text-align:center;" | 2 (green)
| style="width:100px; text-align:center;" | green
| style="width:100px; text-align:center;" | cyan
|-
| style="width:150px; text-align:center;" | 3 (cyan)
| style="width:100px; text-align:center;" | green
| style="width:100px; text-align:center;" | cyan
|-
| style="width:150px; text-align:center;" | 4 (red)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 5 (magenta)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 6 (brown)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 7 (light gray)
| style="width:100px; text-align:center;" | brown
| style="width:100px; text-align:center;" | white
|-
| style="width:150px; text-align:center;" | 8 (dark gray)
| style="width:100px; text-align:center;" | brown
| style="width:100px; text-align:center;" | white
|-
| style="width:150px; text-align:center;" | 9 (light blue)
| style="width:100px; text-align:center;" | green
| style="width:100px; text-align:center;" | cyan
|-
| style="width:150px; text-align:center;" | 10 (light green)
| style="width:100px; text-align:center;" | green
| style="width:100px; text-align:center;" | cyan
|-
| style="width:150px; text-align:center;" | 11 (light cyan)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 12 (light red)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 13 (light magenta)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 14 (yellow)
| style="width:100px; text-align:center;" | red
| style="width:100px; text-align:center;" | magenta
|-
| style="width:150px; text-align:center;" | 15 (white)
| style="width:100px; text-align:center;" | brown
| style="width:100px; text-align:center;" | white
|}

Using values for '''FG''' and '''BG''' greater than 15 will not cause AGI to crash, but may cause unexpected results. AGI uses only the lower nibble (four least significant bits) of each number to determine the actual colors to display. Internally, AGI combines the '''FG''' and '''BG''' values into a single 8 bit number that is used by the text drawing functions. Because of the way the numbers are combined, it is actually possible to draw black text on non-black backgrounds on the [[graphics]] screen. If '''FG''' is greater than 128 and '''BG''' is zero, AGI will use the higher nibble (upper four bits) of '''FG''' as the background color, and calls to '''[[display]]''' and '''[[display.v]]''' will draw black text on colored background. Using the '''[[text.screen]]''' command when this is the case will also clear the text screen to the 'hacked' foreground color.

== Possible Errors ==

None.

== Example ==

<div class="CodeBlockHeader">Code:</div>
<syntaxhighlight lang="agi">
text.screen();
set.text.attribute(1, 14);
display(5, 5, "message text"); [ this will display blue text on a yellow background
graphics();
display(5, 5, "message text"); [ on graphics screen this will be black text on white background
</syntaxhighlight>

== Technical Information ==

{| border="1" cellpadding="2"
| style="background-color: #efefef" width="200" | '''Required Interpreter Version:'''
| width="175" | Available in all AGI versions.
|-
| style="background-color: #efefef" | '''Byte-Code Value:'''
| 109 (0x6D hex)
|}

== See Also ==

[[Display Commands]]<br />
[[Category:Commands]]<br />