UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FIntervalCountdown Struct Reference

#include <AITypes.h>

Public Member Functions

 FIntervalCountdown (const float InInterval=-1.f)
 
void Set (const float InNewTimeLeft)
 
bool Tick (const float TimeDelta)
 
void Reset ()
 
float GetElapsedTime () const
 
float GetElapsedTimeWithFallback (const float FallbackValue) const
 

Public Attributes

float Interval
 
float TimeLeft
 

Constructor & Destructor Documentation

◆ FIntervalCountdown()

FIntervalCountdown::FIntervalCountdown ( const float  InInterval = -1.f)
inlineexplicit

Member Function Documentation

◆ GetElapsedTime()

float FIntervalCountdown::GetElapsedTime ( ) const
inline

Note that this function returns meaningful results only if Interval > 0

◆ GetElapsedTimeWithFallback()

float FIntervalCountdown::GetElapsedTimeWithFallback ( const float  FallbackValue) const
inline
Returns
If Interval > 0 returns time accumulated since resetting. Oterwise returns FallbackValue

◆ Reset()

void FIntervalCountdown::Reset ( )
inline

resets the countdown back to Interval

◆ Set()

void FIntervalCountdown::Set ( const float  InNewTimeLeft)
inline

◆ Tick()

bool FIntervalCountdown::Tick ( const float  TimeDelta)
inline
Returns
True if time's up

Member Data Documentation

◆ Interval

float FIntervalCountdown::Interval

◆ TimeLeft

float FIntervalCountdown::TimeLeft

The documentation for this struct was generated from the following file: