Configuration Settings
◀ Documentation Index

Required Settings
   template_work
   primary_publish_template
Optional Settings
   hook_primary_publish
   hook_post_publish
   display_name
   primary_display_name
   secondary_outputs
   primary_scene_item_type
   primary_icon
   hook_copy_file
   primary_tank_type
   hook_primary_pre_publish
   hook_scan_scene
   hook_thumbnail
   hook_secondary_publish
   hook_secondary_pre_publish
   primary_description

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.

template_work

Type: template

Required Template Keys: version

Optional Template Keys: name

Description: A reference to a template which locates a work file on disk.

primary_publish_template

Type: template

Required Template Keys: version

Optional Template Keys: name

Description: Template used to locate the primary published file within the file system. If None then this must be determined within the publish hook.

Optional Settings

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

hook_primary_publish

Type: hook

Hook calling format: def execute(task, work_template, comment, thumbnail_path, sg_task, progress_cb)

Default Value: primary_publish

Description: Specify the hook that will actually do the publish of the primary task. This hook is passed the primary task that should be published. The hook is responsible for the entire publish process and should ensure to register the publish with Shotgun.

hook_post_publish

Type: hook

Hook calling format: def execute()

Default Value: post_publish

Description: Specify the hook that will be used to do any post-publish work. Typically, this hook will be responsible for versioning up the scene to the latest version.

display_name

Type: str

Default Value: Publish

Description: Specify the name that should be used in menus and the main publish dialog

primary_display_name

Type: str

Default Value: Current Work File

Description: This is the name the primary output will be given in the UI

secondary_outputs

Type: list

Description: No description available!

primary_scene_item_type

Type: str

Default Value: work_file

Description: This is the type used to match up items returned from the scan scene hook with with the primary output

primary_icon

Type: config_path

Description: This is the icon used for the primary output in the UI

hook_copy_file

Type: hook

Hook calling format: def execute(source_path, target_path, task)

Default Value: copy_file

Description: Specify a hook to copy the file 'source_path' to 'target_path'. This hook is used in the 'copy_file' utility function and can be accessed from other hooks by calling self.parent.copy_file(source_path, target_path, task) from within the hook.

primary_tank_type

Type: tank_type

Description: This is the Tank Type that will be used when registering the primary publish. If not set then this must be determined within the publish hook.

hook_primary_pre_publish

Type: hook

Hook calling format: def execute(task, work_template, progress_cb)

Default Value: primary_pre_publish

Description: Specify the hook that will run before the primary publish. This hook can be used to perform any validaiton on the primary task that is passed in to ensure that it is ready to be published.

hook_scan_scene

Type: hook

Hook calling format: def execute()

Default Value: scan_scene_{engine_name}

Description: Specify a hook to scan for items to publish. The hook should return a list dictionaries that represent the items to be published.

hook_thumbnail

Type: hook

Hook calling format: def execute()

Default Value: thumbnail

Description: Specify a hook to pre-generate a thumbnail for the publish.

hook_secondary_publish

Type: hook

Hook calling format: def execute(tasks, work_template, comment, thumbnail_path, sg_task, primary_publish_path, progress_cb)

Default Value: secondary_publish_{engine_name}

Description: Specify the hook that will be used to do the publish. This hook is passed a list of secondary tasks that are to be published. The hook is responsible for the entire publish process and should ensure it registers the published files with Shotgun

hook_secondary_pre_publish

Type: hook

Hook calling format: def execute(tasks, progress_cb)

Default Value: secondary_pre_publish_{engine_name}

Description: Specify the hook that will run before the publish. This hook can be used to perform any validaiton on the secondary tasks that are passed in to ensure that they are ready to be published.

primary_description

Type: str

Default Value: Publish and version up the current work file

Description: This is the description of the primary output used in the UI

tk-multi-publish Documentation. This was auto generated on 2013-04-26. Click here for Release Notes.