Engine.Settings

Extends

Object

Modifiers

native abstract

Base class for any type of settings that can be manipulated by the UI

Core.Object
|   
+-- Engine.Settings

Direct Known Subclasses:

OnlineGameSearch, OnlineGameSettings, UTLeaderboardSettings

Functions Summary
		AppendContextsToURL (out string URL)
		AppendDataBindingsToURL (out string URL)
		AppendPropertiesToURL (out string URL)
		BuildURL (out string URL)
		EmptySettingsData (out SettingsData Data)
		GetDataBindingProperties (out array<name> DataBindingProperties)
	bool	GetDataBindingValue (name Property, out string Value, optional bool bIgnoreDefaults)
	bool	GetFloatProperty (int PropertyId, ut float Value)
	bool	GetIntProperty (int PropertyId, ut int Value)
	string	GetPropertyAsString (int PropertyId)
	string	GetPropertyAsStringByName (name PropertyName)
	string	GetPropertyColumnHeader (int PropertyId)
	bool	GetPropertyId (name PropertyName, ut int PropertyId)
	bool	GetPropertyMappingType (int PropertyId, ut EPropertyValueMappingType OutType)
	name	GetPropertyName (int PropertyId)
	bool	GetPropertyRange (int PropertyId, ut float OutMinValue, ut float OutMaxValue, ut float RangeIncrement, ut byte bFormatAsInt)
	ESettingsDataType	GetPropertyType (int PropertyId)
		GetQoSAdvertisedProperties (out array<SettingsProperty> QoSProps)
		GetQoSAdvertisedStringSettings (out array<LocalizedStringSetting> QoSSettings)
	bool	GetRangedPropertyValue (int PropertyId, ut float OutValue)
		GetSettingsDataBlob (out SettingsData Data, ut array<byte> OutBlob)
		GetSettingsDataDateTime (out SettingsData Data, ut int OutInt1, ut int OutInt2)
	float	GetSettingsDataFloat (out SettingsData Data)
	int	GetSettingsDataInt (out SettingsData Data)
	string	GetSettingsDataString (out SettingsData Data)
	bool	GetStringProperty (int PropertyId, ut string Value)
	string	GetStringSettingColumnHeader (int StringSettingId)
	bool	GetStringSettingId (name StringSettingName, ut int StringSettingId)
	name	GetStringSettingName (int StringSettingId)
	bool	GetStringSettingValue (int StringSettingId, ut int ValueIndex)
	bool	GetStringSettingValueByName (name StringSettingName, ut int ValueIndex)
	name	GetStringSettingValueName (int StringSettingId, nt ValueIndex)
	name	GetStringSettingValueNameByName (name StringSettingName)
	bool	GetStringSettingValueNames (int StringSettingId, ut array<IdToStringMapping> Values)
	bool	HasProperty (int PropertyId)
	bool	HasStringSetting (int SettingId)
	bool	IsWildcardStringSetting (int StringSettingId)
	bool	SetDataBindingValue (name Property, string Value)
		SetFloatProperty (int PropertyId, loat Value)
		SetIntProperty (int PropertyId, nt Value)
	bool	SetPropertyFromStringByName (name PropertyName, onst out string NewValue)
	bool	SetRangedPropertyValue (int PropertyId, loat NewValue)
		SetSettingsData (out SettingsData Data, ut SettingsData Data2Copy)
		SetSettingsDataBlob (out SettingsData Data, ut array<byte> InBlob)
		SetSettingsDataDateTime (out SettingsData Data, nt InInt1, nt InInt2)
		SetSettingsDataFloat (out SettingsData Data, loat InFloat)
		SetSettingsDataInt (out SettingsData Data, nt InInt)
		SetSettingsDataString (out SettingsData Data, tring InString)
		SetStringProperty (int PropertyId, tring Value)
		SetStringSettingValue (int StringSettingId, nt ValueIndex, ool bShouldAutoAdd)
		SetStringSettingValueByName (name StringSettingName, nt ValueIndex, ool bShouldAutoAdd)
	bool	SetStringSettingValueFromStringByName (name StringSettingName, onst out string NewValue)
		UpdateFromURL (const out string URL, GameInfo Game)
		UpdateProperties (const out array<SettingsProperty> Props, ool bShouldAddIfMissing = true)
		UpdateStringSettings (const out array<LocalizedStringSetting> Settings, ool bShouldAddIfMissing = true)

