1. Epic GamesDeveloper
  3. ADaySequenceActor

ADaySequenceActor

API > API/Plugins > API/Plugins/DaySequence

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

Syntax

UCLASS (MinimalAPI, Blueprintable)  
class ADaySequenceActor :  
    public AInfo ,  
    public IMovieScenePlaybackClient ,  
    public IMovieSceneBindingOwnerInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

ADaySequenceActor ( const FObjectInitializer& Init
)

   DaySequenceActor.h  

Classes

Name Remarks
FOnDaySequenceUpdate This delegate is broadcast at a rate matching this actor's tick interval.
FOnDebugLevelChanged  
FOnPostInitializeDaySequences  
FOnRootSequenceChanged  
FOnSubSectionRemovedEvent Native event invoked when a subsection is removed from the Root Sequence.
FOnTimeOfDayPreviewChangedEvent Native event invoked when the TimeOfDayPreview property is changed.

Structs

Name Remarks
FUpdateRootSequenceState  

Enums

Public

Name Remarks
EUpdateRootSequenceMode  

Typedefs

Name Type Remarks Include Path
FOnOverrideInitialTimeOfDayChanged TMulticastDelegate_TwoParams< void, bool, float >   DaySequenceActor.h
FOnOverrideRunDayCycleChanged TMulticastDelegate_OneParam< void, bool >   DaySequenceActor.h
FSubSectionPreserveMap TMap< UMovieSceneSubSection *, bool > This delegate is broadcast after the Day Sequence Actor has initialized all of its own sequences to allow other sequence providers to initialize their own sequences. DaySequenceActor.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bForceDisableDayInterpCurve bool Used to early out from WarpEvaluationRange. DaySequenceActor.h  
Bias int32 User-defined bias to apply to sequences in DaySequenceCollection. DaySequenceActor.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Sequence"
  • DisplayName="Collection Bias"
  • Meta=(DisplayAfter="DaySequenceCollection")
BindingOverrides TObjectPtr< UMovieSceneBindingOverrides > Mapping of actors to override the sequence bindings with DaySequenceActor.h
  • Instanced
  • BlueprintReadOnly
  • Category="Sequence"
bReplicatePlayback uint8 If true, playback of this sequence on the server will be synchronized across other clients DaySequenceActor.h
  • EditAnywhere
  • DisplayName="Replicate Playback"
  • BlueprintReadWrite
  • BlueprintSetter=SetReplicatePlayback
  • Category=Replication
DayInterpCurve TObjectPtr< UCurveFloat > User-provided interpolation curve that maps day cycle times to desired cycle times (usually from 0-24 hours). DaySequenceActor.h
  • EditAnywhere
  • Replicated
  • BlueprintReadWrite
  • Category=RuntimeDayCycle
  • Meta=(EditCondition=bUseInterpCurve, DisplayAfter=bRunDayCycle)
DaySequenceCollection TObjectPtr< UDaySequenceCollectionAsset >   DaySequenceActor.h  
DaySequenceCollections TArray< TObjectPtr< UDaySequenceCollectionAsset > >   DaySequenceActor.h
  • EditAnywhere
  • Category="Sequence"
OnOverrideInitialTimeOfDayChanged FOnOverrideInitialTimeOfDayChanged   DaySequenceActor.h  
OnOverrideRunDayCycleChanged FOnOverrideRunDayCycleChanged   DaySequenceActor.h  
OnSubSectionRemovedEvent ADaySequenceActor::FOnSubSectionRemovedEvent   DaySequenceActor.h  
OnTimeOfDayPreviewChangedEvent ADaySequenceActor::FOnTimeOfDayPreviewChangedEvent   DaySequenceActor.h  
ShowDebug_GeneralCategory const FName   DaySequenceActor.h  
ShowDebug_SubSequenceCategory const FName   DaySequenceActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BindToConditionCallbacks ( UObject* LifetimeObject,
const FDaySequenceConditionSet::FConditionValueMap& InConditions,
const TFunction< void(void)>& InFunction
)

 Called to register InFunction as a callback for instances matching InConditions with a lifetime equivalent to LifetimeObject. DaySequenceActor.h  

