Configuration Settings
◀ Documentation Index

Required Settings
   template_work
   template_snapshot
Optional Settings
   hook_thumbnail
   hook_copy_file
   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.

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.

template_snapshot

Type: template

Required Template Keys: version

Optional Template Keys: name, timestamp, increment

Description: A reference to a template which defines the location where snapshot backups will be stored on disk.

Optional Settings

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

hook_thumbnail

Type: hook

Hook calling format: def execute()

Default Value: thumbnail

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

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'.

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 in this hook.

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