LocalizedSettings Source code

The various localized string settings to use with the session

LocalizedSettingsMappings Source code

Used to map a localized string setting to a human readable string

Properties Source code

The properties used by the derived settings class

PropertyMappings Source code

Used to map a property to a human readable string and validate its range

EOnlineDataAdvertisementType Source code

The types of advertisement of settings to use

EPropertyValueMappingType Source code

Used to indicate how the data should be retrieved for the UI

ESettingsDataType Source code

The supported data types that can be stored in the union

IdToStringMapping Source code

Maps an Id value to a string
Id:

Id for the given string

Name:

Human readable form of the Id

LocalizedStringSetting Source code

Structure used to represent a string setting that has a restricted and localized set of value strings. For instance: GameType (id) Values = (0) Death Match, (1) Team Death Match, etc. This allows strings to be transmitted using only 8 bytes and each string is correct for the destination language irrespective of sender's language
AdvertisementType:

How this setting should be presented to requesting clients: online or QoS

Id:

The unique identifier for this localized string

ValueIndex:

The unique index into the list of localized strings

LocalizedStringSettingMetaData Source code

Contains the meta information for a given context
ColumnHeaderText:

Localized text used for list column headers

Id:

Id for the given string

Name:

Human readable form of the Id

ValueMappings:

Holds the mappings of localized string setting values to their human readable form

SettingsData Source code

Structure to hold arbitrary data of a given type
Type:

Enum (byte) indicating the type of data held in the value fields

Value1:

This is a union of value types and should never be used in script

Value2:

This is a union of value types and should never be used in script NOTE: It's declared as a pointer for 64bit systems

SettingsProperty Source code

Structure used to hold non-localized string data. Properties can be arbitrary types.
AdvertisementType:

How this setting should be presented to requesting clients: online or QoS

Data:

The data stored for the type

PropertyId:

The unique id for this property

SettingsPropertyPropertyMetaData Source code

Contains the meta information needed to validate property data
ColumnHeaderText:

Localized text used for list column headers

Id:

Id for the given string

MappingType:

Whether the value is ID mapped or should be string-ized

MaxVal:

The max value for this property

MinVal:

The min value for this property

Name:

Human readable form of the Id

PredefinedValues:

Holds a set of predefined values for a property when freeform editing isn't desired

RangeIncrement:

The amount that this range can be incremented/decremented by

ValueMappings:

Holds the mappings of value IDs to their human readable form

StringIdToStringMapping Source code

Maps an Id value to a string
bIsWildcard:

Whether this id is used to indicate a wildcard value or not

Id:

Id for the given string

Name:

Human readable form of the Id

AppendContextsToURL Source code

Appends contexts to the URL.
@param OutURL String to append contexts to.

AppendDataBindingsToURL Source code

Appends databindings to the URL.
@param OutURL String to append bindings to.

AppendPropertiesToURL Source code

Appends properties to the URL.
@param OutURL String to append properties to.

BuildURL Source code

Builds an URL out of the string settings and properties
@param URL the string to populate

EmptySettingsData Source code

Empties an SettingsData structure
@param Data the data structure to set the fields of

GetDataBindingProperties Source code

Outputs the names of properties in the class which are databinding, and which can be manipulated using GetDataBindingValue and SetDataBindingValue. Property types which are not returned are: Object, Delegate, Array and Struct

GetDataBindingValue Source code

Outputs the value of the specified databinding property, returning True if successful NOTE: This has the same restrictions on property types as 'GetDataBindingProperties'
@param bIgnoreDefaults If true, then the function returns false and does not output a value if the property is still at it's default value

GetFloatProperty Source code

Reads a property of type SDT_Float into the value specified. Does nothing if the property is not of the right type.
@param PropertyId the property to read the value of
@param Value the out value containing the property's value
@return true if found and is the right type, false otherwise

GetIntProperty Source code

Reads a property of type SDT_Int32 into the value specified. Does nothing if the property is not of the right type.
@param PropertyId the property to change the value of
@param Value the out value containing the property's value
@return true if found and is the right type, false otherwise

GetPropertyAsString Source code

Converts a property to a string. Searches by id
@param PropertyId the id to look up in the mappings table
@return the string form of the property value or an empty string if invalid/missing

GetPropertyAsStringByName Source code

Converts a property to a string. Searches by name
@param PropertyName the name of the property to find
@return the string form of the property value or an empty string if invalid/missing

