SCR_FilterSet Interface Reference

Config class for whole filter set. More...

Public 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!

Member Function Documentation

AnyFilterSelected()

bool SCR_FilterSet.AnyFilterSelected

(

)

FindFilter()

ref SCR_FilterEntry SCR_FilterSet.FindFilter

(

string

internalName

)

Finds a filter entry within categories.

FindFilterCategory()

SCR_FilterCategory SCR_FilterSet.FindFilterCategory

(

string

internalName

)

Finds a filter category by its internal name.

GetFilterCategories()

array< ref SCR_FilterCategory > SCR_FilterSet.GetFilterCategories

(

)

ResetToDefaultValues()

void SCR_FilterSet.ResetToDefaultValues

(

)

Initializes all filters to their default values.

Member Data Documentation

m_aFilterCategories

ref array<ref SCR_FilterCategory> SCR_FilterSet.m_aFilterCategories

protected

---

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

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