SCR_AttributesHelper Interface Reference

Static Public Member Functions
static ParamEnumArray	ParamFromTitles (string titles)
	Parses semicolon-separated string into ParamEnumArray.
static ParamEnumArray	ParamFromDescriptions (TypeName enumType, string descriptions)
	Converts semicolon-separated descriptions into ParamEnumArray for enum type.
static ParamEnumArray	ParamFromEntries (string document)
	Parses pipe-separated descriptions into ParamEnum array.
static string	ParamToEntries (ParamEnumArray enumArray)
	Converts an array of ParamEnum objects into a string with key, value, description format.
static void	SplitEntryIntoValues (string entry, notnull array< string > values, out string title, out string value, out string description, string delimiter=VALUE_DELIMITER)
	Splits entry into title, value, and description.

Static Protected Attributes
static const string	ENTRY_DELIMITER = ";"
static const string	VALUE_DELIMITER = "|"

Member Function Documentation

ParamFromDescriptions()

static ParamEnumArray SCR_AttributesHelper.ParamFromDescriptions ( TypeName enumType, string descriptions )

static

Converts semicolon-separated descriptions into ParamEnumArray for enum type.

Entries with zero-length descriptions are omitted (pre-trimmed).

Parameters

[in]	enumType	Converts separated descriptions into ParamEnumArray for given enum type.
[in]	descriptions	Example: "First Enum; Second Enum; Best Enum"

Returns

an array of ParamEnum objects, each representing an enum value from the provided descriptions.

ParamFromEntries()

static ParamEnumArray SCR_AttributesHelper.ParamFromEntries ( string document )

static

Parses pipe-separated descriptions into ParamEnum array.

Entries with empty titles are preserved. Entry fields are trimmed.

Parameters

[in]

document

e.g "key1|value1;key2;key3|value3|description3;"

Returns

The method takes a string document containing pipe-separated descriptions, extracts each description into title, value, and description,

ParamFromTitles()

static ParamEnumArray SCR_AttributesHelper.ParamFromTitles ( string titles )

static

Parses semicolon-separated string into ParamEnumArray.

Enum value is assumed to be ascending. Entries with zero-length titles are omitted.

Parameters

[in]

titles

Example: First Enum; Second Enum; Best Enum

Returns

an array of ParamEnum objects created from semicolon-separated string titles.

ParamToEntries()

static string SCR_AttributesHelper.ParamToEntries ( ParamEnumArray enumArray )

static

Converts an array of ParamEnum objects into a string with key, value, description format.

Output is compatible with ParamFromEntries.

Parameters

[in]

enumArray

Converts enum array to string with key, value, description format.

Returns

a string containing descriptions for each enum value in the array, separated by '|'.

SplitEntryIntoValues()

static void SCR_AttributesHelper.SplitEntryIntoValues ( string entry, notnull array< string > values, out string title, out string value, out string description, string delimiter = VALUE_DELIMITER )

static

Splits entry into title, value, and description.

Entry values are sperated by delimiter (Default '|')

Parameters

[in]	entry	Input text.
[in]	values	Array that values are split into. Used to reduce allocates from repeated runs.
[out]	title	Title untrimmed.
[out]	value	Value untrimmed.
[out]	description	Description untrimmed.

Member Data Documentation

ENTRY_DELIMITER

const string SCR_AttributesHelper.ENTRY_DELIMITER = ";"

staticprotected

VALUE_DELIMITER

const string SCR_AttributesHelper.VALUE_DELIMITER = "|"

staticprotected

---

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

• Game/Helpers/SCR_AttributesHelper.c