Font Object
FontObject(
post_script_name: str,
family_name: str | None = None,
full_name: str | None = None,
style_name: str | None = None,
version: str | None = None,
location: str | None = None,
font_id: int | None = None,
has_design_axes: bool | None = None,
is_from_adobe_fonts: bool | None = None,
is_substitute: bool | None = None,
native_family_name: str | None = None,
native_full_name: str | None = None,
native_style_name: str | None = None,
family_prefix: str | None = None,
technology: CTFontTechnology | None = None,
type: CTFontType | None = None,
design_axes_data: list[dict[str, Any]] | None = None,
design_vector: list[float] | None = None,
writing_scripts: list[CTScript] | None = None,
)
Provides information about a specific font.
The Font object provides information about a specific font, along with the font technology used, helping disambiguate when multiple fonts sharing the same PostScript name are installed on the system.
Most of these attributes simply return information which is contained in the font data file itself.
Example
Note
This functionality was added in After Effects 24.0.
See: https://ae-scripting.docsforadobe.dev/text/fontobject/
Attributes¶
The design axes data from the font. Each dict contains the axis
name, tag, min value, max value, and default value.
Note
Will return None for non-variable fonts.
For variable fonts, an ordered list with a length matching the number of design axes defined by the font.
Note
Will return None for non-variable fonts.
family_name: str | None = None
The family name of the font, in the ASCII character set.
family_prefix: str | None = None
The family prefix of the variable font. For example, the family of the
PostScript name SFPro-Bold is SFPro.
Note
Will return None for non-variable fonts.
font_id: int | None = None
A unique number assigned to the font instance when it is created, value is greater than or equal to 1. It never changes during the application session but may be different in subsequent launches of the application.
Can be used to compare two FontObject instances to see if they refer to the same underlying native font instance.
Note
This functionality was added in After Effects 24.2.
full_name: str | None = None
The full name of the font, in the ASCII character set. Usually composed of the family name and the style name.
is_from_adobe_fonts: bool | None = None
Returns True if the font is from Adobe Fonts.
is_substitute: bool | None = None
Returns True when this font instance represents a font reference
which was missing on project open.
location: str | None = None
The location of the font file on your system.
Warning
Not guaranteed to be returned for all font types; return value may be empty string for some kinds of fonts.
native_family_name: str | None = None
The native family name of the font in full 16-bit Unicode. Often different than what is returned by family_name for non-Latin fonts.
native_full_name: str | None = None
The native full name of the font in full 16-bit Unicode. Often different than what is returned by full_name for non-Latin fonts.
native_style_name: str | None = None
The native style name of the font in full 16-bit Unicode. Often different than what is returned by style_name for non-Latin fonts.