Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

TextGenerationSettings

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A struct that stores the settings for TextGeneration.

Variables

color The base color for the text generation.
font Font to use for generation.
fontSize Font size.
fontStyle Font style.
generateOutOfBounds Continue to generate characters even if the text runs out of bounds.
generationExtents Extents that the generator will attempt to fit the text in.
horizontalOverflow What happens to text when it reaches the horizontal generation bounds.
lineSpacing The line spacing multiplier.
pivot Generated vertices are offset by the pivot.
resizeTextForBestFit Should the text be resized to fit the configured bounds?
resizeTextMaxSize Maximum size for resized text.
resizeTextMinSize Minimum size for resized text.
richText Allow rich text markup in generation.
textAnchor How is the generated text anchored.
updateBounds Should the text generator update the bounds from the generated text.
verticalOverflow What happens to text when it reaches the bottom generation bounds.