SCR_FilterSet Class Reference

Protected Member Functions
array< ref SCR_FilterCategory >	GetFilterCategories ()
SCR_FilterCategory	FindFilterCategory (string internalName)
	Finds a filter category by its internal name.
ref SCR_FilterEntry	FindFilter (string internalName)
	Finds a filter entry within categories.
bool	AnyFilterSelected ()
void	ResetToDefaultValues ()
	Initializes all filters to their default values.

Protected Attributes
ref array< ref SCR_FilterCategory >	m_aFilterCategories

Detailed Description

Config class for whole filter set. Filter set is an array of filter categories. Inherit from it if you need to store some more data - don't forget to mark it with BaseContainerProps attribute too!

Definition at line 196 of file SCR_FilterSet.c.

Member Function Documentation

AnyFilterSelected()

bool SCR_FilterSet::AnyFilterSelected ( )

inlineprotected

Definition at line 233 of file SCR_FilterSet.c.

FindFilter()

ref SCR_FilterEntry SCR_FilterSet::FindFilter ( string internalName )

inlineprotected

Finds a filter entry within categories.

Definition at line 221 of file SCR_FilterSet.c.

FindFilterCategory()

SCR_FilterCategory SCR_FilterSet::FindFilterCategory ( string internalName )

inlineprotected

Finds a filter category by its internal name.

Definition at line 209 of file SCR_FilterSet.c.

GetFilterCategories()

array< ref SCR_FilterCategory > SCR_FilterSet::GetFilterCategories ( )

inlineprotected

Definition at line 202 of file SCR_FilterSet.c.

ResetToDefaultValues()

void SCR_FilterSet::ResetToDefaultValues ( )

inlineprotected

Initializes all filters to their default values.

Definition at line 248 of file SCR_FilterSet.c.

Member Data Documentation

m_aFilterCategories

ref array<ref SCR_FilterCategory> SCR_FilterSet::m_aFilterCategories

protected

Definition at line 199 of file SCR_FilterSet.c.

---

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

• scripts/Game/UI/Menu/Common/SCR_FilterSet.c