Production object
Production object
Section titled “Production object”app.production
Description
Section titled “Description”The Production object lets ExtendScript access and manipulate productions, insert projects, create new projects and bins, and move existing Production projects to Trash.
Attributes
Section titled “Attributes”Production.name
Section titled “Production.name”app.production.name
Description
Section titled “Description”The name of the production.
String.
Production.path
Section titled “Production.path”app.production.path
Description
Section titled “Description”The path to the Production folder.
String.
Production.projects
Section titled “Production.projects”app.production.projects
Description
Section titled “Description”An array of the projects containined within the Production, which are currently open. Does not include non-open projects.
ProjectCollection object, read-only.
Methods
Section titled “Methods”Production.addProject()
Section titled “Production.addProject()”app.production.addProject(srcProjectPath, destProjectPath)
Description
Section titled “Description”Copies a project from some other location, into the Production directory.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
srcProjectPath | String | A path to the source project. |
destProjectPath | String | A destination path for added project. |
Returns
Section titled “Returns”Returns true if successful.
Production.close()
Section titled “Production.close()”app.production.close()
Description
Section titled “Description”Closes the Production, and all open projects from within that Production.
Parameters
Section titled “Parameters”None.
Returns
Section titled “Returns”Returns true if successful.
Production.getLocked()
Section titled “Production.getLocked()”app.production.getLocked(project)
Description
Section titled “Description”Returns the lock state of a single project within the Production.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
project | Project object | The project |
Returns
Section titled “Returns”Returns true if the Project is locked, false if the Project is unlocked.
Production.moveToTrash()
Section titled “Production.moveToTrash()”app.production.moveToTrash(projectOrFolderPath, suppressUI, saveProject)
Description
Section titled “Description”Moves the specified path (“bin”) or .prproj into the Production’s Trash folder.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
projectOrFolderPath | String | A path to the source project. |
suppressUI | Boolean | Whether to suppress any resultant dialogues. |
saveProject | Boolean | Whether to save the project(s) first. |
Returns
Section titled “Returns”Returns true if successful.
Production.setLocked()
Section titled “Production.setLocked()”app.production.setLocked(project,locked)
Description
Section titled “Description”Sets the lock state of the specified project within the Production.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
project | Project object | The project |
locked | Boolean | True for locked, false for unlocked. |
Returns
Section titled “Returns”Returns true if successful.