zscript-doc/api/drawing/Console.md

32 lines
754 B
Markdown
Raw Permalink Normal View History

2018-12-29 16:05:19 -08:00
# Console
Basic access to console functionality.
```
struct Console
{
2019-08-14 03:32:51 -07:00
static void HideConsole();
static void MidPrint(Font font, string text, bool bold = false);
static vararg void PrintF(string fmt, ...);
2018-12-29 16:05:19 -08:00
}
```
2019-08-14 03:31:41 -07:00
### `HideConsole`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Hides the console if it is open and `GameState` is not `GS_FULLCONSOLE`.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `MidPrint`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Prints `text` (possibly a `LANGUAGE` string if prefixed with `$`) in `font` to
the middle of the screen for 1½ seconds. Will print even if the player is a
spectator if `bold` is `true`. Uses the `msgmidcolor` CVar for non-bold
messages and `msgmidcolor2` for bold messages.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
This is the function used internally by ACS' `Print` and `PrintBold` functions.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `PrintF`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Prints a formatted string to the console.
2018-12-29 16:05:19 -08:00
<!-- EOF -->