Document Enhanced Guides scripting API updates#62
Open
JessiMcM wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the guide-related scripting API, covering both the original guide
methods (After Effects 16.1) and the new
GuideOptions-based API added inAfter Effects (Beta) 26.5.
docs/item/item.md-Item.guides,Item.addGuide(),Item.getGuideAsObject(),Item.setGuide(): version-based property tablesand both call signatures (integer form +
GuideOptionsform).docs/layer/layer.md- Parallel documentation for the layer-level guidemethods (
Layer.guides,Layer.addGuide(),Layer.getGuideAsObject(),Layer.setGuide()), which have existed since 16.1 but were previouslyundocumented.
docs/other/guideoptions.md- NewGuideOptionsobject page with theGuideOrientationTypeandGuidePositionTypeenumerations.docs/introduction/changelog.md- Adds the 26.5 entry and fills in the16.1 guide entries.
mkdocs.yml- Adds theGuideOptionspage to the nav.Additional callouts
GuideOptions, the enum types,getGuideAsObject(), andthe
GuideOptionsoverloads ofaddGuide()/setGuide()) carry a note thatthey are in Beta and subject to change.
values behind
orientationType/positionTypediffer between versions, socode should compare against the named enumerated constants rather than raw
integers in the beta.