FilteredServerParams Interface Reference

Server search filtering. More...

Inheritance diagram for FilteredServerParams:

Public Member Functions
override void	OnPack ()
void	AddModId (string sId)
void	ClearModIds ()
void	SetHostAddress (string address)
	Setup host address param and clear join code.
void	SetJoinCode (string joinCode)
	Setup join code param and clear host address.
void	FilteredServerParams ()
void	SetFilters (SCR_FilterSet filterSet)
	Go through filters in categories and create uncategorized filter list.
void	SetFavoriteFilter (bool isAllowed)
bool	GetFavoriteFilter ()
void	SetRecentlyPlayedFilter (bool isAllowed)
bool	GetRecentlyPlayedFilter ()
void	SetOfficialFilter (bool displayOfficial)
void	SetCommunityFilter (bool displayCommunity)
void	SetSorting (string mOrder, bool bAscendent)
string	GetSortOrder ()
void	SetSearch (string sInput)
string	GetSearchText ()
string	GetScenarioId ()
void	SetScenarioId (string id)
string	GetHostedScenarioModId ()
void	SetHostedScenarioModId (string id)
bool	IsModdedFilterSelected ()
void	SetOwnedOnly (bool showOwned)
void	SetUsePlayerLimit (bool use)

Static Public Attributes
const int	RECENT_SERVERS_SECONDS = 60 * 60 * 24 * 7
const string	FILTER_FAVORITES = "favorites"
const string	FILTER_RECENT_SERVERS = "oldestJoinInSeconds"
const string	FILTER_MODDED = "modded"
const string	FILTER_OFFICIAL = "official"
const string	FILTER_COMMUNITY = "community"
const string	FILTER_CROSS_PLAY = "gameClientFilter"
const string	FILTER_VERSION = "gameVersion"
const string	SORT_ASCENDENT = "ascendent"
const string	SORT_NAME = "SessionName"
const string	SORT_PING = "Ping"
const string	CATEGORY_PLAYERS = "Players"
const string	CATEGORY_VERSION = "Version"
const string	VALUE_PLAYERS_MIN = "minPlayersPercent"
const string	VALUE_PLAYERS_MAX = "maxPlayersPercent"
const string	VALUE_PLAYERS_MIN_COUNT = "minPlayersCount"
const string	VALUE_PLAYERS_MAX_COUNT = "maxPlayersCount"

Protected Member Functions
SCR_FilterEntryRoom	FindFilterByInternalName (array< ref SCR_FilterEntryRoom > filters, string internalName)
	Return filter with given internal name. Find filter within categories.
void	ActivateFilterValues (SCR_FilterEntryRoom filter)
	Store all velues in filter array.
void	FormatePlayersFilters (out int min, out int max, out int minCount, out int maxCount)
	Agregate combination of player filter to gain player count range.

Protected Attributes
ref SCR_FilterSet	m_Filter
ref array< SCR_FilterEntryRoom >	m_aFiltersUncategorized = {}
ref array< ref SCR_FilterEntryRoom >	m_aDefaultFilters = {}
ref array< string >	modIds = new array<string>
string	text = ""
string	hostAddress = ""
string	directJoinCode = ""
string	scenarioId = ""
string	hostedScenarioModId = ""
string	order = SORT_NAME
bool	m_bOfficialOn = false
bool	m_bCommunityOn = false
bool	m_bFavoriteFilterOn = false
bool	m_bRecentlyPlayedOn = false
bool	m_bModdedFilterSelected
bool	m_bCrossPlayFilterSelected
bool	m_bUsePlayerLimit = true

Detailed Description

Server search filtering.

Constructor & Destructor Documentation

FilteredServerParams()

void FilteredServerParams.FilteredServerParams

(

)

Member Function Documentation

ActivateFilterValues()

void FilteredServerParams.ActivateFilterValues ( SCR_FilterEntryRoom filter )

protected

Store all velues in filter array.

AddModId()

void FilteredServerParams.AddModId

(

string

sId

)

ClearModIds()

void FilteredServerParams.ClearModIds

(

)

FindFilterByInternalName()

SCR_FilterEntryRoom FilteredServerParams.FindFilterByInternalName ( array< ref SCR_FilterEntryRoom > filters, string internalName )

protected

Return filter with given internal name. Find filter within categories.

FormatePlayersFilters()

void FilteredServerParams.FormatePlayersFilters ( out int min, out int max, out int minCount, out int maxCount )

protected

Agregate combination of player filter to gain player count range.

GetFavoriteFilter()

bool FilteredServerParams.GetFavoriteFilter

(

)

GetHostedScenarioModId()

string FilteredServerParams.GetHostedScenarioModId

(

)

GetRecentlyPlayedFilter()

bool FilteredServerParams.GetRecentlyPlayedFilter

(

)

GetScenarioId()

string FilteredServerParams.GetScenarioId

(

)

GetSearchText()

string FilteredServerParams.GetSearchText

(

)

GetSortOrder()

string FilteredServerParams.GetSortOrder

(

)

IsModdedFilterSelected()

bool FilteredServerParams.IsModdedFilterSelected

(

)

OnPack()

override void FilteredServerParams.OnPack

(

)

SetCommunityFilter()

void FilteredServerParams.SetCommunityFilter