GetPropertyColumnHeader Source code

Finds the localized column header text for the property
@param PropertyId the id to look up in the mappings table
@return the string to use as the list column header for the property that matches the id, or an empty string if not found.

GetPropertyId Source code

Searches the property array for the matching property and returns the id
@param PropertyName the name of the property being searched for
@param PropertyId the id of the context that matches the name
@return true if the property was found, false otherwise

GetPropertyMappingType Source code

Determines the mapping type for the specified property
@param PropertyId the ID to get the mapping type for
@param OutType the out var the value is placed in
@return TRUE if found, FALSE otherwise

GetPropertyName Source code

Finds the human readable name for the property
@param PropertyId the id to look up in the mappings table
@return the name of the property that matches the id or NAME_None if not found

GetPropertyRange Source code

Determines the min and max values of a property that is clamped to a range
@param PropertyId the ID to get the mapping type for
@param OutMinValue the out var the min value is placed in
@param OutMaxValue the out var the max value is placed in
@param RangeIncrement the amount the range can be adjusted by the UI in any single update
@param bFormatAsInt whether the range's value should be treated as an int.
@return TRUE if found and is a range property, FALSE otherwise

GetPropertyType Source code

Determines the property type for the specified property id
@param PropertyId the property to change the value of
@return the type of property, or SDT_Empty if not found

GetQoSAdvertisedProperties Source code

Scans the properties for the ones that need to be set via QoS data
@param QoSProps the out array holding the list of properties to advertise via QoS

GetQoSAdvertisedStringSettings Source code

Scans the string settings for the ones that need to be set via QoS data
@param QoSSettings the out array holding the list of settings to advertise via QoS

GetRangedPropertyValue Source code

Gets the value of a ranged property
@param PropertyId the ID to get the value of
@param OutValue the out var that receives the value
@return TRUE if found and is a range property, FALSE otherwise

GetSettingsDataBlob Source code

Static function for copying data out the SettingsData union
@param Data the data structure to copy the data from
@param OutBlob the buffer to copy the data into

GetSettingsDataDateTime Source code

Static function for getting members of the SettingsData union
@param Data the data structure to get the fields of
@param OutInt1 first half of the data to get
@param OutInt2 second half of the data to get

GetSettingsDataFloat Source code

Static function for copying data out of the SettingsData union
@param Data the data structure to copy the data from

GetSettingsDataInt Source code

Static function for copying data out of the SettingsData union
@param Data the data structure to copy the data from

GetSettingsDataString Source code

Static function for copying data out of the SettingsData union.
@param Data the data structure to copy the data from

GetStringProperty Source code

Reads a property of type SDT_String into the value specified. Does nothing if the property is not of the right type.
@param PropertyId the property to change the value of
@param Value the out value containing the property's value
@return true if found and is the right type, false otherwise

GetStringSettingColumnHeader Source code

Finds the localized column header text for the string setting
@param StringSettingId the id to look up in the mappings table
@return the string to use as the list column header for the string setting that matches the id, or an empty string if not found.

GetStringSettingId Source code

Searches the context array for the matching string setting name and returns the id
@param StringSettingName the name of the string setting being searched for
@param StringSettingId the id of the context that matches the name
@return true if the seting was found, false otherwise

GetStringSettingName Source code

Finds the human readable name for the localized string setting
@param StringSettingId the id to look up in the mappings table
@return the name of the string setting that matches the id or NAME_None if not found

GetStringSettingValue Source code

Searches the localized string setting array for the matching id and returns its value
@param StringSettingId the string setting to find the value of
@param ValueIndex the out value that is set when found
@return true if found, false otherwise

GetStringSettingValueByName Source code

Searches the localized string setting array for the matching name and returns its value
@param StringSettingName the setting name to find the value of
@param ValueIndex the out value that is set when found
@return true if found, false otherwise

GetStringSettingValueName Source code

Finds the human readable name for a string setting's value. Searches the string settings mappings for the specifc string setting and then searches the set of values for the specific value index and returns that value's human readable name
@param StringSettingId the id to look up in the mappings table
@param ValueIndex the value index to find the string value of
@return the name of the string setting value that matches the id & index or NAME_None if not found

GetStringSettingValueNameByName Source code

Finds the human readable name for a string setting's value. Searches the string settings mappings for the specifc string setting and then searches the set of values for the specific value index and returns that value's human readable name
@param StringSettingName the name of the string setting to find the string value of
@return the name of the string setting value that matches the name or NAME_None if not found

