SCR_ServerConfigListComponent Interface Reference

Script component for handling server config editing UI. More...

Inheritance diagram for SCR_ServerConfigListComponent:

Public Member Functions
ScriptInvokerMissionWorkshopItem	GetOnScenarioSelected ()
ScriptInvokerString	GetOnPortChanged ()
override void	HandlerAttached (Widget w)
void	SelectDefaultScenario ()
void	SelectScenario (notnull MissionWorkshopItem scenario)
MissionWorkshopItem	GetSelectedScenario ()
WorkshopItem	GetScenarioOwnerMod ()
	Return currently selected scenario owner mod as workshop item.
array< MissionWorkshopItem >	GetDefaultScenarios ()
array< MissionWorkshopItem >	GetModdedScenarios ()
void	FillFromDSConfig (notnull SCR_DSConfig config)
	Fill all entries with values from given DS config.
void	ScrollToTheEntry (notnull Widget w)
	Scroll to the selected entry.
void	SetPort (string port)
string	GenerateFileName (notnull MissionWorkshopItem scenario)
	Generate server name to the name editbox in case name wasn't edited.
Public Member Functions inherited from SCR_ConfigListComponent
override void	HandlerAttached (Widget w)
array< ref SCR_WidgetListEntry >	GetInitialEntryList ()
SCR_WidgetListEntry	FindEntry (string propertyName, string groupTag="")
	Find variable of given property name and group tag - no group tag find any variable of given property name.
Widget	GetInvalidEntry ()
	Go through list and check if values are correct Return first invalid entry widget Return null if all values are valid.

Protected Member Functions
void	FillScenarios ()
	Fill scenario selection with list of available scenarios.
void	FillScenarioSources ()
void	InsertScenarioToMap (MissionWorkshopItem scenario, WorkshopItem modOwner)
	Insert scenario and sorces to scenario sources mod map If scenario name is reapeate, insert source mod in to existing scenario
int	GetScenarioIndexById (string scenarioId)
void	ConsoleSetup ()
	Apply console specific properties.
void	OnNameChanged (SCR_EditBoxComponent edit, string text)
void	OnSimplePortChanged (SCR_EditBoxComponent edit, string text)
void	OnFileNameChanged (SCR_EditBoxComponent edit, string text)
void	OnSelectScenario (SCR_ComboBoxComponent comboBox, int selected)
void	GenerateName (notnull MissionWorkshopItem scenario)
	Generate server name to the name editbox in case name wasn't edited.
void	SetupPlayerLimit (int limit)

Protected Attributes
SCR_WidgetListEntryEditBox	m_NameEdit
SCR_WidgetListEntryEditBox	m_SimplePortEdit
SCR_WidgetListEntrySelection	m_ScenarioSelect
SCR_WidgetListEntrySelection	m_ScenarioModSelect
SCR_WidgetListEntrySelection	m_BattleyeSelect
SCR_WidgetListEntrySelection	m_CrossplaySelect
SCR_WidgetListEntrySlider	m_PlayerListSlider
SCR_WidgetListEntrySlider	m_JoinQueueSizeSlider
bool	m_bNameEdited
bool	m_bFileNameEdited
ref array< ref SCR_ScenarioSources >	m_aScenarioSources = {}
ref ScriptInvokerMissionWorkshopItem	m_OnScenarioSelected
ref ScriptInvokerString	m_OnPortChanged
Protected Attributes inherited from SCR_ConfigListComponent
string	m_sListParent
ref array< ref SCR_WidgetListEntry >	m_aInitialEntryList
Widget	m_Root
ScrollLayoutWidget	m_wScrollWidget
VerticalLayoutWidget	m_wList

Static Protected Attributes
const string	NAME_ENTRY = "name"
const string	FILE_NAME_ENTRY = "fileName"
const string	SCENARIO_SELECTION_ENTRY = "scenarioId"
const string	SCENARIO_MOD_SELECTION_ENTRY = "scenarioModId"
const string	PLAYER_LIMIT_ENTRY = "maxPlayers"
const string	JOIN_QUEUE_MAX_SIZE = "joinQueueMaxSize"
const string	BATTLEYE = "battlEye"
const string	CROSSPLAY = "crossPlatform"
const string	SIMPLE_PORT = "publicPortSimple"
const string	SERVER_NAME_BASE = "%1 %2"
const string	FILE_NAME_BASE = "Config_%1"
const string	CHAR_BLACK_LIST = "<>:\/\|?*."

Detailed Description

Script component for handling server config editing UI.

Member Function Documentation

ConsoleSetup()

void SCR_ServerConfigListComponent.ConsoleSetup ( )

protected

Apply console specific properties.

FillFromDSConfig()

void SCR_ServerConfigListComponent.FillFromDSConfig

(

notnull SCR_DSConfig

config

)

Fill all entries with values from given DS config.

FillScenarios()

void SCR_ServerConfigListComponent.FillScenarios ( )

protected

Fill scenario selection with list of available scenarios.

FillScenarioSources()

void SCR_ServerConfigListComponent.FillScenarioSources ( )

protected

GenerateFileName()

string SCR_ServerConfigListComponent.GenerateFileName

(

notnull MissionWorkshopItem

scenario

)

Generate server name to the name editbox in case name wasn't edited.

GenerateName()

void SCR_ServerConfigListComponent.GenerateName ( notnull MissionWorkshopItem  scenario )

protected

Generate server name to the name editbox in case name wasn't edited.

GetDefaultScenarios()

array< MissionWorkshopItem > SCR_ServerConfigListComponent.GetDefaultScenarios

(

)

GetModdedScenarios()

array< MissionWorkshopItem > SCR_ServerConfigListComponent.GetModdedScenarios

(

)

GetOnPortChanged()

ScriptInvokerString SCR_ServerConfigListComponent.GetOnPortChanged

(

)

GetOnScenarioSelected()

ScriptInvokerMissionWorkshopItem SCR_ServerConfigListComponent.GetOnScenarioSelected

(

)

GetScenarioIndexById()

int SCR_ServerConfigListComponent.GetScenarioIndexById ( string  scenarioId )

protected

GetScenarioOwnerMod()

WorkshopItem SCR_ServerConfigListComponent.GetScenarioOwnerMod

(

)

Return currently selected scenario owner mod as workshop item.

GetSelectedScenario()

MissionWorkshopItem SCR_ServerConfigListComponent.GetSelectedScenario

(

)

HandlerAttached()

override void SCR_ServerConfigListComponent.HandlerAttached

(

Widget

w

)

Implements SCR_ConfigListComponent.

InsertScenarioToMap()

void SCR_ServerConfigListComponent.InsertScenarioToMap ( MissionWorkshopItem  scenario, WorkshopItem  modOwner  )

protected

Insert scenario and sorces to scenario sources mod map If scenario name is reapeate, insert source mod in to existing scenario

OnFileNameChanged()

void SCR_ServerConfigListComponent.OnFileNameChanged ( SCR_EditBoxComponent  edit, string  text  )

protected

OnNameChanged()

void SCR_ServerConfigListComponent.OnNameChanged ( SCR_EditBoxComponent  edit, string  text  )

protected

OnSelectScenario()

void SCR_ServerConfigListComponent.OnSelectScenario ( SCR_ComboBoxComponent  comboBox, int  selected  )

protected

OnSimplePortChanged()

void SCR_ServerConfigListComponent.OnSimplePortChanged ( SCR_EditBoxComponent  edit, string  text  )

protected

ScrollToTheEntry()

void SCR_ServerConfigListComponent.ScrollToTheEntry

(

notnull Widget

w

)

Scroll to the selected entry.

SelectDefaultScenario()

void SCR_ServerConfigListComponent.SelectDefaultScenario

(

)

SelectScenario()

void SCR_ServerConfigListComponent.SelectScenario

