Cogito, ergo sum

UE3:OnlineProfileSettings (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> OnlinePlayerStorage >> OnlineProfileSettings
Package: 
Engine
Direct subclass:
UTProfileSettings
This class in other games:
UT3

This class holds the data used in reading/writing online profile settings. Online profile settings are stored by an external service.

Properties[edit]

DefaultSettings[edit]

Type: array<OnlinePlayerStorage.OnlineProfileSetting>

These are the settings to use when no setting has been specified yet for a given id. These values should be used by subclasses to fill in per game default settings

OwnerMappings[edit]

Type: array<Settings.IdToStringMapping>

Modifiers: const

Mappings for owner information

Default value, index 1:

Member Value
Id 1
Name 'Online Service Setting'

Default value, index 2:

Member Value
Id 2
Name 'Game Setting'

ProfileSettingIds[edit]

Type: array<int>

Holds the list of profile settings to read from the service. NOTE: Only used for a read request and populated by the subclass

Default values[edit]

Property Value
ProfileMappings[0]
Member Value
Id 1
MappingType PVMT_IdMapped
Name 'Controller Vibration'
ValueMappings
Member Value
Id 3
Name 'Off'
Member Value
Name 'On'
ProfileMappings[1]
Member Value
Id 2
MappingType PVMT_IdMapped
Name 'Invert Y'
ValueMappings
Member Value
Name 'Off'
Member Value
Id 1
Name 'On'
ProfileMappings[2]
Member Value
Id 5
MappingType PVMT_IdMapped
Name 'Mute Voice'
ValueMappings
Member Value
Name 'No'
Member Value
Id 1
Name 'Yes'
ProfileMappings[3]
Member Value
Id 6
MappingType PVMT_IdMapped
Name 'Voice Via Speakers'
ValueMappings
Member Value
Name 'Off'
Member Value
Id 1
Name 'On'
Member Value
Id 2
Name 'Both'
ProfileMappings[4]
Member Value
Id 7
Name 'Voice Volume'
ProfileMappings[5]
Member Value
Id 12
MappingType PVMT_IdMapped
Name 'Difficulty Level'
ValueMappings
Member Value
Name 'Normal'
Member Value
Id 1
Name 'Easy'
Member Value
Id 2
Name 'Hard'
ProfileMappings[6]
Member Value
Id 13
MappingType PVMT_IdMapped
Name 'Controller Sensitivity'
ValueMappings
Member Value
Name 'Medium'
Member Value
Id 1
Name 'Low'
Member Value
Id 2
Name 'High'
ProfileMappings[7]
Member Value
Id 14
MappingType PVMT_IdMapped
Name 'First Preferred Color'
ValueMappings
  1. No value definitions.
Member Value
Id 1
Name 'Black'
Member Value
Id 2
Name 'White'
Member Value
Id 3
Name 'Yellow'
Member Value
Id 4
Name 'Orange'
Member Value
Id 5
Name 'Pink'
Member Value
Id 6
Name 'Red'
Member Value
Id 7
Name 'Purple'
Member Value
Id 8
Name 'Blue'
Member Value
Id 9
Name 'Green'
Member Value
Id 10
Name 'Brown'
Member Value
Id 11
Name 'Silver'
ProfileMappings[8]
Member Value
Id 15
MappingType PVMT_IdMapped
Name 'Second Preferred Color'
ValueMappings
  1. No value definitions.
Member Value
Id 1
Name 'Black'
Member Value
Id 2
Name 'White'
Member Value
Id 3
Name 'Yellow'
Member Value
Id 4
Name 'Orange'
Member Value
Id 5
Name 'Pink'
Member Value
Id 6
Name 'Red'
Member Value
Id 7
Name 'Purple'
Member Value
Id 8
Name 'Blue'
Member Value
Id 9
Name 'Green'
Member Value
Id 10
Name 'Brown'
Member Value
Id 11
Name 'Silver'
ProfileMappings[9]
Member Value
Id 16
MappingType PVMT_IdMapped
Name 'Auto Aim'
ValueMappings
Member Value
Name 'Off'
Member Value
Id 1
Name 'On'
ProfileMappings[10]
Member Value
Id 17
MappingType PVMT_IdMapped
Name 'Auto Center'
ValueMappings
Member Value
Name 'Off'
Member Value
Id 1
Name 'On'
ProfileMappings[11]
Member Value
Id 18
MappingType PVMT_IdMapped
Name 'Movement Control'
ValueMappings
Member Value
Name 'Left Thumbstick'
Member Value
Id 1
Name 'Right Thumbstick'
ProfileMappings[12]
Member Value
Id 19
MappingType PVMT_IdMapped
Name 'Transmission Preference'
ValueMappings
Member Value
Name 'Auto'
Member Value
Id 1
Name 'Manual'
ProfileMappings[13]
Member Value
Id 20
MappingType PVMT_IdMapped
Name 'Race Camera Preference'
ValueMappings
Member Value
Name 'Behind'
Member Value
Id 1
Name 'Front'
Member Value
Id 2
Name 'Inside'
ProfileMappings[14]
Member Value
Id 21
MappingType PVMT_IdMapped
Name 'Brake Preference'
ValueMappings
Member Value
Name 'Trigger'
Member Value
Id 1
Name 'Button'
ProfileMappings[15]
Member Value
Id 22
MappingType PVMT_IdMapped
Name 'Accelerator Preference'
ValueMappings
Member Value
Name 'Trigger'
Member Value
Id 1
Name 'Button'

Enums[edit]

See OnlineProfileSettings enums.

Functions[edit]

Native functions[edit]

SetToDefaults[edit]

native event SetToDefaults ()

Overrides: OnlinePlayerStorage.SetToDefaults

Sets all of the profile settings to their default values

AppendVersionToReadIds[edit]

native function AppendVersionToReadIds ()

Adds the version id to the read ids if it is not present

AppendVersionToSettings[edit]

native function AppendVersionToSettings ()

Adds the version number to the read data if not present

GetProfileSettingDefaultFloat[edit]

native function bool GetProfileSettingDefaultFloat (int ProfileSettingId, out float DefaultFloat)

Searches for the profile setting by id and gets the default value float

Parameters:

  • ProfileSettingId - the id of the profile setting to return the default of
  • Value - the out value of the default setting

Returns:

true if the profile setting was found and retrieved the default float, false otherwise

GetProfileSettingDefaultId[edit]

native function bool GetProfileSettingDefaultId (int ProfileSettingId, out int DefaultId, out int ListIndex)

Searches for the profile setting by id and gets the default value index

Parameters:

  • ProfileSettingId - the id of the profile setting to return
  • DefaultId - the out value of the default id
  • ListIndex - the out value of the index where that value lies in the ValueMappings list

Returns:

true if the profile setting was found and retrieved the default id, false otherwise

GetProfileSettingDefaultInt[edit]

native function bool GetProfileSettingDefaultInt (int ProfileSettingId, out int DefaultInt)

Searches for the profile setting by id and gets the default value int

Parameters:

  • ProfileSettingId - the id of the profile setting to return the default of
  • Value - the out value of the default setting

Returns:

true if the profile setting was found and retrieved the default int, false otherwise

GetVersionNumber[edit]

native function int GetVersionNumber ()

Returns the version number that was found in the profile read results

SetDefaultVersionNumber[edit]

native function SetDefaultVersionNumber ()

Sets the version number to the class default

Events[edit]

ModifyAvailableProfileSettings[edit]

event ModifyAvailableProfileSettings ()

Hooks to allow child classes to dynamically adjust available profile settings or mappings based on e.g. ini values.