stmm-games-doc  0.32.0
Public Attributes | List of all members
stmg::TextModifier::LocalInit Struct Reference

Initialization data. More...

Inheritance diagram for stmg::TextModifier::LocalInit:
Inheritance graph
[legend]

Public Attributes

std::string m_sText
 The (very short) text. More...
 
bool m_bStretch = false
 Whether the text is stretched over the whole tile. More...
 
bool m_bUseTileColor = false
 If true the text color is defined by the tile color. More...
 
bool m_bUseTileFont = false
 If true the text font is defined by the tile font. More...
 
TileColor m_oColor
 The color to use if m_bUseTileColor is false. More...
 
double m_fFontSize1 = 0.78
 The font size in tiles. More...
 
TileFont m_oFont
 The font to use if m_bUseTileFont is false. More...
 
int32_t m_nAddToChar = 0
 Added to char if TileChar of the drawn tile is !isEmpty() and !isCharIndex(). More...
 

Detailed Description

Initialization data.

Member Data Documentation

◆ m_bStretch

bool stmg::TextModifier::LocalInit::m_bStretch = false

Whether the text is stretched over the whole tile.

Default is false.

◆ m_bUseTileColor

bool stmg::TextModifier::LocalInit::m_bUseTileColor = false

If true the text color is defined by the tile color.

If false use m_oColor. Default is false.

◆ m_bUseTileFont

bool stmg::TextModifier::LocalInit::m_bUseTileFont = false

If true the text font is defined by the tile font.

If false use m_oFont. Default is false.

◆ m_fFontSize1

double stmg::TextModifier::LocalInit::m_fFontSize1 = 0.78

The font size in tiles.

Must be > 0.0 and <= 1.0. Default is 0.78.

◆ m_nAddToChar

int32_t stmg::TextModifier::LocalInit::m_nAddToChar = 0

Added to char if TileChar of the drawn tile is !isEmpty() and !isCharIndex().

Default is 0.

◆ m_oColor

TileColor stmg::TextModifier::LocalInit::m_oColor

The color to use if m_bUseTileColor is false.

If empty the color will be either black or white, depending on the tile color (white on a dark color, black on a light color).

◆ m_oFont

TileFont stmg::TextModifier::LocalInit::m_oFont

The font to use if m_bUseTileFont is false.

If empty the font will be the theme default font.

◆ m_sText

std::string stmg::TextModifier::LocalInit::m_sText

The (very short) text.

If m_sText.empty() draws the tile char (but only if is defined and !isCharIndex()).