1. Epic GamesDeveloper
  3. UTimeManagementBlueprintLibrary

UTimeManagementBlueprintLibrary

API > API/Runtime > API/Runtime/TimeManagement

   
Name UTimeManagementBlueprintLibrary
Type class
Header File /Engine/Source/Runtime/TimeManagement/Public/TimeManagementBlueprintLibrary.h
Include Path #include "TimeManagementBlueprintLibrary.h"

Syntax

UCLASS (Meta=(BlueprintThreadSafe, ScriptName="TimeManagementLibrary"), MinimalAPI)  
class UTimeManagementBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FFrameNumber Add_FrameNumberFrameNumber ( FFrameNumber A,
FFrameNumber B
)

 Addition (FrameNumber A + FrameNumber B) TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber + FrameNumber", CompactNodeTitle="+", Keywords="+ add plus", CommutativeAssociativeBinaryOperator="true", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator="+;+=")
  • Category="Utilities|Time Management"

static FFrameNumber Add_FrameNumberInteger ( FFrameNumber A,
int32 B
)

 Addition (FrameNumber A + int B) TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber + Int", CompactNodeTitle="+", Keywords="+ add plus", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator="+;+=")
  • Category="Utilities|Time Management"

static int32 Conv_FrameNumberToInteger ( const FFrameNumber& InFrameNumber
)

 Converts a FrameNumber to an int32 for use in functions that take int32 frame counts for convenience. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber to Integer", ScriptName="FrameNumberToInteger", BlueprintAutocast)
  • Category="Utilities|Time Management"

static float Conv_FrameRateToInterval ( const FFrameRate InFrameRate
)

 Converts a FrameRate to an interval float representing the frame time in seconds ie: 1/30 returns 0.0333333 TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameRate To Interval", BlueprintAutocast)
  • Category="Utilities|Time Management"

static float Conv_FrameRateToSeconds ( const FFrameRate& InFrameRate
)

 Converts an FrameRate to a float ie: 1/30 returns 0.0333333 TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameRate To Seconds", BlueprintAutocast, DeprecatedFunction, DeprecationMessage="FrameRateToInterval replaces this function, which returns the expected result of seconds per frame, rather than (incorrectly) frames per second.")
  • Category="Utilities|Time Management"

static float Conv_QualifiedFrameTimeToSeconds ( const FQualifiedFrameTime& InFrameTime
)

 Converts an QualifiedFrameTime to seconds. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="QualifiedFrameTime To Seconds", BlueprintAutocast)
  • Category="Utilities|Time Management"

static FString Conv_TimecodeToString ( const FTimecode& InTimecode,
bool bForceSignDisplay
)

 Converts an Timecode to a string (hh:mm:ss:ff). TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Timecode To String", BlueprintAutocast)
  • Category="Utilities|Time Management"

static FFrameNumber Divide_FrameNumberInteger ( FFrameNumber A,
int32 B
)

 Divide (FrameNumber A / B) TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber / FrameNumber", CompactNodeTitle="/", Keywords="/ divide", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator="/;/=")
  • Category="Utilities|Time Management"

static FTimecode GetTimecode()

 Get the current timecode of the engine. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Category="Utilities|Time Management"

static FFrameRate GetTimecodeFrameRate()

 Gets the current timecode frame rate. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Category="Utilities|Time Management"

static bool IsValid_Framerate ( const FFrameRate& InFrameRate
)

 Verifies that this is a valid framerate with a non-zero denominator. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Valid Frame Rate")
  • Category="Utilities|Time Management"

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. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Is Multiple Of")
  • Category="Utilities|Time Management"

static FFrameNumber Multiply_FrameNumberInteger ( FFrameNumber A,
int32 B
)

 Multiply (FrameNumber A * B) TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber Int", CompactNodeTitle="", Keywords=" multiply", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator=";*=")
  • Category="Utilities|Time Management"

static FFrameTime Multiply_SecondsFrameRate ( float TimeInSeconds,
const FFrameRate& FrameRate
)

 Multiplies a value in seconds against a FrameRate to get a new FrameTime. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Seconds FrameRate", CompactNodeTitle="")
  • Category="Utilities|Time Management"

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. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Snap Frame Time")
  • Category="Utilities|Time Management"

static FFrameNumber Subtract_FrameNumberFrameNumber ( FFrameNumber A,
FFrameNumber B
)

 Subtraction (FrameNumber A - FrameNumber B) TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber - FrameNumber", CompactNodeTitle="-", Keywords="- subtract minus", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator="-;-=")
  • Category="Utilities|Time Management"

static FFrameNumber Subtract_FrameNumberInteger ( FFrameNumber A,
int32 B
)

 Subtraction (FrameNumber A - int B) TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="FrameNumber - Int", CompactNodeTitle="-", Keywords="- subtract minus", ScriptMethod, ScriptMethodSelfReturn, ScriptOperator="-;-=")
  • Category="Utilities|Time Management"

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

 Converts the specified time from one framerate to another framerate. TimeManagementBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Transform Frame Time")
  • Category="Utilities|Time Management"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page