Navigation
API > API/Plugins > API/Plugins/DaySequence
| Name | UDaySequenceModifierComponent |
| Type | class |
| Header File | /Engine/Plugins/Experimental/DaySequence/Source/DaySequence/Public/DaySequenceModifierComponent.h |
| Include Path | #include "DaySequenceModifierComponent.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Blueprintable, Config=Game,
HideCategories=(Physics, Navigation, Collision, HLOD, Rendering, Cooking, Mobile, RayTracing, AssetUserData),
Meta=(BlueprintSpawnableComponent))
class UDaySequenceModifierComponent :
public USceneComponent ,
public FDaySequenceModifierComponentTickableBase
Inheritance Hierarchy
- FTickableObjectBase → FTickableGameObject → FDaySequenceModifierComponentTickableBase → UDaySequenceModifierComponent
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → USceneComponent → UDaySequenceModifierComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDaySequenceModifierComponent
(
const FObjectInitializer& Init |
DaySequenceModifierComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCachedExternalShapesInvalid | bool | DaySequenceModifierComponent.h | ||
| CachedExternalShapes | TArray< TWeakObjectPtr< UShapeComponent > > | DaySequenceModifierComponent.h | ||
| DebugEntry | TSharedPtr< UE::DaySequence::FDaySequenceDebugEntry > | DaySequenceModifierComponent.h | ||
| DebugLevel | int32 | Determines whether or not the modifier will show debug info | DaySequenceModifierComponent.h | |
| InternalBlendWeight | float | The blend weight computed by the modifier. | DaySequenceModifierComponent.h | |
| OnInvalidateMuteStates | UE::DaySequence::FOnInvalidateMuteStates | DaySequenceModifierComponent.h | ||
| ShowDebug_ModifierCategory | const FName | DaySequenceModifierComponent.h | ||
| SubSectionDebugEntries | TArray< TSharedPtr< UE::DaySequence::FDaySequenceDebugEntry > > | DaySequenceModifierComponent.h | ||
| SubSections | TArray< TWeakObjectPtr< UMovieSceneSubSection > > | DaySequenceModifierComponent.h | ||
| TimedBlendingLastUpdated | float | Used by UpdateInternalBlendWeight to compute time delta between InternalBlendWeight updates. | DaySequenceModifierComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddVolumeShapeComponent
(
const FComponentReference& InShapeReference |
DaySequenceModifierComponent.h | ||
void BindToDaySequenceActor
(
ADaySequenceActor* DaySequenceActor |
Bind this component to the specified day sequence actor. | DaySequenceModifierComponent.h |
|
void DisableComponent() |
Disable this component. Will remove the sub-sequence from the root sequence if it's set up. | DaySequenceModifierComponent.h |
|
void EmptyVolumeShapeComponents() |
DaySequenceModifierComponent.h | ||
void EnableComponent() |
Enable this component. | DaySequenceModifierComponent.h |
|
int32 GetBias() |
DaySequenceModifierComponent.h | ||
EDaySequenceModifierUserBlendPolicy GetBlendPolicy() |
DaySequenceModifierComponent.h | ||
float GetBlendWeight() |
Get the current blend weight. | DaySequenceModifierComponent.h |
|
EDayNightCycleMode GetDayNightCycle() |
DaySequenceModifierComponent.h | ||
float GetDayNightCycleTime() |
DaySequenceModifierComponent.h | ||
EDaySequenceModifierMode GetMode() |
DaySequenceModifierComponent.h | ||
UDaySequence * GetTransientSequence() |
DaySequenceModifierComponent.h | ||
float GetUserBlendWeight() |
DaySequenceModifierComponent.h | ||
UDaySequence * GetUserDaySequence() |
DaySequenceModifierComponent.h | ||
void SetBias
(
int32 NewBias |
DaySequenceModifierComponent.h | ||
void SetBlendPolicy
(
EDaySequenceModifierUserBlendPolicy NewPolicy |
DaySequenceModifierComponent.h | ||
void SetBlendTarget
(
APlayerController* InActor |
Sets the blend target to use when in Volume mode. | DaySequenceModifierComponent.h |
|
void SetDayNightCycle
(
EDayNightCycleMode NewMode |
Sets the Day Night Cycle mode. This will reenable the component. | DaySequenceModifierComponent.h | |
void SetDayNightCycleTime
(
float Time |
DaySequenceModifierComponent.h | ||
void SetMode
(
EDaySequenceModifierMode NewMode |
DaySequenceModifierComponent.h | ||
void SetTransientSequence
(
UDaySequence* InDaySequence |
Sets a user specified transient sequence. | DaySequenceModifierComponent.h | |
void SetUserBlendWeight
(
float Weight |
Sets a custom blend weight for volume based blends. Final weight depends on BlendPolicy. | DaySequenceModifierComponent.h | |
void SetUserDaySequence
(
UDaySequence* InDaySequence |
Sets the user day sequence. This must be a user created asset. | DaySequenceModifierComponent.h | |
void UnbindFromDaySequenceActor () |
Unbind this component from its day sequence actor if valid. | DaySequenceModifierComponent.h |
|
Overridden from UActorComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginPlay() |
DaySequenceModifierComponent.h | ||
virtual void EndPlay
(
EEndPlayReason::Type Reason |
DaySequenceModifierComponent.h | ||
virtual void OnRegister() |
DaySequenceModifierComponent.h | ||
virtual void OnUnregister() |
DaySequenceModifierComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
DaySequenceModifierComponent.h | ||
virtual void PostLoad() |
DaySequenceModifierComponent.h |
Overridden from FDaySequenceModifierComponentTickableBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void UpdateEditorPreview
(
float DeltaTime |
DaySequenceModifierComponent.h |
Overridden from FTickableGameObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsTickableInEditor() |
DaySequenceModifierComponent.h | ||
virtual bool IsTickableWhenPaused() |
DaySequenceModifierComponent.h |
Overridden from FTickableObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TStatId GetStatId() |
DaySequenceModifierComponent.h | ||
virtual ETickableTickType GetTickableTickType() |
DaySequenceModifierComponent.h | ||
virtual bool IsTickable() |
DaySequenceModifierComponent.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanBeEnabled() |
DaySequenceModifierComponent.h | ||
void DisableModifier() |
Disable the modifier by disabling its subsection. | DaySequenceModifierComponent.h | |
void EnableModifier() |
Enable the modifier by enabling its subsection (creating it if necessary) in the Root Sequence. | DaySequenceModifierComponent.h | |
TArray< UShapeComponent * > GetVolumeShapeComponents() |
DaySequenceModifierComponent.h | ||
void InvalidateMuteStates() |
Called to properly update the mute states of all managed subsections. | DaySequenceModifierComponent.h | |
void SetInitialTimeOfDay() |
DaySequenceModifierComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void SetIsSimulating
(
bool bInIsSimulating |
DaySequenceModifierComponent.h | ||
static void SetVolumePreviewLocation
(
const FVector& Location |
DaySequenceModifierComponent.h |