void ConditionalSetTimeOfDayPreview ( float InHours
)

 Set the TimeOfDayPreview if it is currently different from the specified time. DaySequenceActor.h  

bool ContainsDaySequence ( const UDaySequence* InDaySequence
)

 Returns true if the given InDaySequence is referenced by any entry in the DaySequences map property. DaySequenceActor.h
  • BlueprintCallable
  • Category="Sequence"

bool EvaluateSequenceConditions ( bool bInitialMuteState,
const FDaySequenceConditionSet::FConditionValueMap& InConditions
)

 Called to evaluate a particular set of conditions. DaySequenceActor.h  
Get the current apparent time of day in hours. DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

UDaySequenceCameraModifierManager * GetCameraModifierManager()

   DaySequenceActor.h  

float GetDayLength()

 Get the length of each day in hours. DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

int32 GetDebugLevel()

   DaySequenceActor.h  

float GetInitialTimeOfDay()

 Get the initial time of day in hours. DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

ADaySequenceActor::FOnDaySequenceUpdate TBaseMulticastDelegate_NoParams GetOnDaySequenceUpdate()

   DaySequenceActor.h  

ADaySequenceActor::FOnDebugLevelChanged TBaseMulticastDelegate_OneParam GetOnDebugLevelChanged()

   DaySequenceActor.h  

ADaySequenceActor::FOnPostInitializeDaySequences TBaseMulticastDelegate_OneParam GetOnPostInitializeDaySequences()

   DaySequenceActor.h  

ADaySequenceActor::FOnRootSequenceChanged TBaseMulticastDelegate_NoParams GetOnPostRootSequenceChanged()

   DaySequenceActor.h  

FOnRootSequenceChanged & GetOnPreRootSequenceChanged()

   DaySequenceActor.h  
TODO [nickolas.drake] Write a class that wraps TrackConditionMap (TrackConditionMapProxy?) and make EvaluateSequenceConditions and BindToConditionCallbacks member functions. DaySequenceActor.h  

bool GetOverrideInitialTimeOfDay()

   DaySequenceActor.h  

bool GetOverrideRunDayCycle()

   DaySequenceActor.h  

float GetPlayRate()

 Gets the play rate of the day cycle at runtime. Always 1 in editor worlds. DaySequenceActor.h
  • BlueprintCallable
  • Category=RuntimeDayCycle

UDaySequence * GetRootSequence()

   DaySequenceActor.h  

bool GetRunDayCycle()

 Get bRunDayCycle, a bool that determines whether or not the day cycle can be played back. DaySequenceActor.h  

IDaySequencePlayer * GetSequencePlayer()

 Access this actor's sequence player, or None if it is invalid (not yet initialized or already destroyed) DaySequenceActor.h  

EDaySequenceStaticTimeMode GetStaticTimeMode()

   DaySequenceActor.h  

float GetStaticTimeOfDay()

 Get this day sequence actor's static (fixed) time-of-day, or numeric_limits::lowest() if it doesn't have one DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

float GetTimeOfDay()

 Get the current time of day in hours. DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

float GetTimeOfDayPreview()

   DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

float GetTimePerCycle()

 Get the duration of each day cycle in hours (assuming PlayRate is 1.0) DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

void HandleConditionReinstanced ( const FCoreUObjectDelegates::FReplacementObjectMap& OldToNewInstanceMap
)

   DaySequenceActor.h  

bool HasStaticTimeOfDay()

 Check whether this day sequence actor has a static (fixed) time-of-day DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

bool HasValidRootSequence()

   DaySequenceActor.h  

void InvalidateMuteStates()

   DaySequenceActor.h  

bool IsDebugCategoryRegistered ( const FName& Category
) const

   DaySequenceActor.h  

bool IsPaused()

   DaySequenceActor.h
  • BlueprintCallable
  • Category="Playback"

bool IsPlaying()

   DaySequenceActor.h
  • BlueprintCallable
  • Category="Playback"

void Multicast_SetTimePerCycle ( float InHours
)

 Set the duration of a day cycle in real time in hours and update the root sequence in game. DaySequenceActor.h
  • NetMulticast
  • Reliable

