Component:ValueTextFormatDriver: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Remove from category
 
(One intermediate revision by the same user not shown)
Line 8: Line 8:
}}
}}


'''ValueTextFormatDriver''' applies the value of a single source field to a [https://docs.microsoft.com/en-us/dotnet/api/system.string.format?view=net-5.0#get-started-with-the-stringformat-method text format string] and drives the target string field. The source field is element 0 in the format string. Although the image shown and the field list below have the source field being a float, this component is generic, so any field type (that can be converted to a string) can be used.
'''ValueTextFormatDriver''' applies the value of a single source field to a [https://docs.microsoft.com/en-us/dotnet/api/system.string.format?view=net-5.0#get-started-with-the-stringformat-method text format string] and drives the target string field. The source field is element 0 in the format string. Elements are defined by putting {} brackets around a number. Although the image shown and the field list below have the source field being a float, this component is generic, so any field type (that can be converted to a string) can be used.


<!--T:2-->
<!--T:2-->
Line 14: Line 14:
{{Table ComponentFields
{{Table ComponentFields
|Source|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv0=true| The source field for the value.
|Source|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv0=true| The source field for the value.
|Format|String| The string format.
|Format|String| The string format with "{0}" in it somewhere
|Text|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv2=true| The target field.
|Text|{{RootFieldType|FieldDrive`1|[[Type:String|String]]}}|TypeAdv2=true| The target field.
}}
}}
Line 30: Line 30:


</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Value Text Format Driver`1]]
[[Category:Components{{#translation:}}|Value Text Format Driver`1]]
[[Category:Generic Components{{#translation:}}|Value Text Format Driver`1]]
[[Category:Generic Components{{#translation:}}|Value Text Format Driver`1]]
[[Category:Components:Utility{{#translation:}}|Value Text Format Driver`1]]
[[Category:Components:Utility{{#translation:}}|Value Text Format Driver`1]]

Latest revision as of 04:24, 7 November 2024


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


Component image 
Value Text Format Driver`1 component as seen in the Scene Inspector


ValueTextFormatDriver applies the value of a single source field to a text format string and drives the target string field. The source field is element 0 in the format string. Elements are defined by putting {} brackets around a number. Although the image shown and the field list below have the source field being a float, this component is generic, so any field type (that can be converted to a string) can be used.

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.
Source direct RelayRef`1<IField`1<T>> The source field for the value.
Format String The string format with "{0}" in it somewhere
Text field drive of String The target field.

Usage

Examples

Related Components