Component:IntTextEditorParser: Difference between revisions

From Resonite Wiki
imported>Psychpsyo
Added some field descriptions
 
This is no longer a stub. Moved old description to usage description, gave the page a new description, added field descriptions.
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages></languages>
<languages></languages>
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=IntTextEditorParserComponent.png
|Image=IntTextEditorParserComponent.png
|Name=Int Text Editor Parser
|Name=Int Text Editor Parser
}}
}}
The '''IntTextEditorParser''' component takes in a <code>ParsedValue</code> and if there is a [[Component:TextEditor|TextEditor]] on the same [[Slot|slot]], it will send the value through the text editor and into either a [[Component:Text|Text]] or a [[Component:TextRenderer|TextRenderer]] component.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ParseContinuously|Bool|
|ParseContinuously|Bool| If true, makes the value always update and parse. If false, it only updates when submitted.
|UpdateStringFromValue|Bool|
|UpdateStringFromValue|Bool| If true, will update the string value from this parsed value.
|ParsedValue|Int| The value that was read from the text field.
|ParsedValue|Int| The value that was read from the text field.
|Min|Int| The minimum value that can be read.
|Min|Int| The minimum value that can be read.
|Max|Int| The maximum value that can be read.
|Max|Int| The maximum value that can be read.
|Increments|Int|
|Increments|Int| The output value will round down to the nearest increment multiple of this value.
|StringFormat|String|
|StringFormat|String| Lets you format the string for the text output.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Place on the same [[Slot]] as a [[Component:TextEditor|TextEditor]] and anything entered into the text editor will be attempted to be parsed as a Int and output via the <code>ParsedValue</code> field.


<!--T:4-->
<!--T:4-->
Line 29: Line 33:
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Int Text Editor Parser]]
[[Category:Components{{#translation:}}|Int Text Editor Parser]]
[[Category:Components:Common UI:Editors{{#translation:}}|Int Text Editor Parser]]
[[Category:Components:Common UI:Editors{{#translation:}}|Int Text Editor Parser]]

Latest revision as of 22:58, 12 September 2024


Component image 
Int Text Editor Parser component as seen in the Scene Inspector


The IntTextEditorParser component takes in a ParsedValue and if there is a TextEditor on the same slot, it will send the value through the text editor and into either a Text or a TextRenderer component.

Fields

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.
ParseContinuously Bool If true, makes the value always update and parse. If false, it only updates when submitted.
UpdateStringFromValue Bool If true, will update the string value from this parsed value.
ParsedValue Int The value that was read from the text field.
Min Int The minimum value that can be read.
Max Int The maximum value that can be read.
Increments Int The output value will round down to the nearest increment multiple of this value.
StringFormat String Lets you format the string for the text output.

Usage

Place on the same Slot as a TextEditor and anything entered into the text editor will be attempted to be parsed as a Int and output via the ParsedValue field.

Examples

Related Components