Difference between revisions of "Print"
imported>PhilmASTErpLus m (Formatting - abandoned line breaks for unordered lists.) |
imported>PhilmASTErpLus m (Reverted to line breaks. I have yet to understand how wiki markup works with templates...) |
||
| Line 24: | Line 24: | ||
p2desc={{Pspan|color}} is an html color name or code| | p2desc={{Pspan|color}} is an html color name or code| | ||
}}| | }}| | ||
| − | |||
function_description=Print the specified text {{pspan|message}} to the CLI. If the optional {{pspan|color}} parameter is specified and a valid html color code or entity, it will print in that color. See the [http://www.w3.org/TR/CSS21/syndata.html#color-units CSS 2.1 color specification] for a description of valid color syntax and keywords.| | function_description=Print the specified text {{pspan|message}} to the CLI. If the optional {{pspan|color}} parameter is specified and a valid html color code or entity, it will print in that color. See the [http://www.w3.org/TR/CSS21/syndata.html#color-units CSS 2.1 color specification] for a description of valid color syntax and keywords.| | ||
| Line 40: | Line 39: | ||
see_also={{SeeAlso|logprint|print_html}}| | see_also={{SeeAlso|logprint|print_html}}| | ||
cli_equiv=The CLI commands "fprint," "echo" and "fecho" have similar functionality, minus the color option. However, "cecho" (also "colorecho") does have this option for color.| | cli_equiv=The CLI commands "fprint," "echo" and "fecho" have similar functionality, minus the color option. However, "cecho" (also "colorecho") does have this option for color.| | ||
| − | special= | + | special=Using an invalid color name or code can cause odd colors to be chosen; see the [[Talk:Print|Talk Page]] for details. |
| − | + | <br />As of r8638, attempting to print a string beginning with a slash(/) will cause KoLmafia to print a blank line instead. To avoid this behavior, you must specify the second argument for the text color. Any color will do, and even a blank string (<code>""</code>) will work. | |
| − | |||
| | | | ||
}} | }} | ||
[[Category:Miscellaneous Functions]] | [[Category:Miscellaneous Functions]] | ||
Revision as of 12:33, 26 September 2010
Function Syntax
void print(string message ,string color )
- message is the text to print
- color is an html color name or code
Print the specified text message to the CLI. If the optional color parameter is specified and a valid html color code or entity, it will print in that color. See the CSS 2.1 color specification for a description of valid color syntax and keywords.
Code Sample
Prints stuff in color and black. Note that it prints black twice: first and last.
print("This is black.");
foreach color in $strings[blue, green, olive, darkorange, magenta, black]
print("This is "+color+".", color);CLI Equivalent
The CLI commands "fprint," "echo" and "fecho" have similar functionality, minus the color option. However, "cecho" (also "colorecho") does have this option for color.
See Also
Special
Using an invalid color name or code can cause odd colors to be chosen; see the Talk Page for details.
As of r8638, attempting to print a string beginning with a slash(/) will cause KoLmafia to print a blank line instead. To avoid this behavior, you must specify the second argument for the text color. Any color will do, and even a blank string ("") will work.