1. Epic GamesDeveloper
  3. FInputBindingManager

FInputBindingManager

Manager responsible for creating and processing input bindings.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Commands

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Commands/InputBindingManager.h
Include #include "Framework/Commands/InputBindingManager.h"

Syntax

class FInputBindingManager

Remarks

Manager responsible for creating and processing input bindings.

Variables

  Type Name Description
Public variable FOnRegisterCommandList OnRegisterCommandList A delegate for systems to subscribe to any other system exposing their command lists
Public variable FOnRegisterCommandList OnUnregisterCommandList A delegate for systems to subscribe to any other system unregistering their command lists

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function Virtual   Virtual destructor

Functions

  Type Name Description
Public function void

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

 Filters a command by name
Public function Const bool

CommandPassesFilter ( const FName InBindingContext,
const FName InCommandName
)

 Command passes allow/deny list filters
Public function void

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

 Creates an input command from the specified user interface action
Public function Const const TSharedPtr< FUICommandInfo >

FindCommandInContext ( const FName InBindingContext,
const FName CommandName
)

 Finds the command in the provided context which has the provided name
Public function Const const TSharedPtr< FUICommandInfo >

FindCommandInContext ( const FName InBindingContext,
const FInputChord& InChord,
bool bCheckDefault
)

 Finds the command in the provided context which uses the provided input chord
Public function Static FInputBindingManager &

Get ()

  
Public function Const const TSharedPtr< FUICommandInfo >

GetCommandInfoFromInputChord ( const FName InBindingContext,
const FInputChord& InChord,
bool bCheckDefault
)

 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
Public function Const void

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

 Returns all known command infos for a given binding context
Public function TSharedPtr< FBindingContext >

GetContextByName ( const FName& InContextName
)

 Look up a binding context by name.
Public function Const void Returns a list of all known input contexts
Public function 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
Public function 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
Public function Virtual void

NotifyActiveChordChanged ( const FUICommandInfo& CommandInfo,
const EMultipleKeyBindingIndex InChordIndex
)

 Called when the active chord is changed on a command
Public function Const bool

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

 Exposes the given command list and its context to all OnRegisterCommandList subscribers
Public function Const TSharedPtr< FUICommandList >

RegisterNewCommandList ( const FName InBindingContext
)

 Exposes a new given command list from the given context to all OnRegisterCommandList subscribers
Public function FDelegateHandle

RegisterUserDefinedChordChanged ( const FOnUserDefinedChordChanged::FDelegate& Delegate
)

 Registers a delegate to be called when a user-defined chord is edited
Public function void

RemoveContextByName ( const FName& InContextName
)

 Remove the context with this name
Public function void

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

 Removes an input command, allowing a new one to take its place
Public function void Removes any user defined chords
Public function void Saves the user defined chords to a json file
Public function void

UnregisterCommandFilterOwner ( const FName InOwnerName
)

 Removes all filters associated with an owner
Public function Const bool

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

 Exposes the given command list and its context to all OnUnregisterCommandList subscribers
Public function void Unregisters a delegate to be called when a user-defined chord is edited

Enums

  Type Name Description
Public enum ECommandFilterType Type of filter.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page