void Pause()

 Pause playback of the sequence. DaySequenceActor.h
  • BlueprintCallable
  • Category="Playback"

void Play()

 Resume playback of the sequence. DaySequenceActor.h
  • BlueprintCallable
  • Category="Playback"

void RegisterBindingResolveFunction ( FMovieSceneSequenceID SequenceID,
FGuid Guid,
TFunction< bool(TArray< UObject*, TInlineAllocator< 1 > >&)> InFunction
)

   DaySequenceActor.h  

void RegisterDebugCategory ( const FName& Category,
UE::DaySequence::FDebugCategoryDrawFunction DrawFunction
)

   DaySequenceActor.h  

void RegisterDebugEntry ( const TWeakPtr< UE::DaySequence::FDaySequenceDebugEntry >& DebugEntry,
const FName& Category
)

   DaySequenceActor.h  

void RegisterStaticTimeContributor ( const UE::DaySequence::FStaticTimeContributor& NewContributor
) const

   DaySequenceActor.h  

bool RootSequenceHasValidSections()

   DaySequenceActor.h  

void SetDayLength ( float InHours
)

 Set the duration of the day in game time in hours. DaySequenceActor.h  

void SetInitialTimeOfDay ( float InHours
)

 Set the initial time of day in game time in hours. DaySequenceActor.h  

void SetOverrideInitialTimeOfDay ( bool bNewOverrideInitialTimeOfDay
)

   DaySequenceActor.h  

void SetOverrideInitialTimeOfDay ( bool bNewOverrideInitialTimeOfDay,
float OverrideInitialTimeOfDay
)

 Variant of SetOverrideInitialTimeOfDay that will update TimeOfDayPreview if necessary. DaySequenceActor.h  

void SetOverrideRunDayCycle ( bool bNewOverrideRunDayCycle
)

   DaySequenceActor.h  

void SetPlayRate ( float NewRate
)

 Sets the play rate of the day cycle at runtime. DaySequenceActor.h
  • BlueprintCallable
  • NetMulticast
  • Reliable
  • Category=RuntimeDayCycle

void SetReplicatePlayback ( bool ReplicatePlayback
)

 Set whether or not to replicate playback for this actor DaySequenceActor.h
  • BlueprintSetter

void SetRunDayCycle ( bool bNewRunDayCycle
)

 Set bRunDayCycle, a bool that determines whether or not the day cycle can be played back. DaySequenceActor.h  

void SetStaticTimeMode ( EDaySequenceStaticTimeMode Mode
)

   DaySequenceActor.h  

bool SetTimeOfDay ( float InHours
)

 Set the current time of day in hours (server only). DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

void SetTimeOfDayPreview ( float InHours
)

 Set the TimeOfDayPreview and broadcast the event. DaySequenceActor.h
  • BlueprintCallable
  • Category="TimeOfDay"

void SetTimePerCycle ( float InHours
)

 Set the duration of a day cycle in real time in hours. DaySequenceActor.h  

void UnregisterBindingResolveFunction ( FMovieSceneSequenceID SequenceID,
FGuid Guid
)

   DaySequenceActor.h  

void UnregisterDebugEntry ( const TWeakPtr< UE::DaySequence::FDaySequenceDebugEntry >& DebugEntry,
const FName& Category
)

   DaySequenceActor.h  

void UnregisterStaticTimeContributor ( const UObject* InUserObject
) const

   DaySequenceActor.h  

virtual void UpdateRootSequence ( EUpdateRootSequenceMode Mode
)

   DaySequenceActor.h  

void UpdateRootSequenceOnTick ( EUpdateRootSequenceMode Mode
)

   DaySequenceActor.h  

void UpdateSubSectionTimeScale ( UMovieSceneSubSection* InSubSection
) const

 Normalizes a subsection's timescale and frame range to the root sequence such that the subsection's sequence represents a full day cycle. DaySequenceActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual bool GetReferencedContentObjects ( TArray< UObject* >& Objects
) const

   DaySequenceActor.h  

Protected

Name Remarks Include Path Unreal Specifiers

float GetBaseDuration()

 Returns the duration in hours of the player if its rate is 1. DaySequenceActor.h  

