SCR_ConfigHelper Class Reference

Static Protected Member Functions
static BaseContainer	GetChildBaseContainerByPath (notnull BaseContainer container, array< string > paths)
static BaseContainer	GetChildFromList (notnull BaseContainerList containerList, string childName)
static string	SplitConfigPath (string input, out array< string > output, bool removeLastPart=false)
static string	GetGUID (ResourceName resourceName, bool removeBrackets=false)

Detailed Description

Definition at line 1 of file SCR_ConfigHelper.c.

Member Function Documentation

GetChildBaseContainerByPath()

BaseContainer SCR_ConfigHelper::GetChildBaseContainerByPath ( notnull BaseContainer container, array< string > paths )

inlinestaticprotected

returns the found sub-container or null if not found

Parameters

[in]	container	if null, returns null
[in]	paths	case-insensitive, items will be trimmed \ if empty, returns the provided container

Returns

found child BaseContainer, or null if path is incorrect

Definition at line 52 of file SCR_ConfigHelper.c.

GetChildFromList()

BaseContainer SCR_ConfigHelper::GetChildFromList ( notnull BaseContainerList containerList, string childName )

inlinestaticprotected

Get BaseContainer from BaseContainerList by its (case-insensitive) name

Parameters

[in]	containerList	list of containers from which to look
[in]	childName	case-insensitive child name

Returns

BaseContainer found child or null

Definition at line 100 of file SCR_ConfigHelper.c.

GetGUID()

string SCR_ConfigHelper::GetGUID ( ResourceName resourceName, bool removeBrackets = false )

inlinestaticprotected

Extract GUID from full resource name

Parameters

[in]	resourceName	full resource path
[in]	removeBrackets	if true, remove brackets

Returns

resourceName's GUID

Definition at line 159 of file SCR_ConfigHelper.c.

SplitConfigPath()

string SCR_ConfigHelper::SplitConfigPath ( string input, out array< string > output, bool removeLastPart = false )

inlinestaticprotected

split "config path" (separator: / ), trims and toLower parts and returns last part if any

Parameters

[in]	input	the input string
[out]	output	the target output array
[in]	removeLastPart	removes last part if entry path is provided

Returns

last part (trimmed but not ToLower'ed), whether it has been removed or not

Definition at line 133 of file SCR_ConfigHelper.c.

---

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

• scripts/Game/Helpers/SCR_ConfigHelper.c