SpriteFont script interface

The ISpriteFontInstance interface derives from IWorldInstance to add APIs specific to the Sprite font plugin.

SpriteFont APIs

text
The string currently displayed by the Sprite Font object.
typewriterText(str, duration)
Set the text over time by starting with an empty string and gradually adding characters until the full text of str is written out, over a duration specified in seconds. Note modifying the text property while text is being written out will cancel the effect.
typewriterFinish()
If text is being written out with the typewriterText() method, force it to finish immediately.
characterScale
The current text scale, defaulting to 1 for normal scale.
characterSpacing
The extra space in pixels to add horizontally between characters.
lineHeight
The extra space in pixels to add vertically between lines. 0 is the default size, negative values make lines closer together, and positive values space lines out further apart.
horizontalAlign
A string specifying the horizontal alignment of the text within the object bounding box, which must be one of "left", "center" or "right".
verticalAlign
A string specifying the vertical alignment of the text within the object bounding box, which must be one of "top", "center" or "bottom".
wordWrapMode
A string specifying the way to wrap text when it reaches the end of a line. This can be either "word" to wrap entire space-separated words, or "character" to wrap at any character.
Construct 3 Manual 2019-08-12

On this page