FInputBindingManager

Manager responsible for creating and processing input bindings.

Windows
MacOS
Linux

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.

Constructors

No constructors are accessible with public or protected access.

Destructors

Name Description

Public function Virtual

~FInputBindingManager()

Virtual destructor

Functions

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 blacklist and whitelist filters

Public function

void

 

CreateInputCommand

(
    const TSharedRef< FBindingContext >...,
    TSharedRef< FUICommandInfo > InUICo...
)

Creates an input command from the specified user interface action

Public function Const

const TShare...

 

FindCommandInContext

(
    const FName InBindingContext,
    const FName CommandName
)

Finds the command in the provided context which has the provided name

Public function Const

const TShare...

 

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

FInputBindin...

 

Get()

Public function Const

const TShare...

 

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 ...
)

Returns all known command infos for a given binding context

Public function

TSharedPtr< ...

 

GetContextByName

(
    const FName& InContextName
)

Look up a binding context by name.

Public function Const

void

 

GetKnownInputContexts

Returns a list of all known input contexts

Public function

bool

 

GetUserDefinedChord

(
    const FName InBindingContext,
    const FName InCommandName,
    const EMultipleKeyBindingIndex InCh...,
    FInputChord& OutUserDefinedChord
)

Gets the user defined chord (if any) from the provided command name

Public function Virtual

void

 

NotifyActiveChordChanged

(
    const FUICommandInfo& CommandInfo,
    const EMultipleKeyBindingIndex InCh...
)

Called when the active chord is changed on a command

Public function

FDelegateHan...

 

RegisterUserDefinedChordChanged

(
    const FOnUserDefinedChordChanged::F...
)

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 >...,
    TSharedRef< FUICommandInfo > InUICo...
)

Removes an input command, allowing a new one to take its place

Public function

void

 

RemoveUserDefinedChords()

Removes any user defined chords

Public function

void

 

SaveInputBindings()

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

void

 

UnregisterUserDefinedChordChanged

(
    FDelegateHandle DelegateHandle
)

Unregisters a delegate to be called when a user-defined chord is edited

Enums

Name

Description

Public enum

ECommandFilterType

Type of filter.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss