UTimeManagementBlueprintLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

TimeManagement

Header

/Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h

Include

#include "TimeManagementBlueprintLibrary.h"

Syntax

class UTimeManagementBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static

FFrameNumber

 

Add_FrameNumberFrameNumber

(
    FFrameNumber A,
    FFrameNumber B
)

Addition (FrameNumber A + FrameNumber B)

Public function Static

FFrameNumber

 

Add_FrameNumberInteger

(
    FFrameNumber A,
    int32 B
)

Addition (FrameNumber A + int B)

Public function Static

int32

 

Conv_FrameNumberToInteger

(
    const FFrameNumber& InFrameNumber
)

Converts a FrameNumber to an int32 for use in functions that take int32 frame counts for convenience.

Public function Static

float

 

Conv_FrameRateToSeconds

(
    const FFrameRate& InFrameRate
)

Converts an FrameRate to a float ie: 1/30 returns 0.0333333

Public function Static

float

 

Conv_QualifiedFrameTimeToSeconds

(
    const FQualifiedFrameTime& InFrame...
)

Converts an QualifiedFrameTime to seconds.

Public function Static

FString

 

Conv_TimecodeToString

(
    const FTimecode& InTimecode,
    bool bForceSignDisplay
)

Converts an Timecode to a string (hh:mm:ss:ff).

Public function Static

FFrameNumber

 

Divide_FrameNumberInteger

(
    FFrameNumber A,
    int32 B
)

Divide (FrameNumber A / B)

Public function Static

FTimecode

 

GetTimecode()

Get the current timecode of the engine.

Public function Static

FFrameRate

 

GetTimecodeFrameRate()

Gets the current timecode frame rate.

Public function Static

bool

 

IsValid_Framerate

(
    const FFrameRate& InFrameRate
)

Verifies that this is a valid framerate with a non-zero denominator.

Public function Static

bool

 

IsValid_MultipleOf

(
    const FFrameRate& InFrameRate,
    const FFrameRate& OtherFramerate
)

Checks if this framerate is an even multiple of another framerate, ie: 60 is a multiple of 30, but 59.94 is not.

Public function Static

FFrameNumber

 

Multiply_FrameNumberInteger

(
    FFrameNumber A,
    int32 B
)

Multiply (FrameNumber A * B)

Public function Static

FFrameTime

 

Multiply_SecondsFrameRate

(
    float TimeInSeconds,
    const FFrameRate& FrameRate
)

Multiplies a value in seconds against a FrameRate to get a new FrameTime.

Public function Static

FFrameTime

 

SnapFrameTimeToRate

(
    const FFrameTime& SourceTime,
    const FFrameRate& SourceRate,
    const FFrameRate& SnapToRate
)

Snaps the given SourceTime to the nearest frame in the specified Destination Framerate.

Public function Static

FFrameNumber

 

Subtract_FrameNumberFrameNumber

(
    FFrameNumber A,
    FFrameNumber B
)

Subtraction (FrameNumber A - FrameNumber B)

Public function Static

FFrameNumber

 

Subtract_FrameNumberInteger

(
    FFrameNumber A,
    int32 B
)

Subtraction (FrameNumber A - int B)

Public function Static

FFrameTime

 

TransformTime

(
    const FFrameTime& SourceTime,
    const FFrameRate& SourceRate,
    const FFrameRate& DestinationRate
)

Converts the specified time from one framerate to another framerate.