Skip to main content
Sébastien Périer17107209
Community Manager
After Effects Sr. Quality Engineer
December 1, 2023
Question

New Vertical Text Scripting hooks available in Beta

  • December 1, 2023
  • 2 replies
  • 755 views
Hi everyone,

Starting in Beta build 24.2.0x29, we have added new support for managing the orientation (horizontal/vertical) of Text Layers via scripting. You'll have access to several new hooks in the latest Beta.

 

First up is new property on the TextDocument: TextDocument.lineOrientationThis read-write property uses the following enums:

  • LineOrientation.HORIZONTAL
  • LineOrientation.VERTICAL_RIGHT_TO_LEFT
  • LineOrientation.VERTICAL_LEFT_TO_RIGHT
 
The existing LayerCollection functions for creating Text Layers will create them with LineOrientation.HORIZONTAL by default.
 
Next up is two new functions for creating vertical Text Layers.
  • LayerCollection.addVerticalText(String or TextDocument)
  • LayerCollection.addVerticalBoxText([w,h][, optional String])
 
The signature of these is exactly the same as their matching horizontal versions. When using these methods, the lineOrientation for the new Text layers will be LineOrientation.VERTICAL_RIGHT_TO_LEFT by default.
 
With this same update, we've also modified access to the composerEngine attribute for:
  • TextDocument.composerEngine
  • CharacterRange.composerEngine
  • ParagraphRange.composerEngine

 

These properties were previously read-only,  and are now read-write. Please note that it is only possible to set the value to ComposerEngine.UNIVERSAL_TYPE_ENGINE. This is to allow Text Layers that use the older ComposeEngine.LATIN_CJK_ENGINE to be updated to use the newer CompserEngine.UNIVERSAL_TYPE_ENGINE.
 
You can read the updated docs here: https://ae-scripting.docsforadobe.dev/introduction/changelog.html.

Remember, these scripting hooks are currently in Beta and are subject to change.

Douglas Waterfall, John Colombo & Sebastien Perier
After Effects Engineering
This topic has been closed for replies.

2 replies

Adobe Employee
January 26, 2024

These APIs have been promoted out of beta and will appear in the upcoming 24.2 release.

 

Douglas Waterfall

After Effects Engineering

Adobe Employee
December 2, 2023

Oops - a case slipped by me and converting the line orientation of Point Text does not "take" properly after you assign it back to a Layer. Sorry about that.

 

Fix is in progress.

 

Douglas Waterfall

After Effects Engineering