UE3:UTProfileSettings instance functions (UDK)

Object >> OnlinePlayerStorage >> OnlineProfileSettings >> UTProfileSettings (instance functions)

UTProfileSettings instance functions in other games:

UT3

Other member categories for this class:

constants, defaults, enums, properties

Instance functions

ActionIsBound

function bool ActionIsBound (EDigitalButtonActions ActionIdx)

Whether an action has been bound or not.

AddPersistentKey

function bool AddPersistentKey (ESinglePlayerPersistentKeys AddKey)

Add a PersistentKey

Parameters:

• AddKey - The Persistent Key to add

Returns:

true if successful.

ApplyAllKeyBindings

function ApplyAllKeyBindings (PlayerInput PInput)

Applies all possible bindings to the specified player input.

Parameters:

• InPlayerInput - PlayerInput to bind keys on

ApplyKeyBinding

function ApplyKeyBinding (PlayerInput PInput, EDigitalButtonActions KeyBinding)

Applies a key binding to the given player input, rebinds keys that are already bound, doesn't unbind keys already assigned to the action.

Parameters:

• InPlayerInput - PlayerInput to bind keys on
• KeyBinding - Action to bind keys for.

AreAnyChaptersUnlocked

function bool AreAnyChaptersUnlocked ()

bGameInProgress

function bool bGameInProgress ()

Returns:

true if a game is in progress

FindKeyEnum

function int FindKeyEnum (name KeyName)

Looks up a keybinding enum value given its name.

Parameters:

• KeyName - Key name to look up the enum for.

Returns:

Returns the enum value for the key or INDEX_NONE if none was found.

FindKeyName

function name FindKeyName (EUTBindableKeys KeyEnum)

Looks up a keybinding name given an enum value

Parameters:

• KeyName - Key name to look up the enum for.

Returns:

Returns the name for the key if it exists, or otherwise.

GetActionName

function string GetActionName (EDigitalButtonActions ActionIdx)

GetCampaignSkillLevel

function int GetCampaignSkillLevel ()

GetChapterMask

function int GetChapterMask ()

GetCurrentMissionData

function GetCurrentMissionData (out int MissionID, out int MissionResult)

Parameters:

• MissionID - Returns the Mission ID for the current mission
• MissionResult - Returns the results for the last mission.

GetDBAFromCommand

function int GetDBAFromCommand (string Command)

Attempts to find a digital button action enum using a string command

Parameters:

• Command - Command to find

Returns:

an EDigitalButtonAction enum value if one exists, INDEX_NONE otherwise.

GetProfileIDForDBA

function int GetProfileIDForDBA (EDigitalButtonActions KeyAction)

Returns the profile ID for a digital button action.

Parameters:

• KeyAction - Action to return a profile ID for.

Returns:

Returns the profile ID for the action.

GetProfileSettingValueFloatByName

function bool GetProfileSettingValueFloatByName (name SettingName, out float OutValue)

Returns the float value of a profile setting given its name.

Returns:

Whether or not the value was retrieved

GetProfileSettingValueIdByName

function bool GetProfileSettingValueIdByName (name SettingName, out int OutValue)

Returns the Id mapped value of a profile setting given its name.

Returns:

Whether or not the value was retrieved

GetProfileSettingValueIntByName

function bool GetProfileSettingValueIntByName (name SettingName, out int OutValue)

Returns the integer value of a profile setting given its name.

Returns:

Whether or not the value was retrieved

GetProfileSettingValueStringByName

function bool GetProfileSettingValueStringByName (name SettingName, out string OutValue)

Returns the string value of a profile setting given its name.

Returns:

Whether or not the value was retrieved

HasPersistentKey

function bool HasPersistentKey (ESinglePlayerPersistentKeys SearchKey, optional out int PSI_Index)

Check to see if a Persistent Key has been set.

Parameters:

• SearchKey - The Persistent Key to look for
• PSI_Index - Optional Out> returns the PSI Index for the slot holding the key

Returns:

true if the key exists, false if it doesn't

IsChapterUnlocked

function bool IsChapterUnlocked (int ChapterIndex)

NewGame

function NewGame ()

Resets the single player game profile settings for a new game

RemoveDBABindings

function RemoveDBABindings (PlayerInput PInput)

Removes any binds the profile manages.

RemovePersistentKey

function bool RemovePersistentKey (ESinglePlayerPersistentKeys RemoveKey)

Remove a PersistentKey

Parameters:

• RemoveKey - The Persistent Key to remove

Returns:

true if successful

SetCampaignSkillLevel

function SetCampaignSkillLevel (int NewSkillLevel)

SetChapterMask

function SetChapterMask (int NewMask)

SetCurrentMissionData

function SetCurrentMissionData (int NewMissionID, int bNewMissionResult)

SetKeyBinding

function SetKeyBinding (EDigitalButtonActions KeyAction, name KeyBinding, optional name KeyBinding2, optional name KeyBinding3, optional name KeyBinding4)

Sets a binding for a specified key action.

Parameters:

• KeyAction - DBA to bind
• KeyBinding1 - Key to bind #1
• KeyBinding2 - Key to bind #2
• KeyBinding3 - Key to bind #3
• KeyBinding4 - Key to bind #4

SetKeyBindingUsingCommand

function SetKeyBindingUsingCommand (string KeyCommand, name KeyBinding, optional name KeyBinding2, optional name KeyBinding3, optional name KeyBinding4)

Sets a binding for a specified command.

Parameters:

• KeyAction - DBA to bind
• KeyBinding1 - Key to bind #1
• KeyBinding2 - Key to bind #2
• KeyBinding3 - Key to bind #3
• KeyBinding4 - Key to bind #4

StoreKeysUsingPlayerInput

function StoreKeysUsingPlayerInput (optional PlayerInput PInput)

Stores key settings in the profile using the player input object provided.

Parameters:

• PInput - Player input to get bindings from.

UnbindKey

function UnbindKey (PlayerInput PInput, name BindName)

Unbinds the specified key.

Parameters:

• PInput - Player input to operate on
• BindName - Key to unbind

UnlockChapter

function UnlockChapter (int ChapterIndex)