Difference between revisions of "ValueEqualityDriver (Component)"

From Neos Wiki
Jump to navigation Jump to search
(Added most field descriptions & related issues section)
 
Line 7: Line 7:
 
|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.
  
 
<!--T:2-->
 
<!--T:2-->
 
== Fields ==
 
== Fields ==
 
{{Table ComponentFields
 
{{Table ComponentFields
|TargetValue|IField`1|TypeString0=IField<float>|
+
|TargetValue|IField`1|TypeString0=IField<float>| The value being compared to <code>Reference</code>.
|Reference|Float|
+
|Reference|Float| The value that <code>TargetValue</code> is being compared to.
|Target|IField`1|TypeString2=IField<bool>|
+
|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.
|UseApproximateComparison|Bool|
+
|UseApproximateComparison|Bool| Whether or not to use approximate comparison for types such as float, where values that seem identical can be very slightly different.
 
}}
 
}}
  
Line 25: Line 27:
  
 
<!--T:5-->
 
<!--T:5-->
 +
== Related Issues ==
 +
[https://github.com/Neos-Metaverse/NeosPublic/issues/724 <s>#724 - Creating a ValueEqualityDriver component of type Slot instantly crashes the program</s>]
 +
 +
[https://github.com/Neos-Metaverse/NeosPublic/issues/896 <s>#896 - Floating point percision breaks the Value Equality drive</s>]
 +
 +
[https://github.com/Neos-Metaverse/NeosPublic/issues/1066 #1066 - Request: Re-Categorize These to Relations]
 +
 +
[https://github.com/Neos-Metaverse/NeosPublic/issues/3173 #3173 - Make "UseApproximateComparison" more approximate for ValueEqualityDriver<float>]
 +
 +
<!--T:6-->
 
== Related Components ==
 
== Related Components ==
 
</translate>
 
</translate>

Latest revision as of 03:27, 29 December 2021


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


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 IField<float> The value being compared to Reference.
Reference Float The value that TargetValue is being compared to.
Target IField<bool> The boolean that is driven to true if TargetValue is equal to Reference 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.

Usage

Examples

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

Related Issues

#724 - Creating a ValueEqualityDriver component of type Slot instantly crashes the program

#896 - Floating point percision breaks the Value Equality drive

#1066 - Request: Re-Categorize These to Relations

#3173 - Make "UseApproximateComparison" more approximate for ValueEqualityDriver<float>

Related Components