Skip to content

Document Enhanced Guides scripting API updates#62

Merged
foughtthelaw merged 1 commit into
docsforadobe:masterfrom
JessiMcM:guides-v2-scripting-docs
Jul 15, 2026
Merged

Document Enhanced Guides scripting API updates#62
foughtthelaw merged 1 commit into
docsforadobe:masterfrom
JessiMcM:guides-v2-scripting-docs

Conversation

@JessiMcM

@JessiMcM JessiMcM commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the guide-related scripting API, covering both the original guide
methods (After Effects 16.1) and the new GuideOptions-based API added in
After Effects (Beta) 26.5.

  • docs/item/item.md - Item.guides, Item.addGuide(),
    Item.getGuideAsObject(), Item.setGuide(): version-based property tables
    and both call signatures (integer form + GuideOptions form).
  • docs/layer/layer.md - Parallel documentation for the layer-level guide
    methods (Layer.guides, Layer.addGuide(), Layer.getGuideAsObject(),
    Layer.setGuide()), which have existed since 16.1 but were previously
    undocumented.
  • docs/other/guideoptions.md - New GuideOptions object page with the
    GuideOrientationType and GuidePositionType enumerations.
  • docs/introduction/changelog.md - Adds the 26.5 entry and fills in the
    16.1 guide entries.
  • mkdocs.yml - Adds the GuideOptions page to the nav.

Additional callouts

  • APIs new in 26.5 Beta (GuideOptions, the enum types, getGuideAsObject(), and
    the GuideOptions overloads of addGuide()/setGuide()) carry a note that
    they are in Beta and subject to change.
  • A "Differences between guide versions" callout explains that the integer
    values behind orientationType/positionType differ between versions, so
    code should compare against the named enumerated constants rather than raw
    integers in the beta.

@JessiMcM

Copy link
Copy Markdown
Contributor Author

@foughtthelaw + @zlovatt - I don't generally work in public github. Not sure if I need a different status within this repository to be able to request reviews from specific individuals in the repository, but it doesn't seem like I have that capability. Thanks for any assistance you could provide.

@foughtthelaw
foughtthelaw merged commit 07a9f8e into docsforadobe:master Jul 15, 2026
@JessiMcM
JessiMcM deleted the guides-v2-scripting-docs branch July 16, 2026 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants