UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMovieSceneRemoveInitialGlobalValueTokenProducer Struct Reference

#include <MovieSceneInitialValueStore.h>

+ Inheritance diagram for FMovieSceneRemoveInitialGlobalValueTokenProducer:

Public Member Functions

MOVIESCENE_API FMovieSceneRemoveInitialGlobalValueTokenProducer (TWeakPtr< IMovieSceneBlendingActuator > InWeakActuator)
 
MOVIESCENE_API ~FMovieSceneRemoveInitialGlobalValueTokenProducer ()
 
virtual MOVIESCENE_API IMovieScenePreAnimatedGlobalTokenPtr CacheExistingState () const override
 
- Public Member Functions inherited from IMovieScenePreAnimatedGlobalTokenProducer
virtual ~IMovieScenePreAnimatedGlobalTokenProducer ()
 
virtual void InitializeForAnimation () const
 

Detailed Description

Pre animated token producer that reverts a global initial value from the actuator when its state is restored

Constructor & Destructor Documentation

◆ FMovieSceneRemoveInitialGlobalValueTokenProducer()

FMovieSceneRemoveInitialGlobalValueTokenProducer::FMovieSceneRemoveInitialGlobalValueTokenProducer ( TWeakPtr< IMovieSceneBlendingActuator InWeakActuator)

Construction from the object whose initial value to remove, and the actuator to remove it from

◆ ~FMovieSceneRemoveInitialGlobalValueTokenProducer()

FMovieSceneRemoveInitialGlobalValueTokenProducer::~FMovieSceneRemoveInitialGlobalValueTokenProducer ( )
default

Member Function Documentation

◆ CacheExistingState()

IMovieScenePreAnimatedGlobalTokenPtr FMovieSceneRemoveInitialGlobalValueTokenProducer::CacheExistingState ( ) const
overridevirtual

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

Implements IMovieScenePreAnimatedGlobalTokenProducer.


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