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

#include <MovieSceneInitialValueStore.h>

+ Inheritance diagram for FMovieSceneRemoveInitialValueTokenProducer:

Public Member Functions

MOVIESCENE_API FMovieSceneRemoveInitialValueTokenProducer (TWeakPtr< IMovieSceneBlendingActuator > InWeakActuator)
 
MOVIESCENE_API ~FMovieSceneRemoveInitialValueTokenProducer ()
 
virtual MOVIESCENE_API IMovieScenePreAnimatedTokenPtr CacheExistingState (UObject &InObject) const override
 
- Public Member Functions inherited from IMovieScenePreAnimatedTokenProducer
virtual ~IMovieScenePreAnimatedTokenProducer ()
 
virtual void InitializeObjectForAnimation (UObject &Object) const
 

Detailed Description

Pre animated token producer that reverts the object's initial value from the actuator when its state is restored

Constructor & Destructor Documentation

◆ FMovieSceneRemoveInitialValueTokenProducer()

FMovieSceneRemoveInitialValueTokenProducer::FMovieSceneRemoveInitialValueTokenProducer ( TWeakPtr< IMovieSceneBlendingActuator InWeakActuator)

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

◆ ~FMovieSceneRemoveInitialValueTokenProducer()

FMovieSceneRemoveInitialValueTokenProducer::~FMovieSceneRemoveInitialValueTokenProducer ( )
default

Member Function Documentation

◆ CacheExistingState()

IMovieScenePreAnimatedTokenPtr FMovieSceneRemoveInitialValueTokenProducer::CacheExistingState ( UObject Object) const
overridevirtual

Produce a token that can be used to return the specified object back to its current state

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

Implements IMovieScenePreAnimatedTokenProducer.


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