SCR_ParamEnumArray Interface Reference

Inheritance diagram for SCR_ParamEnumArray:

Static Public Member Functions
static ParamEnumArray	FromString (string input)
	Get ComboBox entries from string, format:

Static Protected Attributes
static const string	ENTRY_SEPARATOR = ";"
static const string	VALUE_SEPARATOR = ","
static const string	ESCAPE_CHARACTER = "'"

Member Function Documentation

FromString()

static ParamEnumArray SCR_ParamEnumArray.FromString ( string input )

static

Get ComboBox entries from string, format:

• "text1;text2;text3"
• "text1,desc1;text2,desc2;text3,desc3"
• "value1,text1,desc1;value2,text2,desc2;value3,text3,desc3" If value is not defined, array index is used ("0", "1", "2", etc)

  Note

  commas and semicolons can be escaped using a single quote (" ', ", " '; ")

  Parameters

  [in]

  input

  format can be (entries are separated by semicolons ";"):

• text
• text,description
• value,text,description (if there is no description, use a trailing comma to keep an empty description e.g "value,text,")

  Returns

  the resulting ParamEnumArray - never null

Member Data Documentation

ENTRY_SEPARATOR

const string SCR_ParamEnumArray.ENTRY_SEPARATOR = ";"

staticprotected

ESCAPE_CHARACTER

const string SCR_ParamEnumArray.ESCAPE_CHARACTER = "'"

staticprotected

VALUE_SEPARATOR

const string SCR_ParamEnumArray.VALUE_SEPARATOR = ","

staticprotected

---

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

• Game/Global/SCR_ParamEnumArray.c