SCR_HintSettings Interface Reference

Inheritance diagram for SCR_HintSettings:

Public Member Functions
bool	AreHintsEnabled ()
void	SetHintsEnabled (bool enabled)
int	GetCount (EHint type)
	Check how many times has specific hint been shown previously.
int	AddCount (EHint type, int delta=1)
	Adjust number of times specific hint has been shown.
void	LoadShownHints (out BaseContainer container)
	Load shown hints to this settings class and validate if existing values are correct.
void	SaveShownHints (BaseContainer container)
	Persistently save shown hints from this settings class.

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

Member Function Documentation

AddCount()

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

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

AreHintsEnabled()

bool SCR_HintSettings.AreHintsEnabled

(

)

Returns

True if context hints are enabled

GetCount()

int SCR_HintSettings.GetCount

(

EHint

type

)

Check how many times has specific hint been shown previously.

Parameters

type

Hint type

Returns

Number of time the hint has been shown

LoadShownHints()

void SCR_HintSettings.LoadShownHints

(

out BaseContainer

container

)

Load shown hints to this settings class and validate if existing values are correct.

If not, reset them.

Parameters

container

Settings container

SaveShownHints()

void SCR_HintSettings.SaveShownHints

(

BaseContainer

container

)

Persistently save shown hints from this settings class.

Parameters

container

Settings container

SetHintsEnabled()

void SCR_HintSettings.SetHintsEnabled

(

bool

enabled

)

Member Data Documentation

m_aShownHintCounts

ref array<int> SCR_HintSettings.m_aShownHintCounts

protected

m_aShownHints

ref array<EHint> SCR_HintSettings.m_aShownHints

protected

m_bHintsEnabled

bool SCR_HintSettings.m_bHintsEnabled

protected

---

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

• Game/Global/SCR_GameplaySettings.c