UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMovieScenePreAnimatedGlobalTokenProducer Struct Referenceabstract

#include <MovieSceneExecutionToken.h>

+ Inheritance diagram for IMovieScenePreAnimatedGlobalTokenProducer:

Public Member Functions

virtual ~IMovieScenePreAnimatedGlobalTokenProducer ()
 
virtual void InitializeForAnimation () const
 
virtual IMovieScenePreAnimatedGlobalTokenPtr CacheExistingState () const =0
 

Detailed Description

Type required for production of pre-animated state tokens. Implemented as a type rather than a callback to ensure efficient construction (these types are often constructed, but rarely utilized)

Constructor & Destructor Documentation

◆ ~IMovieScenePreAnimatedGlobalTokenProducer()

virtual IMovieScenePreAnimatedGlobalTokenProducer::~IMovieScenePreAnimatedGlobalTokenProducer ( )
inlinevirtual

Member Function Documentation

◆ CacheExistingState()

virtual IMovieScenePreAnimatedGlobalTokenPtr IMovieScenePreAnimatedGlobalTokenProducer::CacheExistingState ( ) const
pure virtual

Produce a token that can be used to return the playback environment back to its current state

Note
Under some circumstances, the environment may already be animated (for instance, after something has animated, but didn't restore state)
Returns
A valid pre animated token that will restore the environment back to its current state

Implemented in Impl::FPreAnimatedTokenProducer, and FMovieSceneRemoveInitialGlobalValueTokenProducer.

◆ InitializeForAnimation()

virtual void IMovieScenePreAnimatedGlobalTokenProducer::InitializeForAnimation ( ) const
inlinevirtual

Perform any initial set up required to animate the playback environment

Note
Only ever called when environment is in an unanimated state, as according to the AnimTypeID that this producer is operating on.

Reimplemented in Impl::FPreAnimatedTokenProducer.


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