TextRendererComponent

Displays text in the world space. Use it in conjunction with TransformComponent.

# Properties

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

[{"index":"boolean BestFit (Sync)","0":"Adjusts the font size to fit the area size."}]

[{"index":"Color BottomLeftColor (Sync)","0":"The color on the bottom left."}]

[{"index":"Color BottomRightColor (Sync)","0":"The color on the bottom right."}]

[{"index":"boolean ColorGradient (Sync)","0":"Applies a gradient color to the letter. The letter color displayed will be multiplied by the gradient color applied."}]

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

[{"index":"float ConstraintY (Sync)","0":"Sets the maximum height as the 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 (Sync)","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 (Sync)","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 (Sync)","0":"Sets the font."}]

[{"index":"Color FontColor (Sync)","0":"The color in which to render the text."}]

[{"index":"float FontSize (Sync)","0":"The font size."}]

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

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

[{"index":"TextHorizontalAlignmentOption HorizontalAlignment (Sync)","0":"How to align horizontal text."}]

[{"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 that matches the current language settings in LocaleDataSet. Text property value will be used as a key. The Text property itself does not change."}]

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

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

[{"index":"float MinSize (Sync)","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 (Sync)","0":"Sets the outline color."}]

[{"index":"float OutlineWidth (Sync)","0":"Sets the thickness of the border."}]

[{"index":"TextOverflowMode Overflow (Sync)","0":"Determines what to do when the text exceeds the text box's width."}]

[{"index":"RectOffset Padding (Sync)","0":"Sets the margins for the text area."}]

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

[{"index":"Vector2 RectOffset (Sync)","0":"A base point of the text box."}]

[{"index":"Vector2 RectSize (Sync)","0":"The size of the text box."}]

[{"index":"boolean SizeFit (Sync)","0":"Resizes the text box to fit the text."}]

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

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

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

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

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

[{"index":"Color TopLeftColor (Sync)","0":"The color on the top left."}]

[{"index":"Color TopRightColor (Sync)","0":"The color on the top right."}]

[{"index":"boolean Underlay (Sync)","0":"Creates a shadow behind the letter."}]

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

[{"index":"float UnderlayDilate (Sync)","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 (Sync)","0":"Sets the X axis location of the shadow."}]

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

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

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

[{"index":"boolean UseConstraintY (Sync)","0":"Sets the height limit using the ConstraintY value."}]

[{"index":"TextVerticalAlignmentOption VerticalAlignment (Sync)","0":"How to align vertical text."}]

[{"index":"boolean Wrapping (Sync)","0":"Creates a line break."}]

##### 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 appears in 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."}]