Engine.OnlineProfileSettings

Extends

Object

Modifiers

dependson ( Settings ) native

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

Core.Object
|   
+-- Engine.OnlineProfileSettings

Direct Known Subclasses:

UTProfileSettings

Functions Summary
		AppendVersionToReadIds ()
		AppendVersionToSettings ()
	string	GetProfileSettingColumnHeader (int ProfileSettingId)
	bool	GetProfileSettingId (name ProfileSettingName, ut int ProfileSettingId)
	bool	GetProfileSettingMappingType (int ProfileId, ut EPropertyValueMappingType OutType)
	name	GetProfileSettingName (int ProfileSettingId)
	bool	GetProfileSettingRange (int ProfileId, ut float OutMinValue, ut float OutMaxValue, ut float RangeIncrement, ut byte bFormatAsInt)
	bool	GetProfileSettingValue (int ProfileSettingId, ut string Value)
	bool	GetProfileSettingValueByName (name ProfileSettingName, ut string Value)
	bool	GetProfileSettingValueFloat (int ProfileSettingId, ut float Value)
	bool	GetProfileSettingValueId (int ProfileSettingId, ut int ValueId)
	bool	GetProfileSettingValueInt (int ProfileSettingId, ut int Value)
	name	GetProfileSettingValueName (int ProfileSettingId)
	bool	GetProfileSettingValues (int ProfileSettingId, ut array<name> Values)
	bool	GetRangedProfileSettingValue (int ProfileId, ut float OutValue)
	int	GetVersionNumber ()
	bool	IsProfileSettingIdMapped (int ProfileSettingId)
		ReconcileProfileSettings ()
		ScriptSetToDefaults ()
		SetDefaultVersionNumber ()
	bool	SetProfileSettingValue (int ProfileSettingId, onst out string NewValue)
	bool	SetProfileSettingValueByName (name ProfileSettingName, onst out string NewValue)
	bool	SetProfileSettingValueFloat (int ProfileSettingId, loat Value)
	bool	SetProfileSettingValueId (int ProfileSettingId, nt Value)
	bool	SetProfileSettingValueInt (int ProfileSettingId, nt Value)
	bool	SetRangedProfileSettingValue (int ProfileId, loat NewValue)
		SetToDefaults ()

AsyncState Source code

Indicates the state of the profile (whether an async action is happening and what type)

DefaultSettings Source code

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 Source code

Mappings for owner information

ProfileMappings Source code

Holds the set of mappings from native format to human readable format

ProfileSettingIds Source code

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

ProfileSettings Source code

Holds the set of profile settings that are either returned from a read or to be written out

VersionNumber Source code

Used to determine if the read profile is the proper version or not

EOnlineProfileAsyncState Source code

Enum indicating the current async action happening on this profile

EOnlineProfilePropertyOwner Source code

Enum indicating who owns a given online profile proprety

EProfileAutoAimOptions Source code

Enum of auto aim preferences stored by the online service Used with Profile ID PSI_AutoAim

EProfileAutoCenterOptions Source code

Enum of auto center preferences stored by the online service Used with Profile ID PSI_AutoCenter

EProfileControllerSensitivityOptions Source code

Enum of controller sensitivity profile values stored by the online service Used with Profile ID PSI_ControllerSensitivity

EProfileControllerVibrationToggleOptions Source code

Enum of player's vibration preferences stored by the online service Used with Profile ID PSI_ControllerVibration

EProfileDifficultyOptions Source code

Enum of difficulty profile values stored by the online service Used with Profile ID PSI_GameDifficulty

EProfileMovementControlOptions Source code

Enum of movement stick preferences stored by the online service Used with Profile ID PSI_MovementControl

EProfilePreferredColorOptions Source code

Enum of team color preferences stored by the online service Used with Profile ID PSI_PreferredColor1 & PSI_PreferredColor2

EProfileRaceAcceleratorControlOptions Source code

Enum of player's race gas control preferences stored by the online service Used with Profile ID PSI_RaceAcceleratorControl

EProfileRaceBrakeControlOptions Source code

Enum of player's race brake control preferences stored by the online service Used with Profile ID PSI_RaceCameraLocation

EProfileRaceCameraLocationOptions Source code

Enum of player's race camera preferences stored by the online service Used with Profile ID PSI_RaceCameraLocation

EProfileRaceTransmissionOptions Source code

Enum of player's car transmission preferences stored by the online service Used with Profile ID PSI_RaceTransmission

EProfileSettingID Source code

Enum of profile setting IDs

EProfileVoiceThruSpeakersOptions Source code

Enum of player's voice through speakers preference stored by the online service Used with Profile ID PSI_VoiceThruSpeakers

EProfileXInversionOptions Source code

Enum of player's X axis invert preferences stored by the online service Used with Profile ID PSI_YInversion

EProfileYInversionOptions Source code

Enum of player's Y axis invert preferences stored by the online service Used with Profile ID PSI_YInversion

OnlineProfileSetting Source code

Structure used to hold the information for a given profile setting
Owner:

Which party owns the data (online service vs game)

ProfileSetting:

The profile setting comprised of unique id and union of held types

AppendVersionToReadIds Source code

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

AppendVersionToSettings Source code

Adds the version number to the read data if not present

GetProfileSettingColumnHeader Source code

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

GetProfileSettingId Source code

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

GetProfileSettingMappingType Source code

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

GetProfileSettingName Source code

Finds the human readable name for the profile setting
@param ProfileSettingId 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

GetProfileSettingRange Source code

Determines the min and max values of a property that is clamped to a range
@param ProfileId 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

GetProfileSettingValue Source code

Finds the human readable name for a profile setting's value. Searches the profile settings mappings for the specifc profile setting and then searches the set of values for the specific value index and returns that value's human readable name
@param ProfileSettingId the id to look up in the mappings table
@param Value the out param that gets the value copied to it
@return true if found, false otherwise

GetProfileSettingValueByName Source code

Finds the human readable name for a profile setting's value. Searches the profile settings mappings for the specifc profile setting and then searches the set of values for the specific value index and returns that value's human readable name
@param ProfileSettingName the name of the profile setting to find the string value of
@param Value the out param that gets the value copied to it
@return true if found, false otherwise

GetProfileSettingValueFloat Source code

Searches for the profile setting by id and gets the value index
@param ProfileSettingId the id of the profile setting to return
@param Value the out value of the setting
@return true if the profile setting was found and not id mapped, false otherwise

GetProfileSettingValueId Source code

Searches for the profile setting by id and gets the value index
@param ProfileSettingId the id of the profile setting to return
@param ValueId the out value of the id
@return true if the profile setting was found and id mapped, false otherwise

GetProfileSettingValueInt Source code

Searches for the profile setting by id and gets the value index
@param ProfileSettingId the id of the profile setting to return
@param Value the out value of the setting
@return true if the profile setting was found and not id mapped, false otherwise

GetProfileSettingValueName Source code

Finds the human readable name for a profile setting's value. Searches the profile settings mappings for the specifc profile setting and then searches the set of values for the specific value index and returns that value's human readable name
@param ProfileSettingId the id to look up in the mappings table
@return the name of the value or NAME_None if not value mapped

GetProfileSettingValues Source code

Searches the profile settings mappings for the specifc profile setting and then adds all of the possible values to the out parameter
@param ProfileSettingId the id to look up in the mappings table
@param Values the out param that gets the list of values copied to it
@return true if found and value mapped, false otherwise

GetRangedProfileSettingValue Source code

Gets the value of a ranged property
@param ProfileId 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

GetVersionNumber Source code

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

IsProfileSettingIdMapped Source code

Determines if the setting is id mapped or not
@param ProfileSettingId the id to look up in the mappings table
@return TRUE if the setting is id mapped, FALSE if it is a raw value

ReconcileProfileSettings Source code

Compares the data inside the profile with default values to ensure that every entry exists and sets to default values where appropriate

ScriptSetToDefaults Source code

Allows script to set defaults without being native.

SetDefaultVersionNumber Source code

Sets the version number to the class default

SetProfileSettingValue Source code

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

SetProfileSettingValueByName Source code

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

SetProfileSettingValueFloat Source code

Searches for the profile setting by id and sets the value
@param ProfileSettingId the id of the profile setting to return
@param Value the new value
@return true if the profile setting was found and not id mapped, false otherwise

SetProfileSettingValueId Source code

Searches for the profile setting by id and sets the value
@param ProfileSettingId the id of the profile setting to return
@param Value the new value
@return true if the profile setting was found and id mapped, false otherwise

SetProfileSettingValueInt Source code

