stmm-games-doc  0.32.0
Public Attributes | List of all members
stmg::ShowTextEvent::LocalInit Struct Reference
Inheritance diagram for stmg::ShowTextEvent::LocalInit:
Inheritance graph
[legend]

Public Attributes

std::vector< std::string > m_aSobstLines
 The text to be shown (without the sobstitutions). More...
 
std::vector< SobstItemm_aSobsts
 The sobstitutions. More...
 
int32_t m_nAnimationNamedIdx = -1
 The animation index as of Named::animations() or -1 if not defined. More...
 
double m_fTextSize = 1
 The font height in tile heights. More...
 
int32_t m_nDuration = LevelAnimation::s_fDurationInfinity
 Duration in milliseconds or LevelAnimation::s_fDurationUndefined or LevelAnimation::s_fDurationInfinity. More...
 
FRect m_oRect
 Rectangle in which to fit the text. More...
 
LevelAnimation::REFSYS m_eRefSys = LevelAnimation::REFSYS_SHOW
 The reference system m_oRect is in. More...
 
int32_t m_nZ = s_nShowTextEventDefaultZ
 The z position of the animation. More...
 

Member Data Documentation

◆ m_aSobstLines

std::vector<std::string> stmg::ShowTextEvent::LocalInit::m_aSobstLines

The text to be shown (without the sobstitutions).

◆ m_aSobsts

std::vector<SobstItem> stmg::ShowTextEvent::LocalInit::m_aSobsts

The sobstitutions.

◆ m_eRefSys

LevelAnimation::REFSYS stmg::ShowTextEvent::LocalInit::m_eRefSys = LevelAnimation::REFSYS_SHOW

The reference system m_oRect is in.

LevelAnimation::REFSYS_SUBSHOW can only be set if in subshow mode.

◆ m_fTextSize

double stmg::ShowTextEvent::LocalInit::m_fTextSize = 1

The font height in tile heights.

Default is 1.

◆ m_nAnimationNamedIdx

int32_t stmg::ShowTextEvent::LocalInit::m_nAnimationNamedIdx = -1

The animation index as of Named::animations() or -1 if not defined.

◆ m_nDuration

int32_t stmg::ShowTextEvent::LocalInit::m_nDuration = LevelAnimation::s_fDurationInfinity

◆ m_nZ

int32_t stmg::ShowTextEvent::LocalInit::m_nZ = s_nShowTextEventDefaultZ

The z position of the animation.

Lower z animations are overdrawn by higher z. The default is s_nShowTextEventDefaultZ.

◆ m_oRect

FRect stmg::ShowTextEvent::LocalInit::m_oRect

Rectangle in which to fit the text.

If size is 0 then depending on the reference system, the whole board, show or subshow is meant.