Component:TextRenderer: Difference between revisions

From Resonite Wiki
Automated: update 'HighPriorityIntegration' description
Automated: update 'BakeMesh()' description
 
(4 intermediate revisions by the same user not shown)
Line 4: Line 4:
}}
}}
{{stub}}
{{stub}}
Tex renderer is a component that is used as the main part of a Basic, which is made via the create new menu using a [[DevTip]]


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|HighPriorityIntegration|Bool|{{Asset HighPriorityIntegration Field}}
|OverrideBoundingBox|Bool|
|OverrideBoundingBox|Bool| {{Template:Override Bounding Box}}
|OverridenBoundingBox|BoundingBox|
|OverridenBoundingBox|BoundingBox| {{Template:Overridden Bounding Box}}
|Profile|ColorProfile|
|Profile|ColorProfile| {{Template:ProceduralMeshColorProfile}}
|Font|{{RootFieldType|AssetRef`1|[[Type:FontSet|FontSet]]}}|TypeAdv4=true|
|Font|{{RootFieldType|AssetRef`1|[[Type:FontSet|FontSet]]}}|TypeAdv4=true| The font set to use to render the text. For example, Times new Roman, or Avali Scratch.
|Text|String|
|Text|String| The text to display. For example, "Hello world!"
|ParseRichText|Bool|
|ParseRichText|Bool| whether to Parse rich text demoniators like "<nowiki><b></nowiki>" for bold and "<nowiki><i></nowiki>" for itallic
|NullText|String|
|NullText|String| the text to display if <code>Text</code> is null. (Empty text doesn't count)
|Size|Float|
|Size|Float| how big to render the text as.
|HorizontalAlign|TextHorizontalAlignment|
|HorizontalAlign|TextHorizontalAlignment| How to align the text horizontally.
|VerticalAlign|TextVerticalAlignment|
|VerticalAlign|TextVerticalAlignment| how to align the text vertically.
|AlignmentMode|AlignmentMode|
|AlignmentMode|AlignmentMode| how to align the text within the bounding box
|Color|ColorX|
|Color|ColorX| what color to render the text in.
|Materials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv13=true|
|Materials|{{RootFieldType|SyncAssetList`1|[[Type:Material|Material]]}}|TypeAdv13=true| what materials to render the text as. Really only works with [[Component:TextUnlitMaterial|Unlit Text Material]] type.
|LineHeight|Float|
|LineHeight|Float|how much space each text line should take up
|Bounded|Bool|
|Bounded|Bool| whether to restrict the text within a certain area
|BoundsSize|Float2|
|BoundsSize|Float2| the area to use if <code>Bounded</code> is enabled.
|BoundsAlignment|Alignment|
|BoundsAlignment|Alignment| how to align the text to the bounds and therefore how to handle text that spills out.
|MaskPattern|String|
|MaskPattern|String| a string to replace every character in <code>Text</code> with when rendering. Useful for password fields.
|HorizontalAutoSize|Bool|
|HorizontalAutoSize|Bool| whether to scale the text to fit the bounds horizontally
|VerticalAutoSize|Bool|
|VerticalAutoSize|Bool| whether to scale the text to fit the bounds vertically
|CaretPosition|Int|
|CaretPosition|Int| Where the typing cursor position is within the text by character index.
|SelectionStart|Int|
|SelectionStart|Int| where the selection starts if the text is being edited currently.
|CaretColor|ColorX|
|CaretColor|ColorX| the color of the typing cursor
|SelectionColor|ColorX|
|SelectionColor|ColorX| the color of the typing selection.
|_legacyFontMaterial|'''[[Component:FontMaterial|FontMaterial]]'''|TypeAdv25=true|
|_legacyFontMaterial|'''[[Component:FontMaterial|FontMaterial]]'''|TypeAdv25=true|Internal.
|_legacyAlign|Alignment|
|_legacyAlign|Alignment|Internal.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|BakeMesh()|[[Type:Action|Action]]|{{Template:BakeMeshSyncMethod}}
}}
}}


Line 39: Line 45:


== Examples ==
== Examples ==
Used in the "Basic" and "Outlined" text objects in the create new menu using a [[DevTip]]. It's also useful in making physical UI's, and for signs. Anything generally text related that can be simple.


== See Also ==
== See Also ==
[[Component:Text|UIX Text]]


[[Category:Components:Rendering{{#translation:}}|Text Renderer]]
[[Category:Components:Rendering{{#translation:}}|Text Renderer]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Text Renderer]]
[[Category:Components{{#translation:}}|Text Renderer]]
[[Category:ComponentStubs]]

Latest revision as of 21:30, 6 November 2024

Component image 
Text Renderer component as seen in the Scene Inspector


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Tex renderer is a component that is used as the main part of a Basic, which is made via the create new menu using a DevTip

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
HighPriorityIntegration Bool If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
OverrideBoundingBox Bool Force the bounding box calculated from this component to use OverridenBoundingBox instead of calculating when requested.
OverridenBoundingBox BoundingBox the bounding box this component should say it has when OverrideBoundingBox is enabled. Useful for bounding box calculations with Flux, or changing the selection box for this component when rendered.
Profile ColorProfile The profile that the vertex colors for this mesh should be displayed in.
Font FontSet The font set to use to render the text. For example, Times new Roman, or Avali Scratch.
Text String The text to display. For example, "Hello world!"
ParseRichText Bool whether to Parse rich text demoniators like "<b>" for bold and "<i>" for itallic
NullText String the text to display if Text is null. (Empty text doesn't count)
Size Float how big to render the text as.
HorizontalAlign TextHorizontalAlignment How to align the text horizontally.
VerticalAlign TextVerticalAlignment how to align the text vertically.
AlignmentMode AlignmentMode how to align the text within the bounding box
Color ColorX what color to render the text in.
Materials list of Material what materials to render the text as. Really only works with Unlit Text Material type.
LineHeight Float how much space each text line should take up
Bounded Bool whether to restrict the text within a certain area
BoundsSize Float2 the area to use if Bounded is enabled.
BoundsAlignment Alignment how to align the text to the bounds and therefore how to handle text that spills out.
MaskPattern String a string to replace every character in Text with when rendering. Useful for password fields.
HorizontalAutoSize Bool whether to scale the text to fit the bounds horizontally
VerticalAutoSize Bool whether to scale the text to fit the bounds vertically
CaretPosition Int Where the typing cursor position is within the text by character index.
SelectionStart Int where the selection starts if the text is being edited currently.
CaretColor ColorX the color of the typing cursor
SelectionColor ColorX the color of the typing selection.
_legacyFontMaterial FontMaterial Internal.
_legacyAlign Alignment Internal.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
BakeMesh() Action Bake meshes is a sync method that creates a static mesh component with this component, replaces all references to this component with the static mesh component, then deletes this component.

Behavior

Examples

Used in the "Basic" and "Outlined" text objects in the create new menu using a DevTip. It's also useful in making physical UI's, and for signs. Anything generally text related that can be simple.

See Also

UIX Text