Show / Hide Table of Contents

Class TimeManagementBlueprintLibrary

Time Management Blueprint Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
TimeManagementBlueprintLibrary
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.TimeManagement
Assembly: UE4DotNet.dll
Syntax
public class TimeManagementBlueprintLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static TimeManagementBlueprintLibrary DefaultObject { get; }
Property Value
Type Description
TimeManagementBlueprintLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

Add_FrameNumberFrameNumber(FrameNumber, FrameNumber)

Addition (FrameNumber A + FrameNumber B)

Declaration
public static FrameNumber Add_FrameNumberFrameNumber(FrameNumber A, FrameNumber B)
Parameters
Type Name Description
FrameNumber A
FrameNumber B
Returns
Type Description
FrameNumber
| Improve this Doc View Source

Add_FrameNumberInteger(FrameNumber, Int32)

Addition (FrameNumber A + int B)

Declaration
public static FrameNumber Add_FrameNumberInteger(FrameNumber A, int B)
Parameters
Type Name Description
FrameNumber A
System.Int32 B
Returns
Type Description
FrameNumber
| Improve this Doc View Source

Conv_FrameNumberToInteger(FrameNumber)

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

Declaration
public static int Conv_FrameNumberToInteger(FrameNumber InFrameNumber)
Parameters
Type Name Description
FrameNumber InFrameNumber
Returns
Type Description
System.Int32
| Improve this Doc View Source

Conv_FrameRateToSeconds(FrameRate)

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

Declaration
public static float Conv_FrameRateToSeconds(FrameRate InFrameRate)
Parameters
Type Name Description
FrameRate InFrameRate
Returns
Type Description
System.Single
| Improve this Doc View Source

Conv_QualifiedFrameTimeToSeconds(QualifiedFrameTime)

Converts an QualifiedFrameTime to seconds.

Declaration
public static float Conv_QualifiedFrameTimeToSeconds(QualifiedFrameTime InFrameTime)
Parameters
Type Name Description
QualifiedFrameTime InFrameTime
Returns
Type Description
System.Single
| Improve this Doc View Source

Conv_TimecodeToString(Timecode, Boolean)

Converts an Timecode to a string (hh:mm:ss:ff). If bForceSignDisplay then the number sign will always be prepended instead of just when expressing a negative time.

Declaration
public static string Conv_TimecodeToString(Timecode InTimecode, bool bForceSignDisplay)
Parameters
Type Name Description
Timecode InTimecode
System.Boolean bForceSignDisplay
Returns
Type Description
System.String
| Improve this Doc View Source

Divide_FrameNumberInteger(FrameNumber, Int32)

Divide (FrameNumber A / B)

Declaration
public static FrameNumber Divide_FrameNumberInteger(FrameNumber A, int B)
Parameters
Type Name Description
FrameNumber A
System.Int32 B
Returns
Type Description
FrameNumber
| Improve this Doc View Source

GetTimecode()

Get the Timecode from the TimeManagement's TimecodeProvider.

Declaration
public static Timecode GetTimecode()
Returns
Type Description
Timecode
Remarks

@return true if the Timecode is valid. The timecode is valid when the TimecodeProfier is Synchronized.

| Improve this Doc View Source

IsValid_Framerate(FrameRate)

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

Declaration
public static bool IsValid_Framerate(FrameRate InFrameRate)
Parameters
Type Name Description
FrameRate InFrameRate
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsValid_MultipleOf(FrameRate, FrameRate)

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

Declaration
public static bool IsValid_MultipleOf(FrameRate InFrameRate, FrameRate OtherFramerate)
Parameters
Type Name Description
FrameRate InFrameRate
FrameRate OtherFramerate
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Multiply_FrameNumberInteger(FrameNumber, Int32)

Multiply (FrameNumber A * B)

Declaration
public static FrameNumber Multiply_FrameNumberInteger(FrameNumber A, int B)
Parameters
Type Name Description
FrameNumber A
System.Int32 B
Returns
Type Description
FrameNumber
| Improve this Doc View Source

Multiply_SecondsFrameRate(Single, FrameRate)

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

Declaration
public static FrameTime Multiply_SecondsFrameRate(float TimeInSeconds, FrameRate FrameRate)
Parameters
Type Name Description
System.Single TimeInSeconds
FrameRate FrameRate
Returns
Type Description
FrameTime
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static TimeManagementBlueprintLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
TimeManagementBlueprintLibrary
| Improve this Doc View Source

SnapFrameTimeToRate(FrameTime, FrameRate, FrameRate)

Snaps the given SourceTime to the nearest frame in the specified Destination Framerate. Useful for determining the nearest frame for another resolution. Returns the frame time in the destination frame rate.

Declaration
public static FrameTime SnapFrameTimeToRate(FrameTime SourceTime, FrameRate SourceRate, FrameRate SnapToRate)
Parameters
Type Name Description
FrameTime SourceTime
FrameRate SourceRate
FrameRate SnapToRate
Returns
Type Description
FrameTime
| Improve this Doc View Source

Subtract_FrameNumberFrameNumber(FrameNumber, FrameNumber)

Subtraction (FrameNumber A - FrameNumber B)

Declaration
public static FrameNumber Subtract_FrameNumberFrameNumber(FrameNumber A, FrameNumber B)
Parameters
Type Name Description
FrameNumber A
FrameNumber B
Returns
Type Description
FrameNumber
| Improve this Doc View Source

Subtract_FrameNumberInteger(FrameNumber, Int32)

Subtraction (FrameNumber A - int B)

Declaration
public static FrameNumber Subtract_FrameNumberInteger(FrameNumber A, int B)
Parameters
Type Name Description
FrameNumber A
System.Int32 B
Returns
Type Description
FrameNumber
| Improve this Doc View Source

TransformTime(FrameTime, FrameRate, FrameRate)

Converts the specified time from one framerate to another framerate. This is useful for converting between tick resolution and display rate.

Declaration
public static FrameTime TransformTime(FrameTime SourceTime, FrameRate SourceRate, FrameRate DestinationRate)
Parameters
Type Name Description
FrameTime SourceTime
FrameRate SourceRate
FrameRate DestinationRate
Returns
Type Description
FrameTime

Operators

| Improve this Doc View Source

Implicit(IntPtr to TimeManagementBlueprintLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator TimeManagementBlueprintLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
TimeManagementBlueprintLibrary
  • Improve this Doc
  • View Source
Back to top Generated by DocFX