unreal.LevelSnapshotsEditorFunctionLibrary

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

Bases: BlueprintFunctionLibrary

Level Snapshots Editor Function Library

C++ Source:

  • Plugin: LevelSnapshots

  • Module: LevelSnapshotsEditor

  • File: LevelSnapshotsEditorFunctionLibrary.h

classmethod generate_thumbnail_for_snapshot_asset(snapshot_package) → None

If the snapshot is saved in the registry, takes a screenshot of the editor scene and sets it as thumnail for the snapshot.

Parameters:

snapshot_package (LevelSnapshot) –

classmethod take_and_save_level_snapshot_editor_world(file_name, folder_path, description) → None

Uses TakeLevelSnapshotAndSaveToDisk() and assumes Editor World

Parameters:

  • file_name (str) –

  • folder_path (str) –

  • description (str) –

classmethod take_level_snapshot_and_save_to_disk(world_context_object, file_name, folder_path, description, should_create_unique_file_name=True) → LevelSnapshot

brief: Creates a new Level Snapshot asset in the content browser and then captures the target world

Parameters:

  • world_context_object (Object) – Context object to determine which world to take the snapshot in

  • file_name (str) – The desired asset file name

  • folder_path (str) – The desired asset location

  • description (str) –

  • should_create_unique_file_name (bool) – If true, the asset name will have a number incrementally added to the file name if an asset with a similar name already exists. If false, the existing asset will be overwritten.

Return type:

LevelSnapshot