The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

UE3:Settings (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> Settings
Package: 
Engine
Direct subclasses:
OnlineGameSearch, OnlineGameSettings, UTLeaderboardSettings
This class in other games:
UT3
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

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

Properties[edit]

LocalizedSettings[edit]

Type: array<LocalizedStringSetting>

The various localized string settings to use with the session

LocalizedSettingsMappings[edit]

Type: array<LocalizedStringSettingMetaData>

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

Properties[edit]

Type: array<SettingsProperty>

The properties used by the derived settings class

PropertyMappings[edit]

Type: array<SettingsPropertyPropertyMetaData>

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

Enums[edit]

EOnlineDataAdvertisementType[edit]

The types of advertisement of settings to use

ODAT_DontAdvertise 
Don't advertise via the online service or QoS data
ODAT_OnlineService 
Advertise via the online service only
ODAT_QoS 
Advertise via the QoS data only
ODAT_OnlineServiceAndQoS 
Advertise via the online service and via the QoS data

EPropertyValueMappingType[edit]

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

PVMT_RawValue 
The value is presented "as is" without mapping/manipulation
PVMT_PredefinedValues 
The property has a set of predefined values that are the only ones to choose from
PVMT_Ranged 
The property must exist within the min/max range specified
PVMT_IdMapped 
The property is mapped using id/name pairs

ESettingsDataType[edit]

The supported data types that can be stored in the union

SDT_Empty 
Means the data in the OnlineData value fields should be ignored
SDT_Int32 
32 bit integer goes in Value1 only
SDT_Int64 
64 bit integer stored in both value fields
SDT_Double 
Double (8 byte) stored in both value fields
SDT_String 
Unicode string pointer in Value2 with length in Value1
SDT_Float 
Float (4 byte) stored in Value1 fields
SDT_Blob 
Binary data with count in Value1 and pointer in Value2
SDT_DateTime 
Date/time structure. Date in Value1 and time Value2

Structs[edit]

IdToStringMapping[edit]

Modifiers: native

Maps an Id value to a string

int Id 
Id for the given string
name Name 
Human readable form of the Id

LocalizedStringSetting[edit]

Modifiers: native

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

int Id 
The unique identifier for this localized string
int ValueIndex 
The unique index into the list of localized strings
EOnlineDataAdvertisementType AdvertisementType 
How this setting should be presented to requesting clients: online or QoS

LocalizedStringSettingMetaData[edit]

Modifiers: native

Contains the meta information for a given context

int Id 
Id for the given string
name Name 
Human readable form of the Id
string ColumnHeaderText 
Localized text used for list column headers
array<StringIdToStringMapping> ValueMappings 
Holds the mappings of localized string setting values to their human readable form

SettingsData[edit]

Modifiers: native

Structure to hold arbitrary data of a given type

ESettingsDataType Type 
Enum (byte) indicating the type of data held in the value fields
int Value1 
This is a union of value types and should never be used in script
pointer{INT} 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[edit]

Modifiers: native

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

int PropertyId 
The unique id for this property
SettingsData Data 
The data stored for the type
EOnlineDataAdvertisementType AdvertisementType 
How this setting should be presented to requesting clients: online or QoS

SettingsPropertyPropertyMetaData[edit]

Modifiers: native

Contains the meta information needed to validate property data

int Id 
Id for the given string
name Name 
Human readable form of the Id
string ColumnHeaderText 
Localized text used for list column headers
EPropertyValueMappingType MappingType 
Whether the value is ID mapped or should be string-ized
array<IdToStringMapping> ValueMappings 
Holds the mappings of value IDs to their human readable form
array<SettingsData> PredefinedValues 
Holds a set of predefined values for a property when freeform editing isn't desired
float MinVal 
The min value for this property
float MaxVal 
The max value for this property
float RangeIncrement 
The amount that this range can be incremented/decremented by

StringIdToStringMapping[edit]

Modifiers: native

Maps an Id value to a string

int Id 
Id for the given string
name Name 
Human readable form of the Id
bool bIsWildcard 
Whether this id is used to indicate a wildcard value or not

Delegates[edit]

NotifyPropertyValueUpdated[edit]

delegate NotifyPropertyValueUpdated (name PropertyName)

Notification that the value of a property in this object has been updated.

Parameters:

  • PropertyName - the name of the property that was changed.

NotifySettingValueUpdated[edit]

delegate NotifySettingValueUpdated (name SettingName)

Notification that the value of a LocalizedSetting in this object has been updated.

Parameters:

  • SettingName - the name of the setting that was changed.

Functions[edit]

Static native functions[edit]

EmptySettingsData[edit]

static native function EmptySettingsData (out SettingsData Data)

Empties an SettingsData structure

Parameters:

  • Data - the data structure to set the fields of

GetSettingsDataBlob[edit]

static native function GetSettingsDataBlob (out SettingsData Data, out array<byte> OutBlob)

Static function for copying data out the SettingsData union

Parameters:

  • Data - the data structure to copy the data from
  • OutBlob - the buffer to copy the data into

GetSettingsDataDateTime[edit]

static native function GetSettingsDataDateTime (out SettingsData Data, out int OutInt1, out int OutInt2)

Static function for getting members of the SettingsData union

Parameters:

  • Data - the data structure to get the fields of
  • OutInt1 - first half of the data to get
  • OutInt2 - second half of the data to get

GetSettingsDataFloat[edit]

static native function float GetSettingsDataFloat (out SettingsData Data)

Static function for copying data out of the SettingsData union

Parameters:

  • Data - the data structure to copy the data from

GetSettingsDataInt[edit]

static native function int GetSettingsDataInt (out SettingsData Data)

Static function for copying data out of the SettingsData union

Parameters:

  • Data - the data structure to copy the data from

GetSettingsDataString[edit]

static native function string GetSettingsDataString (out SettingsData Data)

Static function for copying data out of the SettingsData union.

Parameters:

  • Data - the data structure to copy the data from

SetSettingsData[edit]

static native function SetSettingsData (out SettingsData Data, out SettingsData Data2Copy)

Static function for setting members of the SettingsData union

Parameters:

  • Data - the data structure to set the fields of
  • Data2Copy - the SettingsData object to copy

SetSettingsDataBlob[edit]

static native function SetSettingsDataBlob (out SettingsData Data, out array<byte> InBlob)

Static function for setting members of the SettingsData union

Parameters:

  • Data - the data structure to set the fields of
  • InBlob - the 8 bytes to copy into the union

SetSettingsDataDateTime[edit]

static native function SetSettingsDataDateTime (out SettingsData Data, int InInt1, int InInt2)

Static function for setting members of the SettingsData union

Parameters:

  • Data - the data structure to set the fields of
  • InInt1 - first half of the data to set
  • InInt2 - second half of the data to set

SetSettingsDataFloat[edit]

static native function SetSettingsDataFloat (out SettingsData Data, float InFloat)

Static function for setting members of the SettingsData union

Parameters:

  • Data - the data structure to set the fields of
  • InFloat - the float data to set in the union

SetSettingsDataInt[edit]

static native function SetSettingsDataInt (out SettingsData Data, int InInt)

Static function for setting members of the SettingsData union

Parameters:

  • Data - the data structure to set the fields of
  • InInt - the 32 bit integer data to set in the union

SetSettingsDataString[edit]

static native function SetSettingsDataString (out SettingsData Data, string InString)

Static function for setting members of the SettingsData union.

Parameters:

  • Data - the data structure to set the fields of
  • InString - the string data to set in the union

Native functions[edit]

See Settings native functions.

Retrieved from "https://wiki.beyondunreal.com/UE3:Settings_(UDK)?oldid=41691"