float GetBasePlayRate()

 Returns the rate required for the player to have a duration of TimePerCycle. DaySequenceActor.h  
Compute PlaybackSettings from day cycle properties DaySequenceActor.h  

UDaySequencePlayer * GetSequencePlayerInternal()

 Internal getter that validates the player. DaySequenceActor.h  

UMovieSceneSubSection * InitializeDaySequence ( const FDaySequenceCollectionEntry& SequenceAsset
)

   DaySequenceActor.h  

virtual void InitializeDaySequences ()

 Called by InitializeRootSequence. DaySequenceActor.h  

void InitializePlayer()

 Initialize SequencePlayer with transient root sequence DaySequenceActor.h  

void InitializeRootSequence()

   DaySequenceActor.h  

bool MarkDaySequences ( FSubSectionPreserveMap* SectionsToPreserve
)

 Determines if subsection initialization is necessary or not by verifying all sections in SubSections exist in this map. DaySequenceActor.h  

void OnSequencePlayerUpdate ( const UDaySequencePlayer& Player,
FFrameTime CurrentTime,
FFrameTime PreviousTime
)

   DaySequenceActor.h  

void OnShowDebugInfo ( AHUD* HUD,
UCanvas* Canvas,
const FDebugDisplayInfo& DisplayInfo,
float& YL,
float& YPos
)

   DaySequenceActor.h  

virtual void SequencePlayerUpdated ( float CurrentTime,
float PreviousTime
)

   DaySequenceActor.h  

void SetRootSequencePlaybackRange()

   DaySequenceActor.h  

void StartDaySequenceUpdateTimer()

 Starts a timer that will broadcast OnDaySequenceUpdate when the sequence player is paused. DaySequenceActor.h  

void StopDaySequenceUpdateTimer()

 Stops the timer that was started by DaySequenceUpdateTimerHandle. DaySequenceActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   DaySequenceActor.h  

virtual bool CanChangeIsSpatiallyLoadedFlag()

   DaySequenceActor.h  

virtual void Destroyed()

   DaySequenceActor.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   DaySequenceActor.h  

virtual void OnConstruction ( const FTransform& Transform
)

   DaySequenceActor.h  

virtual void PostInitializeComponents()

   DaySequenceActor.h  

virtual void RewindForReplay()

   DaySequenceActor.h  

virtual bool ShouldTickIfViewportsOnly()

   DaySequenceActor.h  

virtual void Tick ( float DeltaTime
)

   DaySequenceActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   DaySequenceActor.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   DaySequenceActor.h  

virtual void PostLoad()

   DaySequenceActor.h  

Overridden from IMovieScenePlaybackClient

Name Remarks Include Path Unreal Specifiers

virtual UObject * GetInstanceData()

   DaySequenceActor.h  

virtual bool GetIsReplicatedPlayback()

   DaySequenceActor.h  

virtual bool RetrieveBindingOverrides ( const FGuid& InBindingId,
FMovieSceneSequenceID InSequenceID,
TArray< UObject*, TInlineAllocator< 1 > >& OutObjects
) const

   DaySequenceActor.h  

virtual void WarpEvaluationRange ( FMovieSceneEvaluationRange& InOutRange
) const

   DaySequenceActor.h  

Overridden from IMovieSceneBindingOwnerInterface

Name Remarks Include Path Unreal Specifiers

virtual TSharedPtr< FStructOnScope > GetObjectPickerProxy ( TSharedPtr< IPropertyHandle > PropertyHandle
)

   DaySequenceActor.h  

virtual UMovieSceneSequence * RetrieveOwnedSequence()

   DaySequenceActor.h  

virtual void UpdateObjectFromProxy ( FStructOnScope& Proxy,
IPropertyHandle& ObjectPropertyHandle
)

   DaySequenceActor.h  

Static

Name Remarks Include Path Unreal Specifiers

static void OnShowDebugInfoDrawFunction ( UCanvas* Canvas,
TArray< TSharedPtr< TMap< FString, FString > > >& Entries,
const FString& Category
)

 This will be called once per category and is passed the data for all entries associated with this category. DaySequenceActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page