SCR_AttributesHelper Class Reference

Static Protected Member Functions
static ParamEnumArray	ParamFromTitles (string titles)
static ParamEnumArray	ParamFromDescriptions (typename enumType, string descriptions)
static ParamEnumArray	ParamFromEntries (string document)
static string	ParamToEntries (ParamEnumArray enumArray)
static void	SplitEntryIntoValues (string entry, notnull array< string > values, out string title, out string value, out string description, string delimiter=VALUE_DELIMITER)

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

Detailed Description

Definition at line 1 of file SCR_AttributesHelper.c.

Member Function Documentation

ParamFromDescriptions()

ParamEnumArray SCR_AttributesHelper::ParamFromDescriptions ( typename enumType , string descriptions )

inlinestaticprotected

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.

Definition at line 31 of file SCR_AttributesHelper.c.

ParamFromEntries()

ParamEnumArray SCR_AttributesHelper::ParamFromEntries ( string document )

inlinestaticprotected

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,

Definition at line 52 of file SCR_AttributesHelper.c.

ParamFromTitles()

ParamEnumArray SCR_AttributesHelper::ParamFromTitles ( string titles )

inlinestaticprotected

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.

Definition at line 11 of file SCR_AttributesHelper.c.

ParamToEntries()

string SCR_AttributesHelper::ParamToEntries ( ParamEnumArray enumArray )

inlinestaticprotected

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 '|'.

Definition at line 74 of file SCR_AttributesHelper.c.

SplitEntryIntoValues()

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

inlinestaticprotected

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.

Definition at line 93 of file SCR_AttributesHelper.c.

Member Data Documentation

ENTRY_DELIMITER

const string SCR_AttributesHelper::ENTRY_DELIMITER = ";"

staticprotected

Definition at line 3 of file SCR_AttributesHelper.c.

VALUE_DELIMITER

const string SCR_AttributesHelper::VALUE_DELIMITER = "|"

staticprotected

Definition at line 4 of file SCR_AttributesHelper.c.

---

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

• scripts/Game/Helpers/SCR_AttributesHelper.c