zscript-doc/api/inter/PatchInfo.md

36 lines
674 B
Markdown
Raw Permalink Normal View History

2018-12-29 16:05:19 -08:00
# PatchInfo
Either a patch or string depending on external configurations.
```
struct PatchInfo play
{
2019-08-14 03:32:51 -07:00
int mColor;
Font mFont;
textureid mPatch;
2018-12-29 16:05:19 -08:00
2019-08-14 03:32:51 -07:00
void Init(GIFont gifont);
2018-12-29 16:05:19 -08:00
}
```
2019-08-14 03:31:41 -07:00
### `mColor`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The color of the font, if this is a string.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `mFont`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The font, if this is a string, or `null`.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `mPatch`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
The patch, if this is a patch, or an invalid texture.
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
### `Init`
2018-12-29 16:05:19 -08:00
2019-08-14 03:31:41 -07:00
Initializes the structure. If `gifont.Color` is `'Null'`, and `gifont.FontName`
is a valid patch, `mPatch` will be set accordingly. Otherwise, if the font has
a color or the patch is invalid, `gifont.FontName` is used to set `mFont` (or
it is defaulted to `BigFont`.)
2018-12-29 16:05:19 -08:00
<!-- EOF -->