MovieSceneSequencePlaybackSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UObject/ObjectMacros.h"
#include "MovieSceneSequenceTickInterval.h"
#include "MovieSceneSequencePlaybackSettings.generated.h"
 
 
USTRUCT(BlueprintType)
struct FMovieSceneSequenceLoopCount
{
    FMovieSceneSequenceLoopCount()
        : Value(0)
    {}
 
    GENERATED_BODY()
 
    
    bool SerializeFromMismatchedTag(const FPropertyTag& Tag, FStructuredArchive::FSlot Slot );
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback", meta=(UIMin=1, DisplayName="Loop"))
    int32 Value;
};
template<> struct TStructOpsTypeTraits<FMovieSceneSequenceLoopCount> : public TStructOpsTypeTraitsBase2<FMovieSceneSequenceLoopCount>
{
    enum { WithStructuredSerializeFromMismatchedTag = true };
};
 
/* Whether to override track sections' default completion mode when a sequence finishes.*/
UENUM(BlueprintType)
enum class EMovieSceneCompletionModeOverride : uint8
{
    None UMETA(DisplayName = "None"),
    ForceKeepState UMETA(DisplayName="Force Keep State"),
    ForceRestoreState UMETA(DisplayName="Force Restore State")
};
 
 
USTRUCT(BlueprintType)
struct FMovieSceneSequencePlaybackSettings
{
    FMovieSceneSequencePlaybackSettings()
        : bAutoPlay(false)
        , PlayRate(1.f)
        , StartTime(0.f)
        , bRandomStartTime(false)
#if WITH_EDITORONLY_DATA
        , bRestoreState_DEPRECATED(false)
#endif
        , bDisableMovementInput(false)
        , bDisableLookAtInput(false)
        , bHidePlayer(false)
        , bHideHud(false)
        , bDisableCameraCuts(false)
        , bPauseAtEnd(false)
        , bInheritTickIntervalFromOwner(true)
        , bDynamicWeighting(false)
    { }
 
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Playback")
    uint32 bAutoPlay : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback", meta=(UIMin=1, DisplayName="Loop"))
    FMovieSceneSequenceLoopCount LoopCount;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback", meta=(Units=s, EditCondition="!bInheritTickIntervalFromOwner"))
    FMovieSceneSequenceTickInterval TickInterval;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback", meta=(Units=Multiplier))
    float PlayRate;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback", DisplayName="Start Offset", meta=(Units=s, EditCondition="!bRandomStartTime"))
    float StartTime;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback")
    uint32 bRandomStartTime : 1;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(meta = (DeprecatedProperty, DeprecationMessage = "Use Settings.FinishCompletionStateOverride instead"))
    uint32 bRestoreState_DEPRECATED : 1;
#endif
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Cinematic")
    uint32 bDisableMovementInput : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Cinematic")
    uint32 bDisableLookAtInput : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Cinematic")
    uint32 bHidePlayer : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Cinematic")
    uint32 bHideHud : 1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Cinematic")
    uint32 bDisableCameraCuts : 1;
    
    /* If set to something other than none, when a sequence ends, the completion mode of any track sections still active will be overridden
    * by the chosen value, either keep state or restore state. Otherwise, completion mode will be determined by each track section.
    * Note that any track sections that finish before the end of a sequence will have their completion mode determined by the section settings rather than this override.
    */
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Cinematic")
    EMovieSceneCompletionModeOverride FinishCompletionStateOverride = EMovieSceneCompletionModeOverride::None;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Playback")
    uint32 bPauseAtEnd : 1;
 
    UPROPERTY(EditAnywhere, Category="Playback", meta=(InlineEditConditionToggle))
    uint32 bInheritTickIntervalFromOwner : 1;
 
    UPROPERTY(EditAnywhere, Category="Playback")
    uint32 bDynamicWeighting : 1;
 
 
    MOVIESCENE_API bool SerializeFromMismatchedTag(const FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
};
 
template<> struct TStructOpsTypeTraits<FMovieSceneSequencePlaybackSettings> : public TStructOpsTypeTraitsBase2<FMovieSceneSequencePlaybackSettings>
{
    enum { WithStructuredSerializeFromMismatchedTag = true };
};