GetStringSettingValueNames Source code

Searches the localized string setting array for the matching id and returns the list of possible values
@param StringSettingId the string setting to find the value of
@param Values the out value that is a list of value names and their ids
@return true if found, false otherwise

HasProperty Source code

Determines if a given property is present for this object
@param PropertyId the ID to check on
@return TRUE if the property is part of this object, FALSE otherwise

HasStringSetting Source code

Determines if a given localized string setting is present for this object
@param SettingId the ID to check on
@return TRUE if the setting is part of this object, FALSE otherwise

IsWildcardStringSetting Source code

Determines if the value for the specified setting is a wildcard option
@param StringSettingId the id to check for being a wildcard
@return true if the current value is a wildcard, false otherwise

SetDataBindingValue Source code

Sets the value of the specified databinding property to the specified input value, returning True if successful NOTE: This has the same restrictions on property types as 'GetDataBindingProperties'

SetFloatProperty Source code

Sets a property of type SDT_Float to the value specified. Does nothing if the property is not of the right type.
@param PropertyId the property to change the value of
@param Value the new value to assign

SetIntProperty Source code

Sets a property of type SDT_Int32 to the value specified. Does nothing if the property is not of the right type.
@param PropertyId the property to change the value of
@param Value the new value to assign

SetPropertyFromStringByName Source code

Searches for the property by name and sets the property to the value contained in the string
@param PropertyName the name of the property to find
@param NewValue the string value to use
@return true if the property was found and the value was set, false otherwise

SetRangedPropertyValue Source code

Sets the value of a ranged property, clamping to the min/max values
@param PropertyId the ID of the property to set
@param NewValue the new value to apply to the
@return TRUE if found and is a range property, FALSE otherwise

SetSettingsData Source code

Static function for setting members of the SettingsData union
@param Data the data structure to set the fields of
@param Data2Copy the SettingsData object to copy

SetSettingsDataBlob Source code

Static function for setting members of the SettingsData union
@param Data the data structure to set the fields of
@param InBlob the 8 bytes to copy into the union

SetSettingsDataDateTime Source code

Static function for setting members of the SettingsData union
@param Data the data structure to set the fields of
@param InInt1 first half of the data to set
@param InInt2 second half of the data to set

SetSettingsDataFloat Source code

Static function for setting members of the SettingsData union
@param Data the data structure to set the fields of
@param InFloat the float data to set in the union

SetSettingsDataInt Source code

Static function for setting members of the SettingsData union
@param Data the data structure to set the fields of
@param InInt the 32 bit integer data to set in the union

SetSettingsDataString Source code

Static function for setting members of the SettingsData union.
@param Data the data structure to set the fields of
@param InString the string data to set in the union

SetStringProperty Source code

Sets a property of type SDT_String to the value specified. Does nothing if the property is not of the right type.
@param PropertyId the property to change the value of
@param Value the new value to assign

SetStringSettingValue Source code

Searches the localized string setting array for the matching id and sets the value
@param StringSettingId the string setting to set the value for
@param ValueIndex the value of the string setting
@param bShouldAutoAdd whether to add the context if it is missing

SetStringSettingValueByName Source code

Searches the localized string setting array for the matching name and sets the value
@param StringSettingName the setting name to set the value for
@param ValueIndex the value of the string setting
@param bShouldAutoAdd whether to add the string setting if it is missing

SetStringSettingValueFromStringByName Source code

Searches for the string setting by name and sets the value index to the value contained in the string setting meta data
@param StringSettingName the name of the string setting to find
@param NewValue the string value to use
@return true if the string setting was found and the value was set, false otherwise

UpdateFromURL Source code

Updates the game settings object from parameters passed on the URL
@param URL the URL to parse for settings

UpdateProperties Source code

Using the specified array, updates the matching properties to the new values in that array. Optionally, it will add properties that aren't currently part of this object.
@param Props the list of properties to update
@param bShouldAddIfMissing whether to automatically add the property if missing

UpdateStringSettings Source code

Using the specified array, updates the matching settings to the new values in that array. Optionally, it will add settings that aren't currently part of this object.
@param Settings the list of settings to update
@param bShouldAddIfMissing whether to automatically add the setting if missing

defaultproperties
{
   Name="Default__Settings"
   ObjectArchetype=Object'Core.Default__Object'
}