UInputTriggerPulse

[UInputTriggerPulse](API\Plugins\EnhancedInput\UInputTriggerPulse) Trigger that fires at an Interval, in seconds, while input is actuated.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

EnhancedInput

Header

/Engine/Plugins/Experimental/EnhancedInput/Source/EnhancedInput/Public/InputTriggers.h

Include

#include "InputTriggers.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintable, MinimalAPI, Meta=(DisplayName="Pulse"))
class UInputTriggerPulse : public UInputTriggerTimedBase

Remarks

UInputTriggerPulse Trigger that fires at an Interval, in seconds, while input is actuated.

Completed only fires when the repeat limit is reached or when input is released immediately after being triggered. Otherwise, Canceled is fired when input is released.

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadWrite Config

bool

 

bTriggerOnStart

Whether to trigger when the input first exceeds the actuation threshold or wait for the first interval?

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite Config

float

 

Interval

How long between each trigger fire while input is held, in seconds?

Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite Config

int32

 

TriggerLimit

How many times can the trigger fire while input is held? (0 = no limit)

Overridden from UInputTrigger

Name Description

Public function Virtual Const

FString

 

GetDebugState()

Provide debug output for use with ShowDebug EnhancedInput. Return an empty string to disable display.

Protected function Virtual

ETriggerStat...

 

UpdateState_Implementation

(
    const UEnhancedPlayerInput* Pl...,
    FInputActionValue ModifiedValue,
    float DeltaTime
)

Transitions to Ongoing on actuation. Never triggers.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss