Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.OnlineProfileSettings

Extends
OnlinePlayerStorage
Modifiers
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.OnlinePlayerStorage
   |   
   +-- Engine.OnlineProfileSettings

Direct Known Subclasses:

UDKProfileSettings
Constants Summary
Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
array<OnlineProfileSetting>DefaultSettings
array<IdToStringMapping>OwnerMappings
array<int>ProfileSettingIds
Inherited Variables from Engine.OnlinePlayerStorage
AsyncState, DeviceId, ProfileMappings, ProfileSettings, SaveCountSettingId, VersionNumber, VersionSettingsId
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
EProfileAutoAimOptions
PAAO_Off, PAAO_On
EProfileAutoCenterOptions
PACO_Off, PACO_On
EProfileControllerSensitivityOptions
PCSO_Medium, PCSO_Low, PCSO_High,
EProfileControllerVibrationToggleOptions
PCVTO_Off, PCVTO_IgnoreThis, PCVTO_IgnoreThis2, PCVTO_On
EProfileDifficultyOptions
PDO_Normal, PDO_Easy, PDO_Hard,
EProfileMovementControlOptions
PMCO_L_Thumbstick, PMCO_R_Thumbstick
EProfileOmniDirEvadeOptions
PODI_Off, PODI_On
EProfilePreferredColorOptions
PPCO_None, PPCO_Black, PPCO_White, PPCO_Yellow, PPCO_Orange, PPCO_Pink, PPCO_Red, PPCO_Purple, PPCO_Blue, PPCO_Green, PPCO_Brown, PPCO_Silver,
EProfileRaceAcceleratorControlOptions
PRACO_Trigger, PRACO_Button
EProfileRaceBrakeControlOptions
PRBCO_Trigger, PRBCO_Button
EProfileRaceCameraLocationOptions
PRCLO_Behind, PRCLO_Front, PRCLO_Inside
EProfileRaceTransmissionOptions
PRTO_Auto, PRTO_Manual
EProfileSettingID
PSI_Unknown, PSI_ControllerVibration, PSI_YInversion, PSI_GamerCred, PSI_GamerRep, PSI_VoiceMuted, PSI_VoiceThruSpeakers, PSI_VoiceVolume, PSI_GamerPictureKey, PSI_GamerMotto, PSI_GamerTitlesPlayed, PSI_GamerAchievementsEarned, PSI_GameDifficulty, PSI_ControllerSensitivity, PSI_PreferredColor1, PSI_PreferredColor2, PSI_AutoAim, PSI_AutoCenter, PSI_MovementControl, PSI_RaceTransmission, PSI_RaceCameraLocation, PSI_RaceBrakeControl, PSI_RaceAcceleratorControl, PSI_GameCredEarned, PSI_GameAchievementsEarned, PSI_EndLiveIds, PSI_ProfileVersionNum, PSI_ProfileSaveCount
EProfileVoiceThruSpeakersOptions
PVTSO_Off, PVTSO_On, PVTSO_Both
EProfileXInversionOptions
PXIO_Off, PXIO_On
EProfileYInversionOptions
PYIO_Off, PYIO_On
Inherited Enumerations from Engine.OnlinePlayerStorage
EOnlinePlayerStorageAsyncState, EOnlineProfilePropertyOwner
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
Inherited Structures from Engine.OnlinePlayerStorage
OnlineProfileSetting
Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
function AppendVersionToReadIds ()
functionbool GetProfileSettingDefaultFloat (int ProfileSettingId, ut float DefaultFloat)
functionbool GetProfileSettingDefaultId (int ProfileSettingId, ut int DefaultId, out int ListIndex)
functionbool GetProfileSettingDefaultInt (int ProfileSettingId, ut int DefaultInt)
event ModifyAvailableProfileSettings ()
event SetToDefaults ()
Inherited Functions from Engine.OnlinePlayerStorage
AddSettingFloat, AddSettingInt, AppendVersionToSettings, FindDefaultProfileMappingIndexByName, FindProfileMappingIndex, FindProfileMappingIndexByName, FindProfileSettingIndex, GetProfileSettingColumnHeader, GetProfileSettingId, GetProfileSettingMappingIds, GetProfileSettingMappingType, GetProfileSettingName, GetProfileSettingRange, GetProfileSettingValue, GetProfileSettingValueByName, GetProfileSettingValueFloat, GetProfileSettingValueFromListIndex, GetProfileSettingValueId, GetProfileSettingValueInt, GetProfileSettingValueName, GetProfileSettingValues, GetRangedProfileSettingValue, GetVersionNumber, IsProfileSettingIdMapped, SetDefaultVersionNumber, SetProfileSettingValue, SetProfileSettingValueByName, SetProfileSettingValueFloat, SetProfileSettingValueId, SetProfileSettingValueInt, SetRangedProfileSettingValue, SetToDefaults
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Variables Detail

DefaultSettings Source code

var array<OnlineProfileSetting> DefaultSettings;
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

var const array<IdToStringMapping> OwnerMappings;
Mappings for owner information

ProfileSettingIds Source code

var array<int> ProfileSettingIds;
Holds the list of profile settings to read from the service. NOTE: Only used for a read request and populated by the subclass

Enumerations Detail

EProfileAutoAimOptions Source code

enum EProfileAutoAimOptions
{
PAAO_Off, PAAO_On
};
Enum of auto aim preferences stored by the online service Used with Profile ID PSI_AutoAim

EProfileAutoCenterOptions Source code

enum EProfileAutoCenterOptions
{
PACO_Off, PACO_On
};
Enum of auto center preferences stored by the online service Used with Profile ID PSI_AutoCenter

EProfileControllerSensitivityOptions Source code

enum EProfileControllerSensitivityOptions
{
PCSO_Medium, PCSO_Low, PCSO_High,
};
Enum of controller sensitivity profile values stored by the online service Used with Profile ID PSI_ControllerSensitivity

EProfileControllerVibrationToggleOptions Source code

enum EProfileControllerVibrationToggleOptions
{
PCVTO_Off, PCVTO_IgnoreThis, PCVTO_IgnoreThis2, PCVTO_On
};
Enum of player's vibration preferences stored by the online service Used with Profile ID PSI_ControllerVibration

EProfileDifficultyOptions Source code

enum EProfileDifficultyOptions
{
PDO_Normal, PDO_Easy, PDO_Hard,
};
Enum of difficulty profile values stored by the online service Used with Profile ID PSI_GameDifficulty

EProfileMovementControlOptions Source code

enum EProfileMovementControlOptions
{
PMCO_L_Thumbstick, PMCO_R_Thumbstick
};
Enum of movement stick preferences stored by the online service Used with Profile ID PSI_MovementControl

EProfileOmniDirEvadeOptions Source code

enum EProfileOmniDirEvadeOptions
{
PODI_Off, PODI_On
};
Enum of player's omnidirectional evade preferences stored by the online service Used with Profile ID OmniDirEvade

EProfilePreferredColorOptions Source code

enum EProfilePreferredColorOptions
{
PPCO_None, PPCO_Black, PPCO_White, PPCO_Yellow, PPCO_Orange, PPCO_Pink, PPCO_Red, PPCO_Purple, PPCO_Blue, PPCO_Green, PPCO_Brown, PPCO_Silver,
};
Enum of team color preferences stored by the online service Used with Profile ID PSI_PreferredColor1 & PSI_PreferredColor2

EProfileRaceAcceleratorControlOptions Source code

enum EProfileRaceAcceleratorControlOptions
{
PRACO_Trigger, PRACO_Button
};
Enum of player's race gas control preferences stored by the online service Used with Profile ID PSI_RaceAcceleratorControl

EProfileRaceBrakeControlOptions Source code

enum EProfileRaceBrakeControlOptions
{
PRBCO_Trigger, PRBCO_Button
};
Enum of player's race brake control preferences stored by the online service Used with Profile ID PSI_RaceCameraLocation

EProfileRaceCameraLocationOptions Source code

enum EProfileRaceCameraLocationOptions
{
PRCLO_Behind, PRCLO_Front, PRCLO_Inside
};
Enum of player's race camera preferences stored by the online service Used with Profile ID PSI_RaceCameraLocation

EProfileRaceTransmissionOptions Source code

enum EProfileRaceTransmissionOptions
{
PRTO_Auto, PRTO_Manual
};
Enum of player's car transmission preferences stored by the online service Used with Profile ID PSI_RaceTransmission

EProfileSettingID Source code

enum EProfileSettingID
{
PSI_Unknown, PSI_ControllerVibration, PSI_YInversion, PSI_GamerCred, PSI_GamerRep, PSI_VoiceMuted, PSI_VoiceThruSpeakers, PSI_VoiceVolume, PSI_GamerPictureKey, PSI_GamerMotto, PSI_GamerTitlesPlayed, PSI_GamerAchievementsEarned, PSI_GameDifficulty, PSI_ControllerSensitivity, PSI_PreferredColor1, PSI_PreferredColor2, PSI_AutoAim, PSI_AutoCenter, PSI_MovementControl, PSI_RaceTransmission, PSI_RaceCameraLocation, PSI_RaceBrakeControl, PSI_RaceAcceleratorControl, PSI_GameCredEarned, PSI_GameAchievementsEarned, PSI_EndLiveIds, PSI_ProfileVersionNum, PSI_ProfileSaveCount
};
Enum of profile setting IDs

EProfileVoiceThruSpeakersOptions Source code

enum EProfileVoiceThruSpeakersOptions
{
PVTSO_Off, PVTSO_On, PVTSO_Both
};
Enum of player's voice through speakers preference stored by the online service Used with Profile ID PSI_VoiceThruSpeakers

EProfileXInversionOptions Source code

enum EProfileXInversionOptions
{
PXIO_Off, PXIO_On
};
Enum of player's X axis invert preferences stored by the online service Used with Profile ID PSI_YInversion

EProfileYInversionOptions Source code

enum EProfileYInversionOptions
{
PYIO_Off, PYIO_On
};
Enum of player's Y axis invert preferences stored by the online service Used with Profile ID PSI_YInversion

Functions Detail

AppendVersionToReadIds Source code

native function AppendVersionToReadIds ( )
Adds the version id to the read ids if it is not present

GetProfileSettingDefaultFloat Source code

native function bool GetProfileSettingDefaultFloat ( int ProfileSettingId,out float DefaultFloat )
Searches for the profile setting by id and gets the default value float
@param ProfileSettingId the id of the profile setting to return the default of
@param Value the out value of the default setting
@return true if the profile setting was found and retrieved the default float, false otherwise

GetProfileSettingDefaultId Source code

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
@param ProfileSettingId the id of the profile setting to return
@param DefaultId the out value of the default id
@param ListIndex the out value of the index where that value lies in the ValueMappings list
@return true if the profile setting was found and retrieved the default id, false otherwise

GetProfileSettingDefaultInt Source code

native function bool GetProfileSettingDefaultInt ( int ProfileSettingId,out int DefaultInt )
Searches for the profile setting by id and gets the default value int
@param ProfileSettingId the id of the profile setting to return the default of
@param Value the out value of the default setting
@return true if the profile setting was found and retrieved the default int, false otherwise

ModifyAvailableProfileSettings Source code

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

SetToDefaults Source code

native event SetToDefaults ( )
Sets all of the profile settings to their default values

Defaultproperties 

defaultproperties
{
	
	VersionNumber=-1
	VersionSettingsId=PSI_ProfileVersionNum;
	
	OwnerMappings(0)=(Id=OPPO_None)
	OwnerMappings(1)=(Id=OPPO_OnlineService)
	OwnerMappings(2)=(Id=OPPO_Game)
	
	ProfileMappings(0)=(Id=PSI_ControllerVibration,Name="Controller Vibration",MappingType=PVMT_IdMapped,ValueMappings=((Id=PCVTO_On),(Id=PCVTO_Off)))
	ProfileMappings(1)=(Id=PSI_YInversion,Name="Invert Y",MappingType=PVMT_IdMapped,ValueMappings=((Id=PYIO_Off),(Id=PYIO_On)))
	ProfileMappings(2)=(Id=PSI_VoiceMuted,Name="Mute Voice",MappingType=PVMT_IdMapped,ValueMappings=((Id=0),(Id=1)))
	ProfileMappings(3)=(Id=PSI_VoiceThruSpeakers,Name="Voice Via Speakers",MappingType=PVMT_IdMapped,ValueMappings=((Id=PVTSO_Off),(Id=PVTSO_On),(Id=PVTSO_Both)))
	ProfileMappings(4)=(Id=PSI_VoiceVolume,Name="Voice Volume",MappingType=PVMT_RawValue)
	ProfileMappings(5)=(Id=PSI_GameDifficulty,Name="Difficulty Level",MappingType=PVMT_IdMapped,ValueMappings=((Id=PDO_Normal),(Id=PDO_Easy),(Id=PDO_Hard)))
	ProfileMappings(6)=(Id=PSI_ControllerSensitivity,Name="Controller Sensitivity",MappingType=PVMT_IdMapped,ValueMappings=((Id=PCSO_Medium),(Id=PCSO_Low),(Id=PCSO_High)))
	ProfileMappings(7)=(Id=PSI_PreferredColor1,Name="First Preferred Color",MappingType=PVMT_IdMapped,ValueMappings=((Id=PPCO_None),(Id=PPCO_Black),(Id=PPCO_White),(Id=PPCO_Yellow),(Id=PPCO_Orange),(Id=PPCO_Pink),(Id=PPCO_Red),(Id=PPCO_Purple),(Id=PPCO_Blue),(Id=PPCO_Green),(Id=PPCO_Brown),(Id=PPCO_Silver)))
	ProfileMappings(8)=(Id=PSI_PreferredColor2,Name="Second Preferred Color",MappingType=PVMT_IdMapped,ValueMappings=((Id=PPCO_None),(Id=PPCO_Black),(Id=PPCO_White),(Id=PPCO_Yellow),(Id=PPCO_Orange),(Id=PPCO_Pink),(Id=PPCO_Red),(Id=PPCO_Purple),(Id=PPCO_Blue),(Id=PPCO_Green),(Id=PPCO_Brown),(Id=PPCO_Silver)))
	ProfileMappings(9)=(Id=PSI_AutoAim,Name="Auto Aim",MappingType=PVMT_IdMapped,ValueMappings=((Id=PAAO_Off),(Id=PAAO_On)))
	ProfileMappings(10)=(Id=PSI_AutoCenter,Name="Auto Center",MappingType=PVMT_IdMapped,ValueMappings=((Id=PACO_Off),(Id=PACO_On)))
	ProfileMappings(11)=(Id=PSI_MovementControl,Name="Movement Control",MappingType=PVMT_IdMapped,ValueMappings=((Id=PMCO_L_Thumbstick),(Id=PMCO_R_Thumbstick)))
	ProfileMappings(12)=(Id=PSI_RaceTransmission,Name="Transmission Preference",MappingType=PVMT_IdMapped,ValueMappings=((Id=PRTO_Auto),(Id=PRTO_Manual)))
	ProfileMappings(13)=(Id=PSI_RaceCameraLocation,Name="Race Camera Preference",MappingType=PVMT_IdMapped,ValueMappings=((Id=PRCLO_Behind),(Id=PRCLO_Front),(Id=PRCLO_Inside)))
	ProfileMappings(14)=(Id=PSI_RaceBrakeControl,Name="Brake Preference",MappingType=PVMT_IdMapped,ValueMappings=((Id=PRBCO_Trigger),(Id=PRBCO_Button)))
	ProfileMappings(15)=(Id=PSI_RaceAcceleratorControl,Name="Accelerator Preference",MappingType=PVMT_IdMapped,ValueMappings=((Id=PRACO_Trigger),(Id=PRACO_Button)))
}
Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:53.602 - Created with UnCodeX