Navigation
API > API/Runtime > API/Runtime/MovieScene
A structure that stores playback state for an entire sequence hierarchy.
| Name | FSharedPlaybackState |
| Type | struct |
| Header File | /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneSharedPlaybackState.h |
| Include Path | #include "EntitySystem/MovieSceneSharedPlaybackState.h" |
Syntax
struct FSharedPlaybackState : public TSharedFromThis< FSharedPlaybackState >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FSharedPlaybackState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSharedPlaybackState
(
UMovieSceneSequence& InRootSequence, |
EntitySystem/MovieSceneSharedPlaybackState.h | ||
FSharedPlaybackState
(
UMovieSceneEntitySystemLinker* InLinker |
EntitySystem/MovieSceneSharedPlaybackState.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FSharedPlaybackState() |
EntitySystem/MovieSceneSharedPlaybackState.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDebugBreakOnDestroy | bool | EntitySystem/MovieSceneSharedPlaybackState.h | ||
| Capabilities | FPlaybackCapabilities | Playback capabilities for the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
| CompiledDataManager | TObjectPtr< UMovieSceneCompiledDataManager > | The compiled data manager that contains the data for the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
| PreAnimatedState | FMovieSceneInstancePreAnimatedState | Pre-animated state utility for the sequence hierarchy | EntitySystem/MovieSceneSharedPlaybackState.h | |
| RootCompiledDataID | FMovieSceneCompiledDataID | The compiled data ID for the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
| RootInstanceHandle | FRootInstanceHandle | The handle of the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
| WeakLinker | TWeakObjectPtr< UMovieSceneEntitySystemLinker > | The linker evaluating this root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
| WeakPlaybackContext | TWeakObjectPtr< UObject > | The playback context | EntitySystem/MovieSceneSharedPlaybackState.h | |
| WeakRootSequence | TWeakObjectPtr< UMovieSceneSequence > | The root sequence | EntitySystem/MovieSceneSharedPlaybackState.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
T & AddCapability
(
ArgTypes&&... InArgs |
Builds the specified capability for the root sequence. | EntitySystem/MovieSceneSharedPlaybackState.h | |
T & AddCapabilityRaw
(
T* InPointer |
Adds the specified capability on the root sequence as a raw pointer. | EntitySystem/MovieSceneSharedPlaybackState.h | |
T & AddCapabilityShared
(
TSharedRef< T > InSharedRef |
Adds the specified capability on the root sequence as a shared pointer. | EntitySystem/MovieSceneSharedPlaybackState.h | |
void ClearObjectCaches() |
Clears object caches for the entire sequence hierarchy. | EntitySystem/MovieSceneSharedPlaybackState.h | |
TArrayView< TWeakObjectPtr<> > FindBoundObjects
(
const FGuid& ObjectBindingID, |
Finds the bound objects for the given object binding in the given (sub)sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
T * FindCapability() |
Finds the specified capability on the root sequence. | EntitySystem/MovieSceneSharedPlaybackState.h | |
const FPlaybackCapabilities & GetCapabilities () |
Gets the capabilities container. | EntitySystem/MovieSceneSharedPlaybackState.h | |
| Gets the capabilities container. | EntitySystem/MovieSceneSharedPlaybackState.h | ||
TObjectPtr< UMovieSceneCompiledDataManager > GetCompiledDataManager() |
Gets the compiled data manager that contains the data for the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
const FMovieSceneSequenceHierarchy * GetHierarchy() |
Gets the hierarchy (if any) for this root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
UMovieSceneEntitySystemLinker * GetLinker() |
Gets the linker evaluating this root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
UObject * GetPlaybackContext() |
Gets the playback context | EntitySystem/MovieSceneSharedPlaybackState.h | |
| Gets the pre-animated state utility for the sequence hierarchy | EntitySystem/MovieSceneSharedPlaybackState.h | ||
| Gets the pre-animated state utility for the sequence hierarchy | EntitySystem/MovieSceneSharedPlaybackState.h | ||
const FMovieSceneCompiledDataID & GetRootCompiledDataID() |
Gets the compiled data ID for the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
const FRootInstanceHandle & GetRootInstanceHandle() |
Gets the handle of the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
UMovieSceneSequence * GetRootSequence() |
Gets the root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
TSharedPtr< FMovieSceneEntitySystemRunner > GetRunner() |
Gets the runner evaluating this root sequence | EntitySystem/MovieSceneSharedPlaybackState.h | |
UMovieSceneSequence * GetSequence
(
FMovieSceneSequenceIDRef SequenceID |
Gets a sub-sequence given an ID | EntitySystem/MovieSceneSharedPlaybackState.h | |
bool HasCapability() |
Returns whether the root sequence has the specified capability. | EntitySystem/MovieSceneSharedPlaybackState.h | |
void InvalidateCachedData() |
EntitySystem/MovieSceneSharedPlaybackState.h | ||
void SetDebugBreakOnDestroy() |
EntitySystem/MovieSceneSharedPlaybackState.h | ||
T & SetOrAddCapability
(
ArgTypes&&... InArgs |
Adds the specified capability on the root sequence. | EntitySystem/MovieSceneSharedPlaybackState.h | |
T & SetOrAddCapabilityRaw
(
T* InPointer |
Adds the specified capability on the root sequence as a raw pointer. | EntitySystem/MovieSceneSharedPlaybackState.h | |
T & SetOrAddCapabilityShared
(
TSharedRef< T > InSharedRef |
Adds the specified capability on the root sequence as a shared pointer. | EntitySystem/MovieSceneSharedPlaybackState.h |