Define the purpose of the OptionRow. More...

Collaboration diagram for OptionRowDefinition:

Public Member Functions
bool	IsEnabledForPlayer (PlayerNumber pn) const
	Is this option enabled for the Player?

void	Init ()

	OptionRowDefinition (const char n, bool b, const char c0=nullptr, const char c1=nullptr, const char c2=nullptr, const char c3=nullptr, const char c4=nullptr, const char c5=nullptr, const char c6=nullptr, const char c7=nullptr, const char c8=nullptr, const char c9=nullptr, const char c10=nullptr, const char c11=nullptr, const char c12=nullptr, const char c13=nullptr, const char c14=nullptr, const char c15=nullptr, const char c16=nullptr, const char c17=nullptr, const char c18=nullptr, const char *c19=nullptr)

Public Attributes
std::string	m_sName
	the name of the option row.

std::string	m_sExplanationName
	an explanation of the row's purpose.

bool	m_bOneChoiceForAllPlayers { false }
	Do all players have to share one option from the row?

SelectType	m_selectType { SELECT_ONE }

LayoutType	m_layoutType { LAYOUT_SHOW_ALL_IN_ROW }

std::vector< std::string >	m_vsChoices

std::set< PlayerNumber >	m_vEnabledForPlayers

int	m_iDefault { -1 }

bool	m_bExportOnChange { false }

bool	m_bExportOnCancel { false }

bool	m_bAllowThemeItems { true }
	Are theme items allowed here?

bool	m_bAllowThemeTitle { true }
	Are theme titles allowed here?

bool	m_bAllowExplanation { true }
	Are explanations allowed for this row?

bool	m_bShowChoicesListOnSelect { false }

Detailed Description

Define the purpose of the OptionRow.

Member Function Documentation

bool OptionRowDefinition::IsEnabledForPlayer ( PlayerNumber pn ) const

inline

Is this option enabled for the Player?

Parameters

pn	the Player the PlayerNumber represents.

bool OptionRowDefinition::m_bAllowExplanation { true }

Are explanations allowed for this row?

If this is false, it will ignore the ScreenOptions::SHOW_EXPLANATIONS metric.

This should be true for dynamic strings.

bool OptionRowDefinition::m_bAllowThemeItems { true }

Are theme items allowed here?

This should be true for dynamic strings.

bool OptionRowDefinition::m_bAllowThemeTitle { true }

Are theme titles allowed here?

This should be true for dynamic strings.

The documentation for this struct was generated from the following file: