1. Epic GamesDeveloper
  3. FInputBindingManager

FInputBindingManager

Manager responsible for creating and processing input bindings.

API > API/Runtime > API/Runtime/Slate

Manager responsible for creating and processing input bindings.

   
Name FInputBindingManager
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/Commands/InputBindingManager.h
Include Path #include "Framework/Commands/InputBindingManager.h"

Syntax

class FInputBindingManager

Constructors

Name Remarks Include Path Unreal Specifiers

FInputBindingManager()

 Hidden default constructor. Framework/Commands/InputBindingManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FInputBindingManager()

 Virtual destructor Framework/Commands/InputBindingManager.h  

Structs

Name Remarks
FCommandFilterForContext  
FCommandFilterOwners  
FContextEntry  

Enums

Public

Name Remarks
ECommandFilterType Type of filter.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnRegisterCommandList FOnRegisterCommandList A delegate for systems to subscribe to any other system exposing their command lists Framework/Commands/InputBindingManager.h  
OnUnregisterCommandList FOnRegisterCommandList A delegate for systems to subscribe to any other system unregistering their command lists Framework/Commands/InputBindingManager.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CommandFiltersByContext TMap< FName, FCommandFilterForContext > Mapping of command filters by context Framework/Commands/InputBindingManager.h  
ContextMap TMap< FName, FContextEntry > A mapping of context name to the associated entry map Framework/Commands/InputBindingManager.h  
OnUserDefinedChordChanged FOnUserDefinedChordChanged Delegate called when a user-defined chord is edited Framework/Commands/InputBindingManager.h  
ParentToChildMap TMultiMap< FName, FName > A mapping of contexts to their child contexts Framework/Commands/InputBindingManager.h  
ProjectDefinedChords TSharedPtr< class FUserDefinedChords > Project defined chord overrides for commands Framework/Commands/InputBindingManager.h  
UserDefinedChords TSharedPtr< class FUserDefinedChords > User defined chord overrides for commands Framework/Commands/InputBindingManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCommandFilter ( const FName InOwnerName,
const FName InBindingContext,
const FName InCommandName,
const ECommandFilterType FilterType
)

 Filters a command by name Framework/Commands/InputBindingManager.h  

bool CommandPassesFilter ( const FName InBindingContext,
const FName InCommandName
) const

 Command passes allow/deny list filters Framework/Commands/InputBindingManager.h  

void CreateInputCommand ( const TSharedRef< FBindingContext >& InBindingContext,
TSharedRef< FUICommandInfo > InUICommandInfo
)

 Creates an input command from the specified user interface action Framework/Commands/InputBindingManager.h  

const TSharedPtr< FUICommandInfo > FindCommandInContext ( const FName InBindingContext,
const FName CommandName
) const

 Finds the command in the provided context which has the provided name Framework/Commands/InputBindingManager.h  

const TSharedPtr< FUICommandInfo > FindCommandInContext ( const FName InBindingContext,
const FInputChord& InChord,
bool bCheckDefault
) const

 Finds the command in the provided context which uses the provided input chord Framework/Commands/InputBindingManager.h  

const TSharedPtr< FUICommandInfo > GetCommandInfoFromInputChord ( const FName InBindingContext,
const FInputChord& InChord,
bool bCheckDefault
) const

 Returns a command info that is has the same active chord as the provided chord and is in the same binding context or parent context Framework/Commands/InputBindingManager.h  

void GetCommandInfosFromContext ( const FName InBindingContext,
TArray< TSharedPtr< FUICommandInfo > >& OutCommandInfos
) const

 Returns all known command infos for a given binding context Framework/Commands/InputBindingManager.h  

TSharedPtr< FBindingContext > GetContextByName ( const FName& InContextName
)

 Look up a binding context by name. Framework/Commands/InputBindingManager.h  

void GetKnownInputContexts ( TArray< TSharedPtr< FBindingContext > >& OutInputContexts
) const

 Returns a list of all known input contexts Framework/Commands/InputBindingManager.h  

bool GetProjectDefinedChord ( const FName InBindingContext,
const FName InCommandName,
const EMultipleKeyBindingIndex InChordIndex,
FInputChord& OutUserDefinedChord
)

 Gets the project defined chord (if any) from the provided command name Framework/Commands/InputBindingManager.h  

bool GetUserDefinedChord ( const FName InBindingContext,
const FName InCommandName,
const EMultipleKeyBindingIndex InChordIndex,
FInputChord& OutUserDefinedChord
)

 Gets the user defined chord (if any) from the provided command name Framework/Commands/InputBindingManager.h  

virtual void NotifyActiveChordChanged ( const FUICommandInfo& CommandInfo,
const EMultipleKeyBindingIndex InChordIndex
)

 Called when the active chord is changed on a command Framework/Commands/InputBindingManager.h  

bool RegisterCommandList ( const ::FName InBindingContext,
TSharedRef< FUICommandList > CommandList
) const

 Exposes the given command list and its context to all OnRegisterCommandList subscribers Framework/Commands/InputBindingManager.h  

TSharedPtr< FUICommandList > RegisterNewCommandList ( const FName InBindingContext
) const

 Exposes a new given command list from the given context to all OnRegisterCommandList subscribers Framework/Commands/InputBindingManager.h  

FDelegateHandle RegisterUserDefinedChordChanged ( const FOnUserDefinedChordChanged::FDelegate& Delegate
)

 Registers a delegate to be called when a user-defined chord is edited Framework/Commands/InputBindingManager.h  

void RemoveContextByName ( const FName& InContextName
)

 Remove the context with this name Framework/Commands/InputBindingManager.h  

void RemoveInputCommand ( const TSharedRef< FBindingContext >& InBindingContext,
TSharedRef< FUICommandInfo > InUICommandInfo
)

 Removes an input command, allowing a new one to take its place Framework/Commands/InputBindingManager.h  

void RemoveUserDefinedChords()

 Removes any user defined chords Framework/Commands/InputBindingManager.h  

void SaveInputBindings()

 Saves the user defined chords to a json file Framework/Commands/InputBindingManager.h  

void UnregisterCommandFilterOwner ( const FName InOwnerName
)

 Removes all filters associated with an owner Framework/Commands/InputBindingManager.h  

bool UnregisterCommandList ( const ::FName InBindingContext,
TSharedRef< FUICommandList > CommandList
) const

 Exposes the given command list and its context to all OnUnregisterCommandList subscribers Framework/Commands/InputBindingManager.h  

void UnregisterUserDefinedChordChanged ( FDelegateHandle DelegateHandle
)

 Unregisters a delegate to be called when a user-defined chord is edited Framework/Commands/InputBindingManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static FInputBindingManager & Get()

   Framework/Commands/InputBindingManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page