This repository has been archived by the owner on Jun 9, 2023. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Updated Developer Docs
- Loading branch information
1 parent
b3aa060
commit dfdc890
Showing
109 changed files
with
1,787 additions
and
537 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# [docs](index.md) » cp.adobe.aftereffects.app | ||
--- | ||
|
||
The `cp.app` for Adobe After Effects. | ||
|
||
## API Overview | ||
* Constants - Useful values which cannot be changed | ||
* [app](#app) | ||
|
||
## API Documentation | ||
|
||
### Constants | ||
|
||
#### [app](#app) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.app <cp.app>` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Constant | | ||
| **Description** | The `cp.app` for After Effects. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# [docs](index.md) » cp.adobe.aftereffects | ||
--- | ||
|
||
Adobe After Effects Extension | ||
|
||
## Submodules | ||
* [cp.adobe.aftereffects.app](cp.adobe.aftereffects.app.md) | ||
* [cp.adobe.aftereffects.shortcuts](cp.adobe.aftereffects.shortcuts.md) | ||
|
||
## API Overview | ||
* Constants - Useful values which cannot be changed | ||
* [preferences](#preferences) | ||
* Functions - API calls offered directly by the extension | ||
* [allowScriptsToWriteFilesAndAccessNetwork](#allowscriptstowritefilesandaccessnetwork) | ||
* [preferencesFilePath](#preferencesfilepath) | ||
* [preferencesPath](#preferencespath) | ||
* [refreshPreferences](#refreshpreferences) | ||
* [shortcutsPreferences](#shortcutspreferences) | ||
* [shortcutsPreferencesPath](#shortcutspreferencespath) | ||
|
||
## API Documentation | ||
|
||
### Constants | ||
|
||
#### [preferences](#preferences) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.preferences <cp.app.prefs>` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Constant | | ||
| **Description** | The `cp.app.prefs` for After Effects. | | ||
|
||
### Functions | ||
|
||
#### [allowScriptsToWriteFilesAndAccessNetwork](#allowscriptstowritefilesandaccessnetwork) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:allowScriptsToWriteFilesAndAccessNetwork() -> boolean` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Function | | ||
| **Description** | Is "Allow Scripts to Write Files and Access Network" enabled in After Effects Preferences? | | ||
| **Parameters** | <ul><li>None</li></ul> | | ||
| **Returns** | <ul><li>A boolean</li></ul> | | ||
|
||
#### [preferencesFilePath](#preferencesfilepath) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:preferencesFilePath() -> string` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Function | | ||
| **Description** | The path to the main Preferences file. | | ||
| **Parameters** | <ul><li>None</li></ul> | | ||
| **Returns** | <ul><li>A string</li></ul> | | ||
|
||
#### [preferencesPath](#preferencespath) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:preferencesPath() -> string | nil` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Function | | ||
| **Description** | The path to After Effects Preferences folder. | | ||
| **Parameters** | <ul><li>None</li></ul> | | ||
| **Returns** | <ul><li>A string or <code>nil</code> if no path can be found.</li></ul> | | ||
|
||
#### [refreshPreferences](#refreshpreferences) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:refreshPreferences() -> none` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Function | | ||
| **Description** | If After Effects is running, this forces the preferences file to be saved to disk. | | ||
| **Parameters** | <ul><li>None</li></ul> | | ||
| **Returns** | <ul><li>None</li></ul> | | ||
|
||
#### [shortcutsPreferences](#shortcutspreferences) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:shortcutsPreferences() -> table` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Function | | ||
| **Description** | Gets a table of all the active After Effects keyboard shortcuts. | | ||
| **Parameters** | <ul><li>None</li></ul> | | ||
| **Returns** | <ul><li>A table</li></ul> | | ||
|
||
#### [shortcutsPreferencesPath](#shortcutspreferencespath) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects:shortcutsPreferencesPath() -> string` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Function | | ||
| **Description** | Gets the active shortcut key preferences file path. | | ||
| **Parameters** | <ul><li>None</li></ul> | | ||
| **Returns** | <ul><li>A string</li></ul> | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# [docs](index.md) » cp.adobe.aftereffects.shortcuts | ||
--- | ||
|
||
Translations between After Effects shortcuts and Hammerspoon-friendly shortcuts. | ||
|
||
## API Overview | ||
* Constants - Useful values which cannot be changed | ||
* [keys](#keys) | ||
* [labels](#labels) | ||
* [modifiers](#modifiers) | ||
|
||
## API Documentation | ||
|
||
### Constants | ||
|
||
#### [keys](#keys) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.shortcuts.keys -> table` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Constant | | ||
| **Description** | Table containing key translations. | | ||
|
||
#### [labels](#labels) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.shortcuts.labels -> table` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Constant | | ||
| **Description** | Table containing label translations. | | ||
|
||
#### [modifiers](#modifiers) | ||
| <span style="float: left;">**Signature**</span> | <span style="float: left;">`cp.adobe.aftereffects.shortcuts.modifiers -> table` </span> | | ||
| -----------------------------------------------------|---------------------------------------------------------------------------------------------------------| | ||
| **Type** | Constant | | ||
| **Description** | Table containing modifier translations. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.