SCR_HintSettings Class Reference

Inheritance diagram for SCR_HintSettings:

Protected Member Functions
bool	AreHintsEnabled ()
void	SetHintsEnabled (bool enabled)
int	GetCount (EHint type)
int	AddCount (EHint type, int delta=1)
void	DontShowAgain (EHint type, BaseContainer container)
void	LoadShownHints (out BaseContainer container)
void	SaveShownHints (BaseContainer container)

Protected Attributes
bool	m_bHintsEnabled
ref array< EHint >	m_aShownHints
ref array< int >	m_aShownHintCounts

Detailed Description

Definition at line 113 of file SCR_GameplaySettings.c.

Member Function Documentation

AddCount()

int SCR_HintSettings::AddCount ( EHint type, int delta = 1 )

inlineprotected

Adjust number of times specific hint has been shown.

Parameters

type	Hint type
count	Delta value by which the count will be modified

Returns

Number of time the hint has been shown after the change

Definition at line 161 of file SCR_GameplaySettings.c.

AreHintsEnabled()

bool SCR_HintSettings::AreHintsEnabled ( )

inlineprotected

Returns

True if context hints are enabled

Definition at line 127 of file SCR_GameplaySettings.c.

DontShowAgain()

void SCR_HintSettings::DontShowAgain ( EHint type, BaseContainer container )

inlineprotected

Definition at line 181 of file SCR_GameplaySettings.c.

GetCount()

int SCR_HintSettings::GetCount ( EHint type )

inlineprotected

Check how many times has specific hint been shown previously.

Parameters

type

Hint type

Returns

Number of time the hint has been shown

Definition at line 144 of file SCR_GameplaySettings.c.

LoadShownHints()

void SCR_HintSettings::LoadShownHints ( out BaseContainer container )

inlineprotected

Load shown hints to this settings class and validate if existing values are correct. If not, reset them.

Parameters

container

Settings container

Definition at line 199 of file SCR_GameplaySettings.c.

SaveShownHints()

void SCR_HintSettings::SaveShownHints ( BaseContainer container )

inlineprotected

Persistently save shown hints from this settings class.

Parameters

container

Settings container

Definition at line 225 of file SCR_GameplaySettings.c.

SetHintsEnabled()

void SCR_HintSettings::SetHintsEnabled ( bool enabled )

inlineprotected

Definition at line 133 of file SCR_GameplaySettings.c.

Member Data Documentation

m_aShownHintCounts

ref array<int> SCR_HintSettings::m_aShownHintCounts

protectedattribute

Definition at line 122 of file SCR_GameplaySettings.c.

m_aShownHints

ref array<EHint> SCR_HintSettings::m_aShownHints

protected

Definition at line 119 of file SCR_GameplaySettings.c.

m_bHintsEnabled

bool SCR_HintSettings::m_bHintsEnabled

protected

Definition at line 116 of file SCR_GameplaySettings.c.

---

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

• scripts/Game/Global/SCR_GameplaySettings.c