UE::MovieScene::FRestoreStateParams Struct Reference

#include <MovieSceneRestoreStateParams.h>

Public Member Functions
MOVIESCENE_API IMovieScenePlayer *	GetTerminalPlayer () const
MOVIESCENE_API TSharedPtr< FSharedPlaybackState >	GetTerminalPlaybackState () const

Public Attributes
UMovieSceneEntitySystemLinker *	Linker
FInstanceHandle	TerminalInstanceHandle

Detailed Description

Parameters that are passed to IMovieScenePreAnimatedToken::RestoreState and IMovieScenePreAnimatedGlobalToken::RestoreState

Member Function Documentation

GetTerminalPlaybackState()

TSharedPtr< FSharedPlaybackState > UE::MovieScene::FRestoreStateParams::GetTerminalPlaybackState

(

)

const

Retrieve a pointer to the shared playback state that is causing this state to be restored.

Note

: may not relate to the same sequence instance that originally cached the state in the case where 2 completely different sequences animated the same object at the same time. May be null in test harnesses

GetTerminalPlayer()

IMovieScenePlayer * UE::MovieScene::FRestoreStateParams::GetTerminalPlayer

(

)

const

Retrieve a pointer to the player that is causing this state to be restored.

Note

: may not be the same player that originally cached the state in the case where 2 completely different sequences animated the same object at the same time. May be null in test harnesses

Member Data Documentation

Linker

UMovieSceneEntitySystemLinker* UE::MovieScene::FRestoreStateParams::Linker

The linker that originally cached the pre-animated state

TerminalInstanceHandle

FInstanceHandle UE::MovieScene::FRestoreStateParams::TerminalInstanceHandle

The instance handle that relates to the last sequence that finished animating this state. Can be invalid in test harnesses.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/MovieScene/Public/Evaluation/PreAnimatedState/MovieSceneRestoreStateParams.h
• Engine/Source/Runtime/MovieScene/Private/Evaluation/PreAnimatedState/MovieSceneRestoreStateParams.cpp