Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → AActor → AInfo → ADaySequenceActor
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 |
|
| BindingOverrides | TObjectPtr< UMovieSceneBindingOverrides > | Mapping of actors to override the sequence bindings with | DaySequenceActor.h |
|
| bReplicatePlayback | uint8 | If true, playback of this sequence on the server will be synchronized across other clients | DaySequenceActor.h |
|
| DayInterpCurve | TObjectPtr< UCurveFloat > | User-provided interpolation curve that maps day cycle times to desired cycle times (usually from 0-24 hours). | DaySequenceActor.h |
|
| DaySequenceCollection | TObjectPtr< UDaySequenceCollectionAsset > | DaySequenceActor.h | ||
| DaySequenceCollections | TArray< TObjectPtr< UDaySequenceCollectionAsset > > | DaySequenceActor.h |
|
|
| 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 |
|---|---|---|---|
| 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 |
|
bool EvaluateSequenceConditions
(
bool bInitialMuteState, |
Called to evaluate a particular set of conditions. | DaySequenceActor.h | |
float GetApparentTimeOfDay () |
Get the current apparent time of day in hours. | DaySequenceActor.h |
|
UDaySequenceCameraModifierManager * GetCameraModifierManager() |
DaySequenceActor.h | ||
float GetDayLength() |
Get the length of each day in hours. | DaySequenceActor.h |
|
int32 GetDebugLevel() |
DaySequenceActor.h | ||
float GetInitialTimeOfDay() |
Get the initial time of day in hours. | DaySequenceActor.h |
|
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 | ||
TObjectPtr< UDaySequenceConditionTag > GetOrInstantiateConditionTag
(
const TSubclassOf< UDaySequenceConditionTag >& ConditionClass |
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 |
|
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 |
DaySequenceActor.h |
|
float GetTimeOfDay() |
Get the current time of day in hours. | DaySequenceActor.h |
|
float GetTimeOfDayPreview() |
DaySequenceActor.h |
|
|
float GetTimePerCycle() |
Get the duration of each day cycle in hours (assuming PlayRate is 1.0) | DaySequenceActor.h |
|
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 |
|
bool HasValidRootSequence() |
DaySequenceActor.h | ||
void InvalidateMuteStates() |
DaySequenceActor.h | ||
bool IsDebugCategoryRegistered
(
const FName& Category |
DaySequenceActor.h | ||
bool IsPaused() |
DaySequenceActor.h |
|
|
bool IsPlaying() |
DaySequenceActor.h |
|
|
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 |
|
void Pause() |
Pause playback of the sequence. | DaySequenceActor.h |
|
void Play() |
Resume playback of the sequence. | DaySequenceActor.h |
|
void RegisterBindingResolveFunction
(
FMovieSceneSequenceID SequenceID, |
DaySequenceActor.h | ||
void RegisterDebugCategory
(
const FName& Category, |
DaySequenceActor.h | ||
void RegisterDebugEntry
(
const TWeakPtr< UE::DaySequence::FDaySequenceDebugEntry >& DebugEntry, |
DaySequenceActor.h | ||
void RegisterStaticTimeContributor
(
const UE::DaySequence::FStaticTimeContributor& NewContributor |
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, |
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 |
|
void SetReplicatePlayback
(
bool ReplicatePlayback |
Set whether or not to replicate playback for this actor | DaySequenceActor.h |
|
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 |
|
void SetTimeOfDayPreview
(
float InHours |
Set the TimeOfDayPreview and broadcast the event. | DaySequenceActor.h |
|
void SetTimePerCycle
(
float InHours |
Set the duration of a day cycle in real time in hours. | DaySequenceActor.h | |
void UnregisterBindingResolveFunction
(
FMovieSceneSequenceID SequenceID, |
DaySequenceActor.h | ||
void UnregisterDebugEntry
(
const TWeakPtr< UE::DaySequence::FDaySequenceDebugEntry >& DebugEntry, |
DaySequenceActor.h | ||
void UnregisterStaticTimeContributor
(
const UObject* InUserObject |
DaySequenceActor.h | ||
virtual void UpdateRootSequence
(
EUpdateRootSequenceMode Mode |
DaySequenceActor.h | ||
void UpdateRootSequenceOnTick
(
EUpdateRootSequenceMode Mode |
DaySequenceActor.h | ||
void UpdateSubSectionTimeScale
(
UMovieSceneSubSection* InSubSection |
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 |
|---|---|---|---|
| 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 | |
FMovieSceneSequencePlaybackSettings GetPlaybackSettings
(
const UDaySequence* Sequence |
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, |
DaySequenceActor.h | ||
void OnShowDebugInfo
(
AHUD* HUD, |
DaySequenceActor.h | ||
virtual void SequencePlayerUpdated
(
float CurrentTime, |
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, |
DaySequenceActor.h | ||
virtual void WarpEvaluationRange
(
FMovieSceneEvaluationRange& InOutRange |
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, |
DaySequenceActor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void OnShowDebugInfoDrawFunction
(
UCanvas* Canvas, |
This will be called once per category and is passed the data for all entries associated with this category. | DaySequenceActor.h |