unreal.PSDDocument

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

Bases: Object

class: UPSDDocument brief: Represents a PSD document in Unreal Engine. This class is used to store information about a PSD document, such as its name, size, and layers. It is intended to be used as part of the PSD Importer API in Unreal Engine.

C++ Source:

  • Plugin: PSDImporter

  • Module: PSDImporter

  • File: PSDDocument.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_import_data (AssetImportData): [Read-Write]

  • document_name (str): [Read-Only] Original document name, the asset may differ (if the user renamed it).

  • import_invisible_layers (bool): [Read-Write]

  • layers (Array[PSDFileLayer]): [Read-Write]

  • resize_layers_to_document (bool): [Read-Write]

  • size (IntPoint): [Read-Only] Resolution (in pixels);

property document_name: str

[Read-Only] Original document name, the asset may differ (if the user renamed it).

Type:

(str)

get_document_name() str

Get Document Name

Return type:

str

get_layers() Array[PSDFileLayer]

Get Layers

Return type:

Array[PSDFileLayer]

get_size() IntPoint

Get Size

Return type:

IntPoint

property import_invisible_layers: bool

[Read-Write]

Type:

(bool)

property layers: None

[Read-Only]

Type:

(Array[PSDFileLayer])

property resize_layers_to_document: bool

[Read-Write]

Type:

(bool)

property size: IntPoint

[Read-Only] Resolution (in pixels);

Type:

(IntPoint)

were_layers_resized_on_import() bool

Were Layers Resized on Import

Return type:

bool