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

#include <MovieScenePossessable.h>

Public Member Functions

 FMovieScenePossessable ()
 
 FMovieScenePossessable (const FString &InitName, UClass *InitPossessedObjectClass)
 
const FGuidGetGuid () const
 
void SetGuid (const FGuid &InGuid)
 
const FString & GetName () const
 
void SetName (const FString &InName)
 
const FGuidGetParent () const
 
MOVIESCENE_API void SetParent (const FGuid &InParentGuid)
 
MOVIESCENE_API void SetParent (const FGuid &InParentGuid, UMovieScene *Owner)
 
const FMovieSceneObjectBindingIDGetSpawnableObjectBindingID () const
 
void SetSpawnableObjectBindingID (const FMovieSceneObjectBindingID &InSpawnableObjectBindingID)
 
MOVIESCENE_API bool BindSpawnableObject (FMovieSceneSequenceID SequenceID, UObject *Object, TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState)
 
MOVIESCENE_API bool BindSpawnableObject (FMovieSceneSequenceID SequenceID, UObject *Object, IMovieScenePlayer *Player)
 
bool operator< (const FMovieScenePossessable &RHS) const
 
bool operator< (const FGuid &InGuid) const
 

Public Attributes

TArray< FNameTags
 
FMovieSceneDynamicBinding DynamicBinding_DEPRECATED
 

Friends

bool operator< (const FGuid &InGuid, const FMovieScenePossessable &RHS)
 

Detailed Description

MovieScenePossessable is a "typed slot" used to allow the MovieScene to control an already-existing object

Constructor & Destructor Documentation

◆ FMovieScenePossessable() [1/2]

FMovieScenePossessable::FMovieScenePossessable ( )
inline

Default constructor.

◆ FMovieScenePossessable() [2/2]

FMovieScenePossessable::FMovieScenePossessable ( const FString &  InitName,
UClass InitPossessedObjectClass 
)
inline

Creates and initializes a new instance.

Parameters
InitName
InitPossessedObjectClass

Member Function Documentation

◆ BindSpawnableObject() [1/2]

bool FMovieScenePossessable::BindSpawnableObject ( FMovieSceneSequenceID  SequenceID,
UObject Object,
IMovieScenePlayer Player 
)

◆ BindSpawnableObject() [2/2]

bool FMovieScenePossessable::BindSpawnableObject ( FMovieSceneSequenceID  SequenceID,
UObject Object,
TSharedRef< const UE::MovieScene::FSharedPlaybackState SharedPlaybackState 
)

◆ GetGuid()

const FGuid & FMovieScenePossessable::GetGuid ( ) const
inline

Get the unique identifier of the possessed object.

Returns
Object GUID.
See also
GetName, GetPossessedObjectClass

◆ GetName()

const FString & FMovieScenePossessable::GetName ( ) const
inline

Get the name of the possessed object.

Returns
Object name.
See also
GetGuid, GetPossessedObjectClass

◆ GetParent()

const FGuid & FMovieScenePossessable::GetParent ( ) const
inline

Get the guid of this possessable's parent, if applicable

Returns
The guid.

◆ GetSpawnableObjectBindingID()

const FMovieSceneObjectBindingID & FMovieScenePossessable::GetSpawnableObjectBindingID ( ) const
inline

◆ operator<() [1/2]

bool FMovieScenePossessable::operator< ( const FGuid InGuid) const
inline

◆ operator<() [2/2]

bool FMovieScenePossessable::operator< ( const FMovieScenePossessable RHS) const
inline

◆ SetGuid()

void FMovieScenePossessable::SetGuid ( const FGuid InGuid)
inline

Set the unique identifier

Parameters
InGuid

◆ SetName()

void FMovieScenePossessable::SetName ( const FString &  InName)
inline

Set the name of the possessed object

Parameters
InName

◆ SetParent() [1/2]

void FMovieScenePossessable::SetParent ( const FGuid InParentGuid)

◆ SetParent() [2/2]

void FMovieScenePossessable::SetParent ( const FGuid InParentGuid,
UMovieScene Owner 
)

Set the guid of this possessable's parent

Parameters
InParentGuidThe guid of this possessable's parent.

◆ SetSpawnableObjectBindingID()

void FMovieScenePossessable::SetSpawnableObjectBindingID ( const FMovieSceneObjectBindingID InSpawnableObjectBindingID)
inline

Friends And Related Symbol Documentation

◆ operator<

bool operator< ( const FGuid InGuid,
const FMovieScenePossessable RHS 
)
friend

Member Data Documentation

◆ DynamicBinding_DEPRECATED

FMovieSceneDynamicBinding FMovieScenePossessable::DynamicBinding_DEPRECATED

◆ Tags

TArray<FName> FMovieScenePossessable::Tags

Array of tags that can be used for grouping and categorizing.


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