UE3:Settings native functions (UT3)

Object >> Settings (native functions)

Settings native functions in other games:

UDK

Native functions

AppendContextsToURL

native function AppendContextsToURL (out string URL)

Appends contexts to the URL.

Parameters:

• OutURL - String to append contexts to.

AppendDataBindingsToURL

native function AppendDataBindingsToURL (out string URL)

Appends databindings to the URL.

Parameters:

• OutURL - String to append bindings to.

AppendPropertiesToURL

native function AppendPropertiesToURL (out string URL)

Appends properties to the URL.

Parameters:

• OutURL - String to append properties to.

BuildURL

native function BuildURL (out string URL)

Builds an URL out of the string settings and properties

Parameters:

• URL - the string to populate

GetDataBindingProperties

native final function GetDataBindingProperties (out array<name> DataBindingProperties)

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

native final function bool GetDataBindingValue (name Property, out string Value, optional bool bIgnoreDefaults)

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

Parameters:

• 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

native function bool GetFloatProperty (int PropertyId, out float Value)

Reads a property of type SDT_Float into the value specified. Does nothing if the property is not of the right type.

Parameters:

• PropertyId - the property to read the value of
• Value - the out value containing the property's value

Returns:

true if found and is the right type, false otherwise

GetIntProperty

native function bool GetIntProperty (int PropertyId, out int Value)

Reads a property of type SDT_Int32 into the value specified. Does nothing if the property is not of the right type.

Parameters:

• PropertyId - the property to change the value of
• Value - the out value containing the property's value

Returns:

true if found and is the right type, false otherwise

GetPropertyAsString

native function string GetPropertyAsString (int PropertyId)

Converts a property to a string. Searches by id

Parameters:

• PropertyId - the id to look up in the mappings table

Returns:

the string form of the property value or an empty string if invalid/missing

GetPropertyAsStringByName

native function string GetPropertyAsStringByName (name PropertyName)

Converts a property to a string. Searches by name

Parameters:

• PropertyName - the name of the property to find

Returns:

the string form of the property value or an empty string if invalid/missing

GetPropertyColumnHeader

native function string GetPropertyColumnHeader (int PropertyId)

Finds the localized column header text for the property

Parameters:

• PropertyId - the id to look up in the mappings table

Returns:

the string to use as the list column header for the property that matches the id, or an empty string if not found.

GetPropertyId

native function bool GetPropertyId (name PropertyName, out int PropertyId)

Searches the property array for the matching property and returns the id

Parameters:

• PropertyName - the name of the property being searched for
• PropertyId - the id of the context that matches the name

Returns:

true if the property was found, false otherwise

GetPropertyMappingType

native function bool GetPropertyMappingType (int PropertyId, out EPropertyValueMappingType OutType)

Determines the mapping type for the specified property

Parameters:

• PropertyId - the ID to get the mapping type for
• OutType - the out var the value is placed in

Returns:

TRUE if found, FALSE otherwise

GetPropertyName

native function name GetPropertyName (int PropertyId)

Finds the human readable name for the property

Parameters:

• PropertyId - the id to look up in the mappings table

Returns:

the name of the property that matches the id or NAME_None if not found

GetPropertyRange

native function bool GetPropertyRange (int PropertyId, out float OutMinValue, out float OutMaxValue, out float RangeIncrement, out byte bFormatAsInt)

Determines the min and max values of a property that is clamped to a range

Parameters:

• PropertyId - the ID to get the mapping type for
• OutMinValue - the out var the min value is placed in
• OutMaxValue - the out var the max value is placed in
• RangeIncrement - the amount the range can be adjusted by the UI in any single update
• bFormatAsInt - whether the range's value should be treated as an int.

Returns:

TRUE if found and is a range property, FALSE otherwise

GetPropertyType

native function ESettingsDataType GetPropertyType (int PropertyId)

Determines the property type for the specified property id

Parameters:

• PropertyId - the property to change the value of

Returns:

the type of property, or SDT_Empty if not found

GetQoSAdvertisedProperties

native function GetQoSAdvertisedProperties (out array<SettingsProperty> QoSProps)

Scans the properties for the ones that need to be set via QoS data

Parameters:

• QoSProps - the out array holding the list of properties to advertise via QoS

GetQoSAdvertisedStringSettings

native function GetQoSAdvertisedStringSettings (out array<LocalizedStringSetting> QoSSettings)

Scans the string settings for the ones that need to be set via QoS data

Parameters:

• QoSSettings - the out array holding the list of settings to advertise via QoS

GetRangedPropertyValue

native function bool GetRangedPropertyValue (int PropertyId, out float OutValue)

Gets the value of a ranged property

Parameters:

• PropertyId - the ID to get the value of
• OutValue - the out var that receives the value

Returns:

TRUE if found and is a range property, FALSE otherwise

GetStringProperty

native function bool GetStringProperty (int PropertyId, out string Value)

Reads a property of type SDT_String into the value specified. Does nothing if the property is not of the right type.

Parameters:

• PropertyId - the property to change the value of
• Value - the out value containing the property's value

Returns:

true if found and is the right type, false otherwise

GetStringSettingColumnHeader

native function string GetStringSettingColumnHeader (int StringSettingId)

Finds the localized column header text for the string setting

Parameters:

• StringSettingId - the id to look up in the mappings table

Returns:

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

native function bool GetStringSettingId (name StringSettingName, out int StringSettingId)

Searches the context array for the matching string setting name and returns the id

Parameters:

• StringSettingName - the name of the string setting being searched for
• StringSettingId - the id of the context that matches the name

Returns:

true if the seting was found, false otherwise

GetStringSettingName

native function name GetStringSettingName (int StringSettingId)

Finds the human readable name for the localized string setting

Parameters:

• StringSettingId - the id to look up in the mappings table

Returns:

the name of the string setting that matches the id or NAME_None if not found

GetStringSettingValue

native function bool GetStringSettingValue (int StringSettingId, out int ValueIndex)

Searches the localized string setting array for the matching id and returns its value

Parameters:

• StringSettingId - the string setting to find the value of
• ValueIndex - the out value that is set when found

Returns:

true if found, false otherwise

GetStringSettingValueByName

native function bool GetStringSettingValueByName (name StringSettingName, out int ValueIndex)

Searches the localized string setting array for the matching name and returns its value

Parameters:

• StringSettingName - the setting name to find the value of
• ValueIndex - the out value that is set when found

Returns:

true if found, false otherwise

GetStringSettingValueName

native function name GetStringSettingValueName (int StringSettingId, int ValueIndex)

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

Parameters:

• StringSettingId - the id to look up in the mappings table
• ValueIndex - the value index to find the string value of

Returns:

the name of the string setting value that matches the id & index or NAME_None if not found

GetStringSettingValueNameByName

native function name GetStringSettingValueNameByName (name StringSettingName)

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

Parameters:

• StringSettingName - the name of the string setting to find the string value of

Returns:

the name of the string setting value that matches the name or NAME_None if not found

GetStringSettingValueNames

native function bool GetStringSettingValueNames (int StringSettingId, out array<IdToStringMapping> Values)

Searches the localized string setting array for the matching id and returns the list of possible values

Parameters:

• StringSettingId - the string setting to find the value of
• Values - the out value that is a list of value names and their ids

Returns:

true if found, false otherwise

HasProperty

native function bool HasProperty (int PropertyId)

Determines if a given property is present for this object

Parameters:

• PropertyId - the ID to check on

Returns:

TRUE if the property is part of this object, FALSE otherwise

HasStringSetting

native function bool HasStringSetting (int SettingId)

Determines if a given localized string setting is present for this object

Parameters:

• SettingId - the ID to check on

Returns:

TRUE if the setting is part of this object, FALSE otherwise

IsWildcardStringSetting

native function bool IsWildcardStringSetting (int StringSettingId)

Determines if the value for the specified setting is a wildcard option

Parameters:

• StringSettingId - the id to check for being a wildcard

Returns:

true if the current value is a wildcard, false otherwise

SetDataBindingValue

native final function bool SetDataBindingValue (name Property, string Value)

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

native function SetFloatProperty (int PropertyId, float Value)

Sets a property of type SDT_Float to the value specified. Does nothing if the property is not of the right type.

Parameters:

• PropertyId - the property to change the value of
• Value - the new value to assign

SetIntProperty

native function SetIntProperty (int PropertyId, int Value)

Sets a property of type SDT_Int32 to the value specified. Does nothing if the property is not of the right type.

Parameters:

• PropertyId - the property to change the value of
• Value - the new value to assign

SetPropertyFromStringByName

native function bool SetPropertyFromStringByName (name PropertyName, const out string NewValue)

Searches for the property by name and sets the property to the value contained in the string

Parameters:

• PropertyName - the name of the property to find
• NewValue - the string value to use

Returns:

true if the property was found and the value was set, false otherwise

SetRangedPropertyValue

native function bool SetRangedPropertyValue (int PropertyId, float NewValue)

Sets the value of a ranged property, clamping to the min/max values

Parameters:

• PropertyId - the ID of the property to set
• NewValue - the new value to apply to the

Returns:

TRUE if found and is a range property, FALSE otherwise

SetStringProperty

native function SetStringProperty (int PropertyId, string Value)

Sets a property of type SDT_String to the value specified. Does nothing if the property is not of the right type.

Parameters:

• PropertyId - the property to change the value of
• Value - the new value to assign

SetStringSettingValue

native function SetStringSettingValue (int StringSettingId, int ValueIndex, bool bShouldAutoAdd)

Searches the localized string setting array for the matching id and sets the value

Parameters:

• StringSettingId - the string setting to set the value for
• ValueIndex - the value of the string setting
• bShouldAutoAdd - whether to add the context if it is missing

SetStringSettingValueByName

native function SetStringSettingValueByName (name StringSettingName, int ValueIndex, bool bShouldAutoAdd)

Searches the localized string setting array for the matching name and sets the value

Parameters:

• StringSettingName - the setting name to set the value for
• ValueIndex - the value of the string setting
• bShouldAutoAdd - whether to add the string setting if it is missing

SetStringSettingValueFromStringByName

native function bool SetStringSettingValueFromStringByName (name StringSettingName, const out string NewValue)

Searches for the string setting by name and sets the value index to the value contained in the string setting meta data

Parameters:

• StringSettingName - the name of the string setting to find
• NewValue - the string value to use

Returns:

true if the string setting was found and the value was set, false otherwise

UpdateFromURL

native function UpdateFromURL (const out string URL, GameInfo Game)

Updates the game settings object from parameters passed on the URL

Parameters:

• URL - the URL to parse for settings

UpdateProperties

native function UpdateProperties (const out array<SettingsProperty> Props, bool bShouldAddIfMissing)

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.

Parameters:

• Props - the list of properties to update
• bShouldAddIfMissing - whether to automatically add the property if missing

UpdateStringSettings

native function UpdateStringSettings (const out array<LocalizedStringSetting> Settings, bool bShouldAddIfMissing)

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.

Parameters:

• Settings - the list of settings to update
• bShouldAddIfMissing - whether to automatically add the setting if missing