TextGUIRendererComponent

Displays the text on the screen. We recommend you use it in conjunction with UITransformComponent.

# Properties

[{"index":"boolean AllowAutomaticTranslation (MakerOnly)","0":"Sets whether to automatically translate the value of the Text property."}]

[{"index":"boolean BestFit","0":"Adjust the font size to fit the area size."}]

[{"index":"Color BottomLeftColor","0":"This is the lower left color."}]

[{"index":"Color BottomRightColor","0":"This is the lower right color."}]

[{"index":"boolean ColorGradient","0":"Applies a color gradient to the text. Color gradients are multiplied by the text color."}]

[{"index":"float ConstraintX","0":"Sets the maximum width to limit. Operates when sizefit is true."}]

[{"index":"float ConstraintY","0":"Sets the maximum height to limit. Operates when sizefit is true."}]

[{"index":"boolean EnableProfanityFilter (MakerOnly)","0":"Sets whether a banned words filter will be applied to the Text property."}]

[{"index":"float FaceDilate","0":"Sets the thickness of a text outline. Negative values make it thinner, while positive values make it thicker. When the value is 0, the text and outline will be the same."}]

[{"index":"float FaceSoftness","0":"Sets the softness of the corners of text and outlines. The higher the value, the softer and more blurred the corners."}]

[{"index":"string Font","0":"Sets the font."}]

[{"index":"Color FontColor","0":"The color to use to render the text."}]

[{"index":"float FontSize","0":"Font size."}]

[{"index":"FontStyleType FontStyle","0":"This is a style that's being applied to the text."}]

[{"index":"GradientModes GradientMode","0":"Selects the gradient type to be applied."}]

[{"index":"TextHorizontalAlignmentOption HorizontalAlignment","0":"This is the text's horizontal alignment."}]

[{"index":"boolean IgnoreMapLayerCheck (Sync)","0":"Does not perform automatic substitution when the Map Layer's name is specified in SortingLayer."}]

[{"index":"boolean IsLocalizationKey (MakerOnly)","0":"If true, finds and displays the text matching the current language settings in LocaleDataSet. Text's property value is used as a key. The actual value of the text property does not change."}]

[{"index":"boolean IsRichText","0":"Sets whether to use rich text."}]

[{"index":"float MaxSize","0":"Determines the maximum font size."}]

[{"index":"float MinSize","0":"Determines the minimum font size."}]

[{"index":"int32 OrderInLayer (Sync)","0":"Determines the priority within the same layer. A higher number indicates higher priority."}]

[{"index":"Color OutlineColor","0":"Sets the outline color."}]

[{"index":"float OutlineWidth","0":"Sets the outline thickness."}]

[{"index":"TextOverflowMode Overflow","0":"Sets the handling method for when the text exceeds the horizontal area."}]

[{"index":"boolean OverrideSorting (Sync) (ReadOnly)","0":"Determines whether to set the SortingLayer and OrderInLayer values manually."}]

[{"index":"RectOffset Padding","0":"Sets the margin of the text area."}]

[{"index":"int32 Page","0":"Displays the text across multiple pages."}]

[{"index":"boolean SizeFit","0":"Resizes the text area to fit the text."}]

[{"index":"string SortingLayer (Sync)","0":"When two or more entities overlap, the priority is determined according to the Sorting Layer."}]

[{"index":"TextRendererSpacingOption SpacingOption","0":"Sets the spacing options."}]

[{"index":"string Text","0":"The content to be displayed."}]

[{"index":"string TextSpriteSetId","0":"This is the Id of the TextSpriteSet entry that will be applied to text."}]

[{"index":"string TextStyleSheetId","0":"This is the Id of the TextStyleSheet entry that will be applied to text."}]

[{"index":"Color TopLeftColor","0":"This is the upper left color."}]

[{"index":"Color TopRightColor","0":"This is the upper right color."}]

[{"index":"boolean Underlay","0":"Sets whether a shadow will be applied."}]

[{"index":"Color UnderlayColor","0":"Sets the shadow color."}]

[{"index":"float UnderlayDilate","0":"Sets the thickness of a shadow outline. Negative values make it thinner, while positive values make it thicker. When the value is 0, the original font and outline will be the same."}]

[{"index":"float UnderlayOffsetX","0":"Sets the X axis location of the shadow."}]

[{"index":"float UnderlayOffsetY","0":"Sets the Y axis location of the shadow."}]

[{"index":"float UnderlaySoftness","0":"Sets the softness of the edges of shadows. The higher the value, the softer and more blurred the corners."}]

[{"index":"boolean UseConstraintX","0":"Sets the width to be limited using the ConstraintX value."}]

[{"index":"boolean UseConstraintY","0":"Sets the height to be limited using the ConstraintY value."}]

[{"index":"TextVerticalAlignmentOption VerticalAlignment","0":"This is the text's vertical alignment."}]

##### inherited from Component:

[{"index":"boolean Enable (Sync)","0":"Checks whether Component is activated or not."}]

[{"index":"boolean EnableInHierarchy (ReadOnly) (HideFromInspector)","0":"Displays whether this Component is Enable in the hierarchy. If Entity Enable is false regardless of Component Enable, returns false."}]

[{"index":"Entity Entity (ReadOnly)","0":"The Entity that owns this component."}]

# Methods

[{"index":"string GetLocalizedText() (ClientOnly)","0":"Returns the text matching the current language settings in LocaleDataSet when IsLocalizationKey's value is true. A Key will be used as Text's property value. Returns Text's property value when IsLocalizationKey's value is false."}]

[{"index":"float GetPreferredHeight(string preferredText, float width) (ClientOnly) (Yield)","0":"Gets the height of the text area that is outputted to a fixed-width space."}]

[{"index":"float GetPreferredWidth(string preferredText) (ClientOnly) (Yield)","0":"Gets the width of the input text area."}]

##### inherited from Component:

[{"index":"boolean IsClient()","0":"Returns whether the current execution environment is a client or not."}]

[{"index":"boolean IsServer()","0":"Returns whether the current execution environment is a server or not."}]

# Events

[{"index":"OrderInLayerChangedEvent","0":"This event occurs when changing the Component's OrderInLayer."}]

[{"index":"SortingLayerChangedEvent","0":"This event occurs when changing the component's SortingLayer."}]