unreal.ShotgridEngine

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

Bases: Object

Wrapper for the Python Shotgrid Engine The functions are implemented in Python by a class that derives from this one

C++ Source:

• Plugin: Shotgrid

• Module: Shotgrid

• File: ShotgridEngine.h

Editor Properties: (see get_editor_property/set_editor_property)

• selected_actors (Array[Actor]): [Read-Write]

• selected_assets (Array[AssetData]): [Read-Write] Selected assets to be used for Shotgrid commands

execute_command(command_name) → None

Execute a Shotgrid command by name in the Python Shotgrid Engine

Parameters:

command_name (str)

classmethod get_instance() → ShotgridEngine

Get the instance of the Python Shotgrid Engine

Return type:

ShotgridEngine

get_referenced_assets(actor) → Array[Object]

Get the assets that are referenced by the given Actor

Parameters:

actor (Actor)

Return type:

Array[Object]

get_selected_actors() → Array[Actor]

Selected actors to be used for Shotgrid commands

Return type:

Array[Actor]

get_shotgrid_menu_items() → Array[ShotgridMenuItem]

Get the available Shotgrid commands from the Python Shotgrid Engine

Return type:

Array[ShotgridMenuItem]

classmethod get_shotgrid_work_dir() → str

Get the root path for the Shotgrid work area

Return type:

str

on_engine_initialized() → None

Callback for when the Python Shotgrid Engine has finished initialization

property selected_actors: None

[Read-Write]

Type:

(Array[Actor])

property selected_assets: None

[Read-Write] Selected assets to be used for Shotgrid commands

Type:

(Array[AssetData])

shutdown() → None

Shut down the Python Shotgrid Engine