Configuration Settings
◀ Documentation Index

Optional Settings
   sg_entity_types
   template_publish
   template_publish_area
   hook_copy_file
   template_work
   template_work_area
   hook_scene_operation

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.

Optional Settings

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

sg_entity_types

Type: list

Default Value: ['Shot', 'Asset']

Description: List of Shotgun Entity Types to include in the listings when picking a work area.

template_publish

Type: template

Required Template Keys: version

Optional Template Keys: name

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

template_publish_area

Type: template

Description: A reference to a template which locates the publish directory on disk

hook_copy_file

Type: hook

Hook calling format: def execute(source_path, target_path)

Default Value: copy_file

Description: Specify a hook that will be used to copy the file 'source_path' to 'target_path'.

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.

template_work_area

Type: template

Description: A reference to a template which locates the work directory on disk

hook_scene_operation

Type: hook

Hook calling format: def execute(operation, file_path)

Default Value: scene_operation_{engine_name}

Description: All the application specific scene operations (open, save etc) that the app needs to carry out are collected together in this hook.

tk-multi-workfiles Documentation. This was auto generated on 2013-05-23. Click here for Release Notes.