1. Epic GamesDeveloper
  3. UProceduralDaySequenceBuilder

UProceduralDaySequenceBuilder

A utility class for creating procedural Day Sequences.

API > API/Plugins > API/Plugins/DaySequence

A utility class for creating procedural Day Sequences. Before adding any keys, SetActiveBoundObject should be called and provided a Day Sequence Actor or a component owned by a Day Sequence Actor. All time values are currently normalized to the range [0, 1], inclusive on both ends. A time of 1 is handled as a special case and maps to the final frame. This class assumes the target Day Sequence Actor will stay alive and that users will keep the generated sequence alive, it manages no lifetimes.

Consider using FProceduralDaySequence instead of using this class directly.

   
Name UProceduralDaySequenceBuilder
Type class
Header File /Engine/Plugins/Experimental/DaySequence/Source/DaySequence/Public/ProceduralDaySequenceBuilder.h
Include Path #include "ProceduralDaySequenceBuilder.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UProceduralDaySequenceBuilder : public UObject

Inheritance Hierarchy

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveBinding FGuid   ProceduralDaySequenceBuilder.h  
ActiveBoundObject TObjectPtr< UObject >   ProceduralDaySequenceBuilder.h  
ProceduralDaySequence TObjectPtr< UDaySequence > This is returned immediately upon creation in InitializeSequence. ProceduralDaySequenceBuilder.h  
TargetActor TObjectPtr< ADaySequenceActor >   ProceduralDaySequenceBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddBoolKey ( FName PropertyName,
const TPair< float, bool >& KeyValue
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddBoolKey ( FName PropertyName,
float Key,
bool Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddBoolKeys ( FName PropertyName,
const TArray< TPair< float, bool > >& KeysAndValues
)

   ProceduralDaySequenceBuilder.h  

void AddBoolOverride ( FName PropertyName,
bool Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddColorKeys ( FName PropertyName,
const TArray< TPair< float, FLinearColor > >& KeysAndValues,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddColorMaterialParameterKeys ( FName ParameterName,
int32 MaterialIndex,
const TArray< TPair< float, FLinearColor > >& KeysAndValues
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddColorMaterialParameterOverride ( FName ParameterName,
int32 MaterialIndex,
FLinearColor Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddColorOverride ( FName PropertyName,
FLinearColor Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddMaterialOverride ( int32 MaterialIndex,
UMaterialInterface* Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddRotationKey ( float Key,
const FRotator& Value,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddScalarKey ( FName PropertyName,
const TPair< float, double >& KeyValue,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddScalarKey ( FName PropertyName,
float Key,
double Value,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddScalarKeys ( FName PropertyName,
const TArray< TPair< float, double > >& KeysAndValues,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h  

void AddScalarMaterialParameterKeys ( FName ParameterName,
int32 MaterialIndex,
const TArray< TPair< float, float > >& KeysAndValues
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddScalarMaterialParameterOverride ( FName ParameterName,
int32 MaterialIndex,
float Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddScalarOverride ( FName PropertyName,
double Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddScaleKey ( float Key,
const FVector& Value,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddTransformKey ( float Key,
const FTransform& Value,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddTransformOverride ( const FTransform& Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddTranslationKey ( float Key,
const FVector& Value,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddVectorKey ( FName PropertyName,
float Key,
FVector Value,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddVectorKey ( FName PropertyName,
const TPair< float, FVector >& KeyValue,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddVectorKeys ( FName PropertyName,
const TArray< TPair< float, FVector > >& KeysAndValues,
ERichCurveInterpMode InterpMode
)

   ProceduralDaySequenceBuilder.h  

void AddVectorOverride ( FName PropertyName,
FVector Value
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddVisibilityKeys ( const TArray< TPair< float, bool > >& KeysAndValues
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void AddVisibilityOverride ( bool bValue
)

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void ClearKeys()

   ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

UDaySequence * Initialize ( ADaySequenceActor* InActor,
UDaySequence* InitialSequence,
bool bClearInitialSequence
)

 Initialize the procedural sequence and set the TargetActor for this builder. ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

bool IsInitialized()

 Returns true Initialize has been called with a valid actor. ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

void SetActiveBoundObject ( UObject* InObject
)

 Prepare the builder to begin adding keys animating properties on InObject. ProceduralDaySequenceBuilder.h
  • BlueprintCallable
  • Category="Day Sequence"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page