Component:ValueEqualityDriver: Difference between revisions

From Resonite Wiki
No edit summary
Add related
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=ValueEqualityDriver`1Component.png
|Image=ValueEqualityDriver`1Component.png
|Name=Value Equality Driver`1
|Name=Value Equality Driver`1
}}
}}
 
The '''ValueEqualityDriver''' component lets you drive a boolean to whether or not one value is equal to another.
The ValueEqualityDriver component lets you drive a boolean to whether or not one value is equal to another.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetValue|IField`1|TypeString0=IField<float>| The value being compared to <code>Reference</code>.
|TargetValue|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv0=true| The value being compared to <code>Reference</code>.
|Reference|Float| The value that <code>TargetValue</code> is being compared to.
|Reference|'''T'''|TypeAdv1=true| The value that <code>TargetValue</code> is being compared to.
|Target|IField`1|TypeString2=IField<bool>| The boolean that is driven to true if <code>TargetValue</code> is equal to <code>Reference</code> and false if it isn't.
|Target|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| The boolean that is driven to true if <code>TargetValue</code> is equal to <code>Reference</code> and false if it isn't.
|UseApproximateComparison|Bool| Whether or not to use approximate comparison for types such as float, where values that seem identical can be very slightly different.  
|Invert|Bool| Whether to invert the result of <code>TargetValue</code>
|UseApproximateComparison|Bool| Whether or not to use approximate comparison for types such as float, where values that seem identical can be very slightly different.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Use to drive the target boolean with whether the target's value is equal to the reference value.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Drives the target boolean with whether the target's value is equal to the reference value.
{{stub}}
 
<!--T:5-->
== Related Issues ==


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
* [[Component:ReferenceEqualityDriver]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Value Equality Driver`1]]
[[Category:Components{{#translation:}}|Value Equality Driver`1]]
[[Category:Generic Components{{#translation:}}|Value Equality Driver`1]]
[[Category:Components:Transform:Drivers{{#translation:}}|Value Equality Driver`1]]
[[Category:Components:Transform:Drivers{{#translation:}}|Value Equality Driver`1]]

Latest revision as of 03:13, 13 November 2024

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

The ValueEqualityDriver component lets you drive a boolean to whether or not one value is equal to another.

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.
TargetValue direct RelayRef`1<IField`1<T>> The value being compared to Reference.
Reference T The value that TargetValue is being compared to.
Target field drive of Bool The boolean that is driven to true if TargetValue is equal to Reference and false if it isn't.
Invert Bool Whether to invert the result of TargetValue
UseApproximateComparison Bool Whether or not to use approximate comparison for types such as float, where values that seem identical can be very slightly different.

Usage

Use to drive the target boolean with whether the target's value is equal to the reference value.

Examples

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


See Also