Searches for the profile setting by id and sets the value
@param ProfileSettingId the id of the profile setting to return
@param Value the new value
@return true if the profile setting was found and not id mapped, false otherwise

SetRangedProfileSettingValue Source code

Sets the value of a ranged property, clamping to the min/max values
@param ProfileId 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

SetToDefaults Source code

Sets all of the profile settings to their default values

defaultproperties
{
   VersionNumber=-1
   OwnerMappings(0)=
   OwnerMappings(1)=(Id=1,Name="Online Service Setting")
   OwnerMappings(2)=(Id=2,Name="Game Setting")
   ProfileMappings(0)=(Id=1,Name="Controller Vibration",MappingType=PVMT_IdMapped,ValueMappings=((Name="Off"),(Id=3,Name="On")))
   ProfileMappings(1)=(Id=2,Name="Invert Y",MappingType=PVMT_IdMapped,ValueMappings=((Name="Off"),(Id=1,Name="On")))
   ProfileMappings(2)=(Id=5,Name="Mute Voice",MappingType=PVMT_IdMapped,ValueMappings=((Name="No"),(Id=1,Name="Yes")))
   ProfileMappings(3)=(Id=6,Name="Voice Via Speakers",MappingType=PVMT_IdMapped,ValueMappings=((Name="Off"),(Id=1,Name="On"),(Id=2,Name="Both")))
   ProfileMappings(4)=(Id=7,Name="Voice Volume")
   ProfileMappings(5)=(Id=12,Name="Difficulty Level",MappingType=PVMT_IdMapped,ValueMappings=((Name="Normal"),(Id=1,Name="Easy"),(Id=2,Name="Hard")))
   ProfileMappings(6)=(Id=13,Name="Controller Sensitivity",MappingType=PVMT_IdMapped,ValueMappings=((Name="Medium"),(Id=1,Name="Low"),(Id=2,Name="High")))
   ProfileMappings(7)=(Id=14,Name="First Preferred Color",MappingType=PVMT_IdMapped,ValueMappings=(,(Id=1,Name="Black"),(Id=2,Name="White"),(Id=3,Name="Yellow"),(Id=4,Name="Orange"),(Id=5,Name="Pink"),(Id=6,Name="Red"),(Id=7,Name="Purple"),(Id=8,Name="Blue"),(Id=9,Name="Green"),(Id=10,Name="Brown"),(Id=11,Name="Silver")))
   ProfileMappings(8)=(Id=15,Name="Second Preferred Color",MappingType=PVMT_IdMapped,ValueMappings=(,(Id=1,Name="Black"),(Id=2,Name="White"),(Id=3,Name="Yellow"),(Id=4,Name="Orange"),(Id=5,Name="Pink"),(Id=6,Name="Red"),(Id=7,Name="Purple"),(Id=8,Name="Blue"),(Id=9,Name="Green"),(Id=10,Name="Brown"),(Id=11,Name="Silver")))
   ProfileMappings(9)=(Id=16,Name="Auto Aim",MappingType=PVMT_IdMapped,ValueMappings=((Name="Off"),(Id=1,Name="On")))
   ProfileMappings(10)=(Id=17,Name="Auto Center",MappingType=PVMT_IdMapped,ValueMappings=((Name="Off"),(Id=1,Name="On")))
   ProfileMappings(11)=(Id=18,Name="Movement Control",MappingType=PVMT_IdMapped,ValueMappings=((Name="Left Thumbstick"),(Id=1,Name="Right Thumbstick")))
   ProfileMappings(12)=(Id=19,Name="Transmission Preference",MappingType=PVMT_IdMapped,ValueMappings=((Name="Auto"),(Id=1,Name="Manual")))
   ProfileMappings(13)=(Id=20,Name="Race Camera Preference",MappingType=PVMT_IdMapped,ValueMappings=((Name="Behind"),(Id=1,Name="Front"),(Id=2,Name="Inside")))
   ProfileMappings(14)=(Id=21,Name="Brake Preference",MappingType=PVMT_IdMapped,ValueMappings=((Name="Trigger"),(Id=1,Name="Button")))
   ProfileMappings(15)=(Id=22,Name="Accelerator Preference",MappingType=PVMT_IdMapped,ValueMappings=((Name="Trigger"),(Id=1,Name="Button")))
   Name="Default__OnlineProfileSettings"
   ObjectArchetype=Object'Core.Default__Object'
}