FKeyframeTrackEditor::AddKeysToObjects

Adds keys to the specified object.

Windows
MacOS
Linux

References

Module

MovieSceneTools

Header

/Engine/Source/Editor/MovieSceneTools/Public/KeyframeTrackEditor.h

Include

#include "KeyframeTrackEditor.h"

Syntax

FKeyPropertyResult AddKeysToObjects
(
    TArrayView< UObject *const > ObjectsToKey,
    FFrameNumber KeyTime,
    ESequencerKeyMode KeyMode,
    TSubclassOf< UMovieSceneTrack > TrackClass,
    FName PropertyName,
    TFunction< void> OnInitializeNewTrack,
    const GenerateKeysCallback & OnGenerateKeys
)

Remarks

Adds keys to the specified object. This may also add tracks and sections depending on the options specified.

this does not return true if keys were added or modified.

Returns

Whether or not a handle guid or track was created.

Parameters

Parameter

Description

ObjectsToKey

An array of objects to add keyframes to.

KeyTime

The time to add keys.

KeyedChannels

Aggregate of optionally enabled channel values for which to create new keys

ChannelDefaults

Aggregate of optionally enabled channel default values that should be applied to the section

KeyParams

The parameters to control keyframing behavior.

TrackClass

The class of track which should be created if specified in the parameters.

PropertyName

The name of the property to add keys for.

OnInitializeNewTrack

A delegate which allows for custom initialization for new tracks. This is called after the track is created, but before any sections or keys have been added.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss