Component:MultiValueTextFormatDriver: Difference between revisions

From Resonite Wiki
Automated: update Fields
Add info, no longer stub
 
Line 8: Line 8:
}}
}}


'''MultiValueTextFormatDriver''' applies the values of source fields 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 fields are the numeric elements specified in the format string.
'''MultiValueTextFormatDriver''' applies the values of source fields 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 fields are the numeric elements specified in the format string.  


<!--T:2-->
<!--T:2-->
Line 14: Line 14:
{{Table ComponentFields
{{Table ComponentFields
|Sources|{{RootFieldType|SyncRelayList`1|[[Type:IField|IField]]}}|TypeAdv0=true| A list of source fields.
|Sources|{{RootFieldType|SyncRelayList`1|[[Type:IField|IField]]}}|TypeAdv0=true| A list of source fields.
|Format|String| The format string.
|Format|String| The format string, which has a list of "{X}" where "X" is a number that refers to an item number in <code>Sources</code>. The entire "{X}" gets replaced by a source with that number.
|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 29: Line 29:
* [[ValueTextFormatDriver (Component)|ValueTextFormatDriver]]<T> when there is a single source.
* [[ValueTextFormatDriver (Component)|ValueTextFormatDriver]]<T> when there is a single source.
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Multi Value Text Format Driver]]
[[Category:Components{{#translation:}}|Multi Value Text Format Driver]]
[[Category:Components:Utility{{#translation:}}|Multi Value Text Format Driver]]
[[Category:Components:Utility{{#translation:}}|Multi Value Text Format Driver]]

Latest revision as of 04:28, 7 November 2024


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


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


MultiValueTextFormatDriver applies the values of source fields to a text format string and drives the target string field. The source fields are the numeric elements specified in the format string.

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.
Sources direct SyncRelayList`1<IField> A list of source fields.
Format String The format string, which has a list of "{X}" where "X" is a number that refers to an item number in Sources. The entire "{X}" gets replaced by a source with that number.
Text field drive of String The target field.

Usage

Examples

Related Components