(

notnull MissionWorkshopItem

scenario

)

SetPort()

void SCR_ServerConfigListComponent.SetPort

(

string

port

)

SetupPlayerLimit()

void SCR_ServerConfigListComponent.SetupPlayerLimit ( int  limit )

protected

Member Data Documentation

BATTLEYE

const string SCR_ServerConfigListComponent.BATTLEYE = "battlEye"

staticprotected

CHAR_BLACK_LIST

const string SCR_ServerConfigListComponent.CHAR_BLACK_LIST = "<>:\/\|?*."

staticprotected

CROSSPLAY

const string SCR_ServerConfigListComponent.CROSSPLAY = "crossPlatform"

staticprotected

FILE_NAME_BASE

const string SCR_ServerConfigListComponent.FILE_NAME_BASE = "Config_%1"

staticprotected

FILE_NAME_ENTRY

const string SCR_ServerConfigListComponent.FILE_NAME_ENTRY = "fileName"

staticprotected

JOIN_QUEUE_MAX_SIZE

const string SCR_ServerConfigListComponent.JOIN_QUEUE_MAX_SIZE = "joinQueueMaxSize"

staticprotected

m_aScenarioSources

ref array<ref SCR_ScenarioSources> SCR_ServerConfigListComponent.m_aScenarioSources = {}

protected

m_BattleyeSelect

SCR_WidgetListEntrySelection SCR_ServerConfigListComponent.m_BattleyeSelect

protected

m_bFileNameEdited

bool SCR_ServerConfigListComponent.m_bFileNameEdited

protected

m_bNameEdited

bool SCR_ServerConfigListComponent.m_bNameEdited

protected

m_CrossplaySelect

SCR_WidgetListEntrySelection SCR_ServerConfigListComponent.m_CrossplaySelect

protected

m_JoinQueueSizeSlider

SCR_WidgetListEntrySlider SCR_ServerConfigListComponent.m_JoinQueueSizeSlider

protected

m_NameEdit

SCR_WidgetListEntryEditBox SCR_ServerConfigListComponent.m_NameEdit

protected

m_OnPortChanged

ref ScriptInvokerString SCR_ServerConfigListComponent.m_OnPortChanged

protected

m_OnScenarioSelected

ref ScriptInvokerMissionWorkshopItem SCR_ServerConfigListComponent.m_OnScenarioSelected

protected

m_PlayerListSlider

SCR_WidgetListEntrySlider SCR_ServerConfigListComponent.m_PlayerListSlider

protected

m_ScenarioModSelect

SCR_WidgetListEntrySelection SCR_ServerConfigListComponent.m_ScenarioModSelect

protected

m_ScenarioSelect

SCR_WidgetListEntrySelection SCR_ServerConfigListComponent.m_ScenarioSelect

protected

m_SimplePortEdit

SCR_WidgetListEntryEditBox SCR_ServerConfigListComponent.m_SimplePortEdit

protected

NAME_ENTRY

const string SCR_ServerConfigListComponent.NAME_ENTRY = "name"

staticprotected

PLAYER_LIMIT_ENTRY

const string SCR_ServerConfigListComponent.PLAYER_LIMIT_ENTRY = "maxPlayers"

staticprotected

SCENARIO_MOD_SELECTION_ENTRY

const string SCR_ServerConfigListComponent.SCENARIO_MOD_SELECTION_ENTRY = "scenarioModId"

staticprotected

SCENARIO_SELECTION_ENTRY

const string SCR_ServerConfigListComponent.SCENARIO_SELECTION_ENTRY = "scenarioId"

staticprotected

SERVER_NAME_BASE

const string SCR_ServerConfigListComponent.SERVER_NAME_BASE = "%1 %2"

staticprotected

SIMPLE_PORT

const string SCR_ServerConfigListComponent.SIMPLE_PORT = "publicPortSimple"

staticprotected

---

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

• Game/UI/Menu/ServerBrowser/ServerHosting/SCR_ServerConfigListComponent.c