UTGame.UTUIKeyBindingList

Extends

UTUIOptionList

Modifiers

placeable native ( UIFrontEnd )

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. Keybinding List, exposes a set of UTUIDataProvider_KeyBinding objects to the user so they can bind keys.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIScreenObject
      |   
      +-- Engine.UIObject
         |   
         +-- UTGame.UTUI_Widget
            |   
            +-- UTGame.UTDrawPanel
               |   
               +-- UTGame.UTUIOptionList
                  |   
                  +-- UTGame.UTUIKeyBindingList

Functions Summary
		AttemptKeyBind ()))
	bool	BindingsHaveChanged ()))
		BindKey ()))
		CancelKeyBind ()))
		ClickedScrollZone (UIScrollbar Sender, float PositionPerc, int PlayerIndex ))
		FinishBinding ()))
		FinishKeyDialog (bool bPromptForBindStomp))
	String	GetBindKeyFromCommand (PlayerInput PInput, String Command, out int StartIdx)
	int	GetFirstUnboundCrucialBind ()))
	PlayerInput	GetPlayerInput ()))
	bool	HandleInputKey (const out InputEventParameters EventParms ))
	bool	IsAlreadyBound (Name KeyName))
		OnBindDialogSceneDeactivated (UIScene DeactivatedScene ))
	bool	OnBindKey_InputKey (const out InputEventParameters EventParms ))
		OnBindStompWarning_Closed ()))
	bool	OnButton_InputKey (const out InputEventParameters EventParms ))
	bool	OnClicked (UIScreenObject Sender, int PlayerIndex ))
		OnMenu_BindOverwrite_Confirm (UTUIScene_MessageBox MessageBox, int SelectedItem, int PlayerIndex))
		OnStompBindDialogSceneDeactivated (UIScene DeactivatedScene ))
		PostInitialize ()))
		RefreshBindingLabels ()
		RegenerateOptions ()
		ReloadDefaults ()))
		RepositionOptions ()
	bool	ScrollVertical (UIScrollbar Sender, float PositionChange, optional bool bPositionMaxed=false ))
	bool	SelectNextItem (optional bool bWrap=false, optional int PlayerIndex=GetBestPlayerIndex()))
	bool	SelectPreviousItem (optional bool bWrap=false, optional int PlayerIndex=GetBestPlayerIndex()))
		SpawnBindStompWarningMessage ()))
		UnbindKey (name BindName))

bCurrentlyBindingKey Source code

Whether or not we should try to bind the next key.

CrucialBindValues Source code

List of bools to keep track of crucial binds that must be bound before exiting screen, the length of this array should match the generated objects array.

CurrentBindings Source code

Current bindings for each of the buttons, the length of this array should match the generated objects array.

CurrentlyBindingObject Source code

Which button we are currently rebinding.

CurrKeyBindData Source code

Key bind data to be passed from function to function and into message logic when attempting a key bind.

LocalizedFriendlyNames Source code

List of friendly label names for the actions being bound to.

MessageBoxReference Source code

Reference to the message box scene.

NonIntrusiveMessageBoxScene Source code

Global scene reference for non intrusive message box scene

NumButtons Source code

Number of buttons to display for each key binding.

StoredBindings Source code

Stored bindings for each of the buttons, the length of this array should match the generated objects array. This array stores the starting values for CurrentBindings so we know if any changes were made.

BindKeyData Source code

Structure to store all pertinent data when in the process of binding a key.
bBindIsPrimary:

Whether the bind is the primary or secondary bind.

bPromptForDuplicate:

Whether to prompt about duplicate binds or not.

Command:

Command to bind to the KeyName

KeyName:

New key to bind to.

PInput:

Player input object to bind in.

PreviousBinding:

The previous key bound to.

AttemptKeyBind Source code

Attempts to bind the specified key to an action. Will prompt user of bind stomping.

BindingsHaveChanged Source code

Whether any changes have been made to the bindings.

BindKey Source code

Binds the specified key to an action.

CancelKeyBind Source code

Cancels out of an attempted bind.

ClickedScrollZone Source code

Handler for the vertical scrollbar's OnClickedScrollZone delegate. Scrolls the list by a full page (MaxVisibleItems).
@param Sender the scrollbar that was clicked.
@param PositionPerc a value from 0.0 - 1.0, representing the location of the click within the region between the increment and decrement buttons. Values closer to 0.0 means that the user clicked near the decrement button; values closer to 1.0 are nearer the increment button.
@param PlayerIndex Player that performed the action that issued the event.

FinishBinding Source code

Finishes the binding process by clearing variables and closing the bind key dialog.

FinishKeyDialog Source code

Closes the key dialog

GetBindKeyFromCommand Source code

Get the binding key using the command as the key and starting from a specific place in the list.

GetFirstUnboundCrucialBind Source code

Returns the index in the CrucialBindValues array of the first crucial bind not bound. Returns -1 if all is good.

GetPlayerInput Source code

Returns the player input object for the player that owns this widget.

HandleInputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

IsAlreadyBound Source code

Whether or not a key is already bound to a command.

OnBindDialogSceneDeactivated Source code

Called when the bind dialog is closed.

OnBindKey_InputKey Source code

Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.) Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8). This delegate is called BEFORE kismet is given a chance to process the input.
@param EventParms information about the input event.
@return TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnBindStompWarning_Closed Source code

Callback for when the warning for stomping binds dialog has finished closing.

OnButton_InputKey Source code

Callback for the mutator lists, captures the accept button before the mutators get to it.

OnClicked Source code

Callback for all of the options we generated.

OnMenu_BindOverwrite_Confirm Source code

Confirmation for rebinding of an already bound key message bos.

OnStompBindDialogSceneDeactivated Source code

Called when the bind dialog is closed.

PostInitialize Source code

Post initialize, binds callbacks for all of the generated options.

RefreshBindingLabels Source code

Refreshes the binding labels for all of the buttons.

RegenerateOptions Source code

Generates widgets for all of the options.

ReloadDefaults Source code

Reloads default values from the default INI (PC Only).

RepositionOptions Source code

Repositions all of the visible options.

ScrollVertical Source code

Handler for vertical scrolling activity PositionChange should be a number of nudge values by which the slider was moved
@param Sender the scrollbar that generated the event.
@param PositionChange indicates how many items to scroll the list by
@param bPositionMaxed indicates that the scrollbar's marker has reached its farthest available position, unused in this function

SelectNextItem Source code

Selects the next item in the list.

SelectPreviousItem Source code

Selects the previous item in the list.

SpawnBindStompWarningMessage Source code

Spawns the message dialog so we can warn the player about stomping a key bind.

UnbindKey Source code

Unbinds the specified key.

defaultproperties
{
   Begin Object Class=UIComp_Event Name=WidgetEventComponent ObjName=WidgetEventComponent Archetype=UIComp_Event'UTGame.Default__UTUIOptionList:WidgetEventComponent'
      ObjectArchetype=UIComp_Event'UTGame.Default__UTUIOptionList:WidgetEventComponent'
   End Object
   EventProvider=WidgetEventComponent
   Name="Default__UTUIKeyBindingList"
   ObjectArchetype=UTUIOptionList'UTGame.Default__UTUIOptionList'
}