unreal.RemoteImportLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Exposes: - API to enable/disable RemoteImport server (process visibility for clients) - API to register/unregister RemoteImportAnchors (specific destination for clients)

C++ Source:

  • Plugin: RemoteImport

  • Module: RemoteImportLibrary

  • File: RemoteImportLibrary.h

classmethod import_source(file_path, destination_name)bool

Triggers OnImportFileDelegate on specified Anchor

Parameters
  • file_path (str) – Path of the file to import

  • destination_name (str) – Name of the destination FRemoteImportAnchor

Returns

Whether the import operation has been triggered

Return type

bool

classmethod is_remote_import_server_active()bool
Returns

Whether the server is currently active

Return type

bool

classmethod list_anchors()

List registered Anchor names.

Returns

Names that are valid as destination names.

Return type

Array(str)

classmethod register_anchor(anchor, allow_rename=True)str

Register a possible destination for a remote import

Parameters
  • anchor (RemoteImportAnchor) – Description of the destination

  • allow_rename (bool) – When true, a unique name is generated to register the anchor even when names collide

Returns

the anchor handle, required to unregister the Anchor

Return type

str

classmethod start_remote_import_server()None

Enable the server so that the process is visible to clients

classmethod stop_remote_import_server()None

Disable the server so that the process is hidden to clients

classmethod unregister_anchor(anchor_handle)None

Remove a destination

Parameters

anchor_handle (str) – Registered handle as returned by RegisterAnchor()