![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include <IMovieScenePlayer.h>
Inheritance diagram for IMovieScenePlayer:Static Public Member Functions | |
| static MOVIESCENE_API IMovieScenePlayer * | Get (uint16 InUniqueIndex) |
| static MOVIESCENE_API void | Get (TArray< IMovieScenePlayer * > &OutPlayers, bool bOnlyUnstoppedPlayers) |
| static MOVIESCENE_API void | SetIsEvaluatingFlag (uint16 InUniqueIndex, bool bIsUpdating) |
Public Attributes | |
| FMovieSceneEvaluationState | State |
| FMovieScenePreAnimatedState | PreAnimatedState |
| TMap< FMovieSceneEvaluationOperand, FMovieSceneEvaluationOperand > & | BindingOverrides |
Protected Member Functions | |
| virtual MOVIESCENE_API void | ResolveBoundObjects (UE::UniversalObjectLocator::FResolveParams &ResolveParams, const FGuid &InBindingId, FMovieSceneSequenceID SequenceID, UMovieSceneSequence &Sequence, TArray< UObject *, TInlineAllocator< 1 > > &OutObjects) const |
Friends | |
| struct | FMovieSceneObjectCache |
Interface for movie scene players Provides information for playback of a movie scene
| PRAGMA_DISABLE_DEPRECATION_WARNINGS IMovieScenePlayer::IMovieScenePlayer | ( | ) |
|
virtual |
| void IMovieScenePlayer::AddBindingOverride | ( | const FMovieSceneEvaluationOperand & | InOperand, |
| const FMovieSceneEvaluationOperand & | InOverrideOperand | ||
| ) |
Adds an override for the given operand
Cast this player instance as a UObject if possible
Reimplemented in FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
|
inlinevirtual |
Called to retrieve or construct an entity linker for the specified playback context
Reimplemented in FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
|
virtual |
|
inline |
Discard all pre-animated state without restoring it
| TArrayView< TWeakObjectPtr<> > IMovieScenePlayer::FindBoundObjects | ( | const FGuid & | ObjectBindingID, |
| FMovieSceneSequenceIDRef | SequenceID | ||
| ) |
Locate objects bound to the specified object guid, in the specified sequence
| ObjectBindingID | The object to resolve |
| SequenceID | ID of the sequence to resolve for |
|
inline |
Locate objects bound to the specified sequence operand
| Operand | The movie scene operand to resolve |
|
inline |
Attempt to find the object binding ID for the specified object, in the specified sequence
| InObject | The object to find a GUID for |
| SequenceID | The sequence ID to search within |
|
inline |
Attempt to find the object binding ID for the specified object, in the specified sequence
| InObject | The object to find a GUID for |
| SequenceID | The sequence ID to search within |
| TSharedPtr< UE::MovieScene::FSharedPlaybackState > IMovieScenePlayer::FindSharedPlaybackState | ( | ) |
Returns the evaluated sequence instance's shared playback state, if any.
| TSharedPtr< const UE::MovieScene::FSharedPlaybackState > IMovieScenePlayer::FindSharedPlaybackState | ( | ) | const |
|
static |
|
static |
| FMovieSceneEvaluationOperand * IMovieScenePlayer::GetBindingOverride | ( | const FMovieSceneEvaluationOperand & | InOperand | ) |
Retrieves any override for the given operand
| FMovieSceneEvaluationState * IMovieScenePlayer::GetEvaluationState | ( | ) |
Gets the evaluation state that stores global state to do with the playback operation
|
pure virtual |
Access the evaluation template that we are playing back
Implemented in FNullPlayer, Impl::FTestMovieScenePlayer, FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
Access the event contexts for this movie scene player
Reimplemented in ULevelSequencePlayer.
|
inlinevirtual |
Reimplemented in UMovieSceneSequencePlayer.
| UObject * IMovieScenePlayer::GetOrCreateDirectorInstance | ( | TSharedRef< const UE::MovieScene::FSharedPlaybackState > | SharedPlaybackState, |
| FMovieSceneSequenceIDRef | SequenceID | ||
| ) |
Gets a new or existing director blueprint instance for the given root or sub sequence
|
inlinevirtual |
Access the client in charge of playback
Reimplemented in FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
|
inline |
Access the playback context for this movie scene player
Reimplemented in ULevelSequencePlayer, FMovieSceneLegacyPlayer, and UUMGSequencePlayer.
|
pure virtual |
Implemented in FNullPlayer, Impl::FTestMovieScenePlayer, FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
| TSharedRef< UE::MovieScene::FSharedPlaybackState > IMovieScenePlayer::GetSharedPlaybackState | ( | ) |
Returns the evaluated sequence instance's shared playback state, asserts if there is none.
| TSharedRef< const UE::MovieScene::FSharedPlaybackState > IMovieScenePlayer::GetSharedPlaybackState | ( | ) | const |
|
inlinevirtual |
Obtain an object responsible for managing movie scene spawnables
Reimplemented in FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
| UE::MovieScene::IStaticBindingOverridesPlaybackCapability * IMovieScenePlayer::GetStaticBindingOverrides | ( | ) |
Gets the list of binding overrides to use for the sequence
|
inline |
|
inlinevirtual |
Reimplemented in FNullPlayer, Impl::FTestMovieScenePlayer, and UMovieSceneSequencePlayer.
Whether this player utilizes dynamic weighting
Reimplemented in UMovieSceneSequencePlayer.
|
virtual |
Initializes a new root sequence instance and its shared playback state. This adds all the player's playback capabilities to the given state.
Reimplemented in ULevelSequencePlayer, FMovieSceneLegacyPlayer, and UUMGSequencePlayer.
| void IMovieScenePlayer::InvalidateCachedData | ( | ) |
Invalidate any cached state contained within this player causing all entities to be forcibly re-linked and evaluated
|
virtual |
Returns whether event triggers are disabled and if so, until what time.
| bool IMovieScenePlayer::IsEvaluating | ( | ) | const |
Test whether this is a preview player or not. As such, playback range becomes insignificant for things like spawnables
Called whenever any object bindings have changed
Reimplemented from UE::MovieScene::IObjectBindingNotifyPlaybackCapability.
|
inlineoverridevirtual |
Called whenever an object binding has been resolved to give the player a chance to interact with the objects before they are animated
| InGuid | The guid of the object binding that has been resolved |
| InSequenceID | The ID of the sequence in which the object binding resides |
| Objects | The array of objects that were resolved |
Reimplemented from UE::MovieScene::IObjectBindingNotifyPlaybackCapability.
|
inlinevirtual |
|
virtual |
Called to initialize the flag structure that denotes what functions need to be called on this updater
|
inlinevirtual |
Called by the evaluation system after evaluation has occured
Reimplemented in UMovieSceneSequencePlayer.
|
inlinevirtual |
Called by the evaluation system when evaluation has just started.
Reimplemented in UMovieSceneSequencePlayer.
| void IMovieScenePlayer::RemoveBindingOverride | ( | const FMovieSceneEvaluationOperand & | InOperand | ) |
Removes any override set for the given operand
| void IMovieScenePlayer::ResetDirectorInstances | ( | ) |
Remove all director blueprint instances
|
virtual |
Resolve objects bound to the specified binding ID
| InBindingId | The ID relating to the object(s) to resolve |
| OutObjects | Container to populate with the bound objects |
|
protectedvirtual |
Resolve objects bound to the specified binding ID
| InBindingId | The ID relating to the object(s) to resolve |
| OutObjects | Container to populate with the bound objects |
Reimplemented in ULevelSequencePlayer, and UMovieSceneSequencePlayer.
|
inline |
Restore all pre-animated state
|
inline |
Attempt to save specific state for the specified token state before it mutates state.
| InTokenType | Unique marker that identifies the originating token type |
| InProducer | Producer implementation that defines how to create the preanimated token, if it doesn't already exist |
|
inline |
Attempt to save specific state for the specified token state before it animates an object.
| InObject | The object to cache state for |
| InTokenType | Unique marker that identifies the originating token type |
| InProducer | Producer implementation that defines how to create the preanimated token, if it doesn't already exist |
|
pure virtual |
| PlaybackStatus | The playback status to set |
Implemented in FNullPlayer, Impl::FTestMovieScenePlayer, FMovieSceneLegacyPlayer, UMovieSceneSequencePlayer, and UUMGSequencePlayer.
|
inlinevirtual |
Reimplemented in FNullPlayer, Impl::FTestMovieScenePlayer, and UMovieSceneSequencePlayer.
|
inlinevirtual |
|
inlinevirtual |
|
friend |
| TMap<FMovieSceneEvaluationOperand, FMovieSceneEvaluationOperand>& IMovieScenePlayer::BindingOverrides |
List of binding overrides to use for the sequence
| FMovieScenePreAnimatedState IMovieScenePlayer::PreAnimatedState |
Container that stores any per-animated state tokens
| FMovieSceneEvaluationState IMovieScenePlayer::State |
Evaluation state that stores global state to do with the playback operation