new TextFormat(fontName (opt), characterScaleX (opt), characterScaleY (opt), kerning (opt), verticalShift (opt), lineHeightMultiplier (opt))
Object containing text formatting information that can be applied the characters within TextAssembly or TextBox objects.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
fontName |
string |
<optional> |
The name of the font that characters with this TextFormat will use. [DEFAULT: "MainFont"] |
|
characterScaleX |
number |
<optional> |
The x-axis scale multiplier for characters that use this TextFormat. [DEFAULT: 1] |
|
characterScaleY |
number |
<optional> |
The y-axis scale multiplier for characters that use this TextFormat. [DEFAULT: 1] |
|
kerning |
number |
<optional> |
Number representing an added or reduced spacing between the characters that use this TextFormat [DEFAULT: 0] |
|
verticalShift |
number |
<optional> |
Number representing a veritcal offset that will be applied to the characters that use this TextFormat. [DEFAULT: 0] |
|
lineHeightMultiplier |
number |
<optional> |
Number that multiplies the effective layout height of the characters that use this TextFormat. [DEFAULT: 1] |
MEMBERS
-
characterMaterial :CharacterMaterial
-
Object defining EffectNodes amd EffectController values that will be applied to the characters that used this TextFormat.
-
characterScaleX :number
-
The x-axis scale multiplier for characters that use this TextFormat.
- Default Value:
- 1
-
characterScaleY :number
-
The y-axis scale multiplier for characters that use this TextFormat.
- Default Value:
- 1
-
fontName :string
-
The name of the font that characters with this TextFormat will use. See 'nc.fontNames' for the names of the fonts available in this project. Please note that changing the fontName will result in the entire 'characterMaterial' object being reset to the materialPresets of the "xxx_Char0" character of the new font.
- Default Value:
- "MainFont"
-
inheritedTypes :object
-
Dictionary object listing all of the types this object is compatible with.
-
kerning :number
-
Number representing an added or reduced spacing between characters that use this TextFormat. This kerning number denotes the proportion of the 'characterWidth' (see ProjectConfiguration.fontDefitions) that will be added to or subtracted from the width of each character. The effects of kerning are also automatically multiplied by the given format's 'characterScaleX' value, UiZoom.totalZoom (if applicable), and the 'scaleToFitFactor' (if applicable).
- Default Value:
- 0
-
lineHeightMultiplier :number
-
Number that multiplies the effective layout height of characters the that use this TextFormat. As a default, the 'layout height' of any character within a font is the font's 'lineHeight' value (see ProjectConfiguration.fontDefitions). This number acts as a multiplier on that effective character height.
- Default Value:
- 1
-
type :string
-
Type identifier.
-
verticalShift :number
-
Number representing a veritcal offset that will be applied to the characters that use this TextFormat. This number denotes the proportion of the font's 'lineHeight' (see ProjectConfiguration.fontDefitions) that will be added to or subtracted from the vertical position of the characters using this TextFormat. The effects of verticalShift are also automatically multiplied by the given format's 'characterScaleY' value, UiZoom.totalZoom (if applicable), and the 'scaleToFitFactor' (if applicable).
- Default Value:
- 0
METHODS
-
clone() returns {TextFormat}
-
Returns a new TextFormat instance with the same values.
Returns:
TextFormat