zscript-doc/api/global/data/Client.md

141 lines
2.9 KiB
Markdown
Raw Normal View History

2018-12-29 16:05:19 -08:00
# Client
TODO
```
KeyBindings AutomapBindings;
KeyBindings Bindings;
readonly Font BigFont;
readonly int CleanHeight;
readonly int CleanHeight_1;
readonly int CleanWidth;
readonly int CleanWidth_1;
readonly int CleanXFac;
readonly int CleanXFac_1;
readonly int CleanYFac;
readonly int CleanYFac_1;
readonly Font ConFont;
readonly Font IntermissionFont;
readonly Font SmallFont;
readonly Font SmallFont2;
2019-04-07 03:11:50 -07:00
readonly Font NewConsoleFont;
readonly Font NewSmallFont;
2018-12-29 16:05:19 -08:00
ui float BackbuttonAlpha;
ui int BackbuttonTime;
ui int MenuActive;
ui BaseStatusBar StatusBar;
2018-12-29 20:04:32 -08:00
readonly ui bool NetGame;
2018-12-29 16:05:19 -08:00
int LocalViewPitch;
```
2019-08-14 03:31:41 -07:00
### `AutomapBindings`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
TODO
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Bindings`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
TODO
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `BigFont`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The `bigfont` for the current game.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanHeight`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The current screen height divided by `CleanYFac`. **Not deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanHeight_1`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The current screen height divided by `CleanYFac_1`. **Not deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanWidth`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The current screen width divided by `CleanXFac`. **Not deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanWidth_1`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The current screen width divided by `CleanYFac_1`. **Not deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanXFac`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Integral scaling factor for horizontal positions to scale from 320x200 to the
current virtual resolution. **Not deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanXFac_1`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Integral scaling factor for horizontal positions to scale from 320x200 to the
current virtual resolution, accounting for aspect ratio differences. **Not
deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanYFac`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Integral scaling factor for vertical positions to scale from 320x200 to the
current virtual resolution. **Not deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `CleanYFac_1`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Integral scaling factor for vertical positions to scale from 320x200 to the
current virtual resolution, accounting for aspect ratio differences. **Not
deterministic.**
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `ConFont`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The console font.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `IntermissionFont`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The font used in intermission screens.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `SmallFont`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The `smallfnt` for the current game.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `SmallFont2`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The alternate `smallfnt`.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `NewConsoleFont`
2019-04-07 03:11:50 -07:00
2019-08-14 03:31:41 -07:00
TODO
2019-04-07 03:11:50 -07:00
2019-08-14 03:31:41 -07:00
### `NewSmallFont`
2019-04-07 03:11:50 -07:00
2019-08-14 03:31:41 -07:00
TODO
2019-04-07 03:11:50 -07:00
2019-08-14 03:31:41 -07:00
### `BackbuttonAlpha`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Alpha of the back button in menus.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `BackbuttonTime`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The time until the back button starts fading out in menus.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `MenuActive`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The current active menu state. One of:
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
| Name | Description |
| ---- | ----------- |
| `Menu.Off` | No active menu. |
| `Menu.OnNoPause` | Menu is opened, but the game is not paused. |
| `Menu.On` | Menu is open, game is paused. |
| `Menu.WaitKey` | Menu is opened, waiting for a key for a controls menu binding. |
2018-12-29 20:04:32 -08:00
2019-08-14 03:31:41 -07:00
### `StatusBar`
2018-12-29 20:04:32 -08:00
2019-08-14 03:31:41 -07:00
TODO
2018-12-29 20:04:32 -08:00
2019-08-14 03:31:41 -07:00
### `NetGame`
2018-12-29 20:04:32 -08:00
2019-08-14 03:31:41 -07:00
Whether this is a networked game or not.
2018-12-29 20:04:32 -08:00
2019-08-14 03:31:41 -07:00
### `LocalViewPitch`
2018-12-29 20:04:32 -08:00
2019-08-14 03:31:41 -07:00
The pitch angle (in degrees) of `ConsolePlayer`'s view. **Not deterministic.**
2018-12-29 20:04:32 -08:00
<!-- EOF -->