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

Public Attributes

int32_t m_nRepeat = -1
 Ticks the event should be active for. More...
 
unique_ptr< TileSelectorm_refSelect
 The tiles that should be animated. More...
 
int32_t m_nAniNameIdx = -1
 The tile animation id. More...
 
bool m_bDoBoard = true
 Whether to animate board tiles. More...
 
NRect m_oArea
 The area within the board to be animated (in tiles). More...
 
bool m_bDoBlocks = true
 Whether to animate block tiles. More...
 
NTimeRange m_oInitialWait
 The wait in game ticks and milliseconds before starting to animate a cell. More...
 
NTimeRange m_oDuration
 The duration in game ticks and milliseconds of the cell animation. More...
 
NTimeRange m_oPause
 The pause in game ticks and milliseconds between cell animations. More...
 
NRange m_oTotCount = {1,1}
 The number of times the cell animation should be repeated. More...
 
int32_t m_nMaxParallel = -1
 How many single TileAnimation should be active at the same moment. More...
 

Member Data Documentation

◆ m_bDoBlocks

bool stmg::TileAnimatorEvent::LocalInit::m_bDoBlocks = true

Whether to animate block tiles.

Only currently visible tiles are considered.

◆ m_bDoBoard

bool stmg::TileAnimatorEvent::LocalInit::m_bDoBoard = true

Whether to animate board tiles.

◆ m_nAniNameIdx

int32_t stmg::TileAnimatorEvent::LocalInit::m_nAniNameIdx = -1

The tile animation id.

Must be valid in Named::tileAnis().

◆ m_nMaxParallel

int32_t stmg::TileAnimatorEvent::LocalInit::m_nMaxParallel = -1

How many single TileAnimation should be active at the same moment.

-1: all (if possible). Default is -1.

◆ m_nRepeat

int32_t stmg::TileAnimatorEvent::LocalInit::m_nRepeat = -1

Ticks the event should be active for.

-1: forever. Default is -1.

◆ m_oArea

NRect stmg::TileAnimatorEvent::LocalInit::m_oArea

The area within the board to be animated (in tiles).

Must be within board.

◆ m_oDuration

NTimeRange stmg::TileAnimatorEvent::LocalInit::m_oDuration

The duration in game ticks and milliseconds of the cell animation.

All m_nFrom must be >= 0 and <= m_nTo.

◆ m_oInitialWait

NTimeRange stmg::TileAnimatorEvent::LocalInit::m_oInitialWait

The wait in game ticks and milliseconds before starting to animate a cell.

All m_nFrom must be >= 0 and <= m_nTo.

◆ m_oPause

NTimeRange stmg::TileAnimatorEvent::LocalInit::m_oPause

The pause in game ticks and milliseconds between cell animations.

All m_nFrom must be >= 0 and <= m_nTo.

◆ m_oTotCount

NRange stmg::TileAnimatorEvent::LocalInit::m_oTotCount = {1,1}

The number of times the cell animation should be repeated.

Default is 1.

◆ m_refSelect

unique_ptr<TileSelector> stmg::TileAnimatorEvent::LocalInit::m_refSelect

The tiles that should be animated.

Empty tiles are never selected. If null means every non empty tile.