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

Public Attributes

int32_t m_nRepeat = -1
 The number of scrolls. More...
 
int32_t m_nStep = 1
 The interval between scrolls in game ticks. More...
 
int32_t m_nSlices = 6
 How many partial row scroll positions (within a tile) should be shown. More...
 
bool m_bKeepTopVisible = true
 Whether the first non empty top line should always be completly visible. More...
 
int32_t m_nTopNotEmptyWaitTicks = 0
 Number of game ticks scrolling is suspended when top row not empty. More...
 
int32_t m_nTopNotEmptyWaitMillisec = 0
 Number of millisec scrolling is suspended when top row not empty. More...
 
unique_ptr< NewRowsm_refNewRows
 The new rows generator. More...
 
std::vector< NewRowCheckRemoverm_aRemovers
 The removal checkers. More...
 
std::vector< unique_ptr< TileSelector > > m_aInhibitors
 Array of inhibitors. More...
 
int32_t m_nCheckNewRowTries = 5
 The maximum number of random rows to be generated to minimize inhibited tiles and "free" removals. More...
 

Member Data Documentation

◆ m_aInhibitors

std::vector< unique_ptr<TileSelector> > stmg::ScrollerEvent::LocalInit::m_aInhibitors

Array of inhibitors.

When active, the more tiles selected by an inhibitor appear in a new row the more likely a new row is discarded. See m_nCheckNewRowTries. The size of the array shouldn't exceed 100.

◆ m_aRemovers

std::vector< NewRowCheckRemover > stmg::ScrollerEvent::LocalInit::m_aRemovers

The removal checkers.

Can be empty.

◆ m_bKeepTopVisible

bool stmg::ScrollerEvent::LocalInit::m_bKeepTopVisible = true

Whether the first non empty top line should always be completly visible.

Default is true.

◆ m_nCheckNewRowTries

int32_t stmg::ScrollerEvent::LocalInit::m_nCheckNewRowTries = 5

The maximum number of random rows to be generated to minimize inhibited tiles and "free" removals.

Only used if m_p0TileRemover is set or m_aInhibitors is not empty. If set to 1 inhibitors and tile remover are ignored. Must be positive. Default is 5.

◆ m_nRepeat

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

The number of scrolls.

The default is -1 (means infinite).

◆ m_nSlices

int32_t stmg::ScrollerEvent::LocalInit::m_nSlices = 6

How many partial row scroll positions (within a tile) should be shown.

Default is 6.

◆ m_nStep

int32_t stmg::ScrollerEvent::LocalInit::m_nStep = 1

The interval between scrolls in game ticks.

Must be >= 1. The default is 1.

◆ m_nTopNotEmptyWaitMillisec

int32_t stmg::ScrollerEvent::LocalInit::m_nTopNotEmptyWaitMillisec = 0

Number of millisec scrolling is suspended when top row not empty.

Adds to m_nTopNotEmptyWaitTicks. Default is 0.

◆ m_nTopNotEmptyWaitTicks

int32_t stmg::ScrollerEvent::LocalInit::m_nTopNotEmptyWaitTicks = 0

Number of game ticks scrolling is suspended when top row not empty.

Default is 0.

◆ m_refNewRows

unique_ptr< NewRows > stmg::ScrollerEvent::LocalInit::m_refNewRows

The new rows generator.

Cannot be null.