FModifierKeysState

[FModifierKeysState](API\Runtime\ApplicationCore\GenericPlatform\FModifierKeysState) stores the pressed state of keys that are commonly used as modifiers

Windows
MacOS
Linux

References

Module

ApplicationCore

Header

/Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/GenericApplication.h

Include

#include "GenericPlatform/GenericApplication.h"

Syntax

class FModifierKeysState

Remarks

FModifierKeysState stores the pressed state of keys that are commonly used as modifiers

Constructors

Name Description

Public function

FModifierKeysState()

Public function

FModifierKeysState

(
    const bool bInIsLeftShiftDown,
    const bool bInIsRightShiftDown,
    const bool bInIsLeftControlDown,
    const bool bInIsRightControlDown,
    const bool bInIsLeftAltDown,
    const bool bInIsRightAltDown,
    const bool bInIsLeftCommandDown,
    const bool bInIsRightCommandDown,
    const bool bInAreCapsLocked
)

  1. Events are immutable once constructed.

Functions

Name Description

Public function Const

bool

 

AreCapsLocked()

Public function Const

bool

 

AreModifersDown

(
    EModifierKey::Type ModiferKeys
)

Public function Const

bool

 

IsAltDown()

Returns true if either alt key was down when this event occurred

Public function Const

bool

 

IsCommandDown()

Returns true if either command key was down when this event occurred

Public function Const

bool

 

IsControlDown()

Returns true if either control key was down when this event occurred

Public function Const

bool

 

IsLeftAltDown()

Returns true if left alt key was down when this event occurred

Public function Const

bool

 

IsLeftCommandDown()

Returns true if left command key was down when this event occurred

Public function Const

bool

 

IsLeftControlDown()

Returns true if left control key was down when this event occurred

Public function Const

bool

 

IsLeftShiftDown()

Returns true if left shift key was down when this event occurred

Public function Const

bool

 

IsRightAltDown()

Returns true if right alt key was down when this event occurred

Public function Const

bool

 

IsRightCommandDown()

Returns true if right command key was down when this event occurred

Public function Const

bool

 

IsRightControlDown()

Returns true if right control key was down when this event occurred

Public function Const

bool

 

IsRightShiftDown()

Returns true if right shift key was down when this event occurred

Public function Const

bool

 

IsShiftDown()

Returns true if either shift key was down when this event occurred

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback