 |
Automated updating of API pages at this location, to reflect patch changes, has ceased from 10.1.7 onwards.
|
Returns a structured table of information about the given font object.
fontInfo = GetFontInfo(font)
Arguments
- font
- Font🔗|string - Either a font object or the name of a global font object.
Returns
- fontInfo
- FontInfo
| Field |
Type |
Description
|
| height |
number |
Height (size) of the font object
|
| outline |
string |
Comma delimited list of font flags such as OUTLINE, THICKOUTLINE, and MONOCHROME
|
| color |
ColorInfo |
Table of color values for the font object
|
| shadow |
FontShadow? |
Optional table of shadow information for the font object
|
FontShadow
| Field |
Type |
Description
|
| x |
number |
Horizontal offset for the shadow
|
| y |
number |
Vertical offset for the shadow
|
| color |
ColorInfo |
Table of color values for the shadow
|
ColorInfo
| Field |
Type |
Description
|
| r |
number [0.0 - 1.0] |
|
| g |
number [0.0 - 1.0] |
|
| b |
number [0.0 - 1.0] |
|
| a |
number [0.0 - 1.0] |
|
Details
- If a font has no outline or monochrome flags applied, the
outline field in the returned table will always be an empty string.
See also