(

bool

displayCommunity

)

SetFavoriteFilter()

void FilteredServerParams.SetFavoriteFilter

(

bool

isAllowed

)

SetFilters()

void FilteredServerParams.SetFilters

(

SCR_FilterSet

filterSet

)

Go through filters in categories and create uncategorized filter list.

SetHostAddress()

void FilteredServerParams.SetHostAddress

(

string

address

)

Setup host address param and clear join code.

SetHostedScenarioModId()

void FilteredServerParams.SetHostedScenarioModId

(

string

id

)

SetJoinCode()

void FilteredServerParams.SetJoinCode

(

string

joinCode

)

Setup join code param and clear host address.

SetOfficialFilter()

void FilteredServerParams.SetOfficialFilter

(

bool

displayOfficial

)

SetOwnedOnly()

void FilteredServerParams.SetOwnedOnly

(

bool

showOwned

)

SetRecentlyPlayedFilter()

void FilteredServerParams.SetRecentlyPlayedFilter

(

bool

isAllowed

)

SetScenarioId()

void FilteredServerParams.SetScenarioId

(

string

id

)

SetSearch()

void FilteredServerParams.SetSearch

(

string

sInput

)

SetSorting()

void FilteredServerParams.SetSorting	(	string	mOrder,
		bool	bAscendent )

SetUsePlayerLimit()

void FilteredServerParams.SetUsePlayerLimit

(

bool

use

)

Member Data Documentation

CATEGORY_PLAYERS

const string FilteredServerParams.CATEGORY_PLAYERS = "Players"

static

CATEGORY_VERSION

const string FilteredServerParams.CATEGORY_VERSION = "Version"

static

directJoinCode

string FilteredServerParams.directJoinCode = ""

protected

FILTER_COMMUNITY

const string FilteredServerParams.FILTER_COMMUNITY = "community"

static

FILTER_CROSS_PLAY

const string FilteredServerParams.FILTER_CROSS_PLAY = "gameClientFilter"

static

FILTER_FAVORITES

const string FilteredServerParams.FILTER_FAVORITES = "favorites"

static

FILTER_MODDED

const string FilteredServerParams.FILTER_MODDED = "modded"

static

FILTER_OFFICIAL

const string FilteredServerParams.FILTER_OFFICIAL = "official"

static

FILTER_RECENT_SERVERS

const string FilteredServerParams.FILTER_RECENT_SERVERS = "oldestJoinInSeconds"

static

FILTER_VERSION

const string FilteredServerParams.FILTER_VERSION = "gameVersion"

static

hostAddress

string FilteredServerParams.hostAddress = ""

protected

hostedScenarioModId

string FilteredServerParams.hostedScenarioModId = ""

protected

m_aDefaultFilters

ref array<ref SCR_FilterEntryRoom> FilteredServerParams.m_aDefaultFilters = {}

protected

m_aFiltersUncategorized

ref array<SCR_FilterEntryRoom> FilteredServerParams.m_aFiltersUncategorized = {}

protected

m_bCommunityOn

bool FilteredServerParams.m_bCommunityOn = false

protected

m_bCrossPlayFilterSelected

bool FilteredServerParams.m_bCrossPlayFilterSelected

protected

m_bFavoriteFilterOn

bool FilteredServerParams.m_bFavoriteFilterOn = false

protected

m_bModdedFilterSelected

bool FilteredServerParams.m_bModdedFilterSelected

protected

m_bOfficialOn

bool FilteredServerParams.m_bOfficialOn = false

protected

m_bRecentlyPlayedOn

bool FilteredServerParams.m_bRecentlyPlayedOn = false

protected

m_bUsePlayerLimit

bool FilteredServerParams.m_bUsePlayerLimit = true

protected

m_Filter

ref SCR_FilterSet FilteredServerParams.m_Filter

protected

modIds

ref array<string> FilteredServerParams.modIds = new array<string>

protected

order

string FilteredServerParams.order = SORT_NAME

protected

RECENT_SERVERS_SECONDS

const int FilteredServerParams.RECENT_SERVERS_SECONDS = 60 * 60 * 24 * 7

static

scenarioId

string FilteredServerParams.scenarioId = ""

protected

SORT_ASCENDENT

const string FilteredServerParams.SORT_ASCENDENT = "ascendent"

static

SORT_NAME

const string FilteredServerParams.SORT_NAME = "SessionName"

static

SORT_PING

const string FilteredServerParams.SORT_PING = "Ping"

static

text

string FilteredServerParams.text = ""

protected

VALUE_PLAYERS_MAX

const string FilteredServerParams.VALUE_PLAYERS_MAX = "maxPlayersPercent"

static

VALUE_PLAYERS_MAX_COUNT

const string FilteredServerParams.VALUE_PLAYERS_MAX_COUNT = "maxPlayersCount"

static

VALUE_PLAYERS_MIN

const string FilteredServerParams.VALUE_PLAYERS_MIN = "minPlayersPercent"

static

VALUE_PLAYERS_MIN_COUNT

const string FilteredServerParams.VALUE_PLAYERS_MIN_COUNT = "minPlayersCount"

static

---

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

• Game/UI/Menu/ServerBrowser/ServerBrowserFiltering.c