unreal.LevelSnapshot

class unreal.LevelSnapshot(outer=None, name='None')

Bases: unreal.Object

Holds the state of a world at a given time. This asset can be used to rollback certain properties in a UWorld.

C++ Source:

• Plugin: LevelSnapshots

• Module: LevelSnapshots

• File: LevelSnapshot.h

Editor Properties: (see get_editor_property/set_editor_property)

• capture_time (DateTime): [Read-Only] Capture Time: UTC Time that the snapshot was taken

• map_path (SoftObjectPath): [Read-Only] Map Path: Path of the map that the snapshot was taken in

• snapshot_description (str): [Read-Write] Snapshot Description: User defined description of the snapshot

• snapshot_name (Name): [Read-Write] Snapshot Name: User defined name for the snapshot, can differ from the actual asset name.

property capture_time

[Read-Only] Capture Time: UTC Time that the snapshot was taken

Type

(DateTime)

get_capture_time() → DateTime

Get Capture Time

Return type

DateTime

get_map_path() → SoftObjectPath

Get Map Path

Return type

SoftObjectPath

get_snapshot_description() → str

Get Snapshot Description

Return type

str

get_snapshot_name() → Name

Get Snapshot Name

Return type

Name

property map_path

[Read-Only] Map Path: Path of the map that the snapshot was taken in

Type

(SoftObjectPath)

set_snapshot_description(snapshot_description) → None

Set Snapshot Description

Parameters

snapshot_description (str) –

set_snapshot_name(snapshot_name) → None

Sets the name of this snapshot.

Parameters

snapshot_name (Name) –

property snapshot_description

[Read-Only] Snapshot Description: User defined description of the snapshot

Type

(str)

property snapshot_name

[Read-Only] Snapshot Name: User defined name for the snapshot, can differ from the actual asset name.

Type

(Name)