Configuration Settings
◀ Documentation Index

Required Settings
   engine
   windows_path
   extra
   mac_path
   menu_name
   linux_path
Optional Settings
   linux_args
   deny_permissions
   mac_args
   hook_app_launch
   windows_args
   entity_types

Configuration Settings

Below is a summary of all the configuration settings used. These settings need to be defined in the environment file where you want to enable this App or Engine.

Required Settings

These settings need to be defined in any environment where this app or engine is being used.

engine

Type: str

Description: The name of the Tank engine to start. When this app runs, it will first try to find an environment. This is based on the current context, e.g. the Shot or Task in Shotgun from which the action was initiated. Once the environment has been established (one of the files in the env folder in the Tank configuration), an engine will be started. This parameter specifies which engine to start.

windows_path

Type: str

Description: The path to the application executable on Windows.

extra

Type: dict

Description: Tank engine specific extra values. These are defined per Tank engine. Please look in the app documentation for more details.

mac_path

Type: str

Description: The path to the application executable on Mac OS X.

menu_name

Type: str

Description: Name to appear on the Tank menu.

linux_path

Type: str

Description: The path to the application executable on Linux.

Optional Settings

These settings are optional and can be defined at the discretion of the user.

linux_args

Type: str

Description: The arguments to be passed to application on Linux.

deny_permissions

Type: list

Description: An optional parameter which lets you limit the visibility of this app. If you for example put in ['Artist'] as the value for this parameter, any user belonging to the shotgun permissions group Artist will not be able to see or execute the App.

mac_args

Type: str

Description: The arguments to be passed to application on Mac OS X.

hook_app_launch

Type: hook

Hook calling format: def execute()

Default Value: app_launch

Description: Called to launch the application.

windows_args

Type: str

Description: The arguments to be passed to application on Windows.

entity_types

Type: list

Default Value: ['Task']

Description: List of Shotgun entity types where this tank action should be visible on the Actions menu.

tk-multi-launchapp Documentation. This was auto generated on 2013-02-28. Click here for Release Notes.