FInputBehaviorModifierStates

[FInputBehaviorModifierStates](API\Runtime\InteractiveToolsFramework\BaseBehaviors\FInputBehaviorModifierStates) is an object that can be placed in an InputBehavior to allow users of the behavior to request that they be notified about modifier keys/buttons/etc state.

Choose your operating system:

Windows

macOS

Linux

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/InputBehaviorModifierStates.h

Include

#include "BaseBehaviors/InputBehaviorModifierStates.h"

Syntax

class FInputBehaviorModifierStates

Remarks

FInputBehaviorModifierStates is an object that can be placed in an InputBehavior to allow users of the behavior to request that they be notified about modifier keys/buttons/etc state.

We don't know ahead of time what might be used to determine modifier state, which input devices might be used, etc. So the user has to register (ModifierID,ModifierTestFunction) pairs. The behavior then calls UpdateModifiers() which will query each of the test functions and notify the target object about the state of the modifier.

Variables

Name Description

Protected variable

TArray< int >

 

ModifierIDs

List of modifier IDs that have been registered

Protected variable

TMap< int, FMod...

 

ModifierTests

The modifier test function for each ID

Functions

Name Description

Public function Const

bool

 

HasModifiers()

Public function

void

 

RegisterModifier

(
    int ModifierID,
    const FModifierTestFunction& Modif...
)

Register a modifier ID and an associated test function

Public function Const

void

 

UpdateModifiers

(
    const FInputDeviceState& Input,
    IModifierToggleBehaviorTarget*...
)

Look up the current state of each registered modifier and pass to the target

Typedefs

Name

Description

FModifierTestFunction