FMovieSceneChannelHandle | Unreal Engine 5.6 Documentation

Handle to a specific channel in a UMovieSceneSection. Will become nullptr when the FMovieSceneChannelProxy it was created with is reallocated.


Name	FMovieSceneChannelHandle
Type	struct
Header File	/Engine/Source/Runtime/MovieScene/Public/Channels/MovieSceneChannelHandle.h
Include Path	#include "Channels/MovieSceneChannelHandle.h"

Syntax

struct FMovieSceneChannelHandle

Name	Remarks	Include Path	Unreal Specifiers
FMovieSceneChannelHandle ()	Default constructor	Channels/MovieSceneChannelHandle.h
FMovieSceneChannelHandle ( TWeakPtr< FMovieSceneChannelProxy > InWeakChannelProxy, FName InChannelTypeName, int32 InChannelIndex )	Construction from a weak channel proxy, the channel's type, and its index	Channels/MovieSceneChannelHandle.h

Name	Type	Remarks	Include Path
ChannelIndex	int32	The index of the channel within the typed channels array	Channels/MovieSceneChannelHandle.h
ChannelTypeName	FName	The type name for the channel in the proxy	Channels/MovieSceneChannelHandle.h
WeakChannelProxy	TWeakPtr< FMovieSceneChannelProxy >	Weak pointer to the channel, proxy alisased to the channel proxy's shared reference controller to ensure it becomes null when the proxy is re-allocated	Channels/MovieSceneChannelHandle.h

Name	Remarks	Include Path
TMovieSceneChannelHandle< OtherChannelType > Cast ()	Cast this handle to a handle of a related type.	Channels/MovieSceneChannelHandle.h
FMovieSceneChannel * Get()	Get the channel pointer this handle represents.	Channels/MovieSceneChannelHandle.h
int32 GetChannelIndex()	Access this channel's index	Channels/MovieSceneChannelHandle.h
FMovieSceneChannelProxy * GetChannelProxy()	Attempt to access the proxy for this channel. Will return nullptr if it is no longer valid.	Channels/MovieSceneChannelHandle.h
FName GetChannelTypeName()	Access this channel's type identifier	Channels/MovieSceneChannelHandle.h
const void * GetExtendedEditorData()	Get the extended editor data associated with this channel	Channels/MovieSceneChannelHandle.h
const FMovieSceneChannelMetaData * GetMetaData()	Get the meta data associated with this channel	Channels/MovieSceneChannelHandle.h

Name	Remarks	Include Path	Unreal Specifiers
static UStruct * GetChannelTypeByName ( FName ChannelName )		Channels/MovieSceneChannelHandle.h
static void TrackChannelTypeName()		Channels/MovieSceneChannelHandle.h
static void TrackChannelTypeNameInternal ( UStruct* ChannelType )		Channels/MovieSceneChannelHandle.h