unreal.LevelSequence

class unreal.LevelSequence(outer: Object | None = None, name: Name | str = 'None')

Bases: MovieSceneSequence

Movie scene animation for Actors.

C++ Source:

  • Module: LevelSequence

  • File: LevelSequence.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array[AssetUserData]): [Read-Write] Array of user data stored with the asset

add_asset_user_data_of_class(user_data_class) bool

Creates and adds an instance of the provided AssetUserData class to the target asset.

Parameters:

user_data_class (type(Class)) – UAssetUserData sub class to create

Returns:

Whether or not an instance of InUserDataClass was succesfully added

Return type:

bool

copy_meta_data(meta_data) Object

Copy the specified meta data into this level sequence, overwriting any existing meta-data of the same type Meta-data may implement the ILevelSequenceMetaData interface in order to hook into default ULevelSequence functionality.

Parameters:

meta_data (Object) – Existing Metadata Object that you wish to copy into this Level Sequence.

Returns:

The newly copied instance of the Metadata that now exists on this sequence.

Return type:

Object

find_meta_data_by_class(class_) Object

Find meta-data of a particular type for this level sequence instance.

Parameters:

class (type(Class)) – Class that you wish to find the metadata object for.

Returns:

An instance of this class if it already exists as metadata on this Level Sequence, otherwise null.

Return type:

Object

find_or_add_meta_data_by_class(class_) Object

Find meta-data of a particular type for this level sequence instance, adding it if it doesn’t already exist.

Parameters:

class (type(Class)) – Class that you wish to find or create the metadata object for.

Returns:

An instance of this class as metadata on this Level Sequence.

Return type:

Object

get_asset_user_data_of_class(user_data_class) AssetUserData

Returns an instance of the provided AssetUserData class if it’s contained in the target asset.

Parameters:

user_data_class (type(Class)) – UAssetUserData sub class to get

Returns:

The instance of the UAssetUserData class contained, or null if it doesn’t exist

Return type:

AssetUserData

has_asset_user_data_of_class(user_data_class) bool

Checks whether or not an instance of the provided AssetUserData class is contained.

Parameters:

user_data_class (type(Class)) – UAssetUserData sub class to check for

Returns:

Whether or not an instance of InUserDataClass was found

Return type:

bool

remove_meta_data_by_class(class_) None

Remove meta-data of a particular type for this level sequence instance, if it exists

Parameters:

class (type(Class)) – The class type that you wish to remove the metadata for