imported>Psychpsyo Added some field descriptions. |
Cleanup. This is no longer a stub. moved the old description to the usage description, gave this page a new description, added field descriptions. |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=FloatTextEditorParserComponent.png | |Image=FloatTextEditorParserComponent.png | ||
|Name=Float Text Editor Parser | |Name=Float Text Editor Parser | ||
}} | }} | ||
The '''FloatTextEditorParser''' 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|Float| The value that was read from the text field. | |ParsedValue|Float| The value that was read from the text field. | ||
|Min|Float| The minimum value that can be read. | |Min|Float| The minimum value that can be read. | ||
|Max|Float| The maximum value that can be read. | |Max|Float| The maximum value that can be read. | ||
|DecimalPlaces|Int| The amount of decimal places that can be read. | |DecimalPlaces|Int| The amount of decimal places that can be read. | ||
|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 Float and output via the ParsedValue field. | |||
<!--T:4--> | <!--T:4--> | ||
Line 28: | Line 30: | ||
<!--T:5--> | <!--T:5--> | ||
== Related Issues == | == Related Issues == | ||
<!--T:6--> | <!--T:6--> | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Float Text Editor Parser]] | [[Category:Components{{#translation:}}|Float Text Editor Parser]] | ||
[[Category:Components:Common UI:Editors{{#translation:}}|Float Text Editor Parser]] | [[Category:Components:Common UI:Editors{{#translation:}}|Float Text Editor Parser]] |
Latest revision as of 22:51, 12 September 2024
Component image
The FloatTextEditorParser 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
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
|
Float | The value that was read from the text field. |
Min
|
Float | The minimum value that can be read. |
Max
|
Float | The maximum value that can be read. |
DecimalPlaces
|
Int | The amount of decimal places that can be read. |
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 Float and output via the ParsedValue field.