Component:BooleanReferenceDriver: Difference between revisions

From Resonite Wiki
imported>Psychpsyo
Wrote Article.
 
Add info, remove stub
 
(3 intermediate revisions by 2 users not shown)
Line 14: Line 14:
{{Table ComponentFields
{{Table ComponentFields
|State|Bool| Determines whether TargetReference should be driven to TrueTarget or to FalseTarget.
|State|Bool| Determines whether TargetReference should be driven to TrueTarget or to FalseTarget.
|TargetReference|SyncRef`1|TypeString1=SyncRef<IWorldElement>| The field that should be driven.
|TargetReference|{{RootFieldType|RefDrive`1|T}}|TypeAdv1=true| The field that should be driven.
|FalseTarget|IWorldElement| The value that the field will be driven to if State is false.
|FalseTarget|'''T'''|TypeAdv2=true| The value that the field will be driven to if <code>State</code> is false.
|TrueTarget|IWorldElement| The value that the field will be driven to if State is true.
|TrueTarget|'''T'''|TypeAdv3=true| The value that the field will be driven to if <code>State</code> is true.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Attach this component to a slot by first choosing what kind of value you want to boolean switch. See [[Interface]] on how similar types can be used that are different classes (Like materials for example). Once a type has been chosen, this component can be used to switch the value in a field between two different ones using <code>State</code>


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Can be used as an alternative to [[Component:BooleanAssetDriver|Boolean Asset Driver]] to switch assets, and as a way of switching slot references around


<!--T:5-->
<!--T:5-->
== Related Issues ==
== Related Issues ==
[https://github.com/Neos-Metaverse/NeosPublic/issues/1360 <s>#1360 - Add BooleanReferenceDriver<T></s>]


<!--T:6-->
<!--T:6-->
== Related Components ==
== Related Components ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Generics{{#translation:}}]]
[[Category:Generics{{#translation:}}]]
[[Category:Components{{#translation:}}|Boolean Reference Driver`1]]
[[Category:Components{{#translation:}}|Boolean Reference Driver`1]]
[[Category:Generic Components{{#translation:}}|Boolean Reference Driver`1]]
[[Category:Components:Transform:Drivers{{#translation:}}|Boolean Reference Driver`1]]
[[Category:Components:Transform:Drivers{{#translation:}}|Boolean Reference Driver`1]]

Latest revision as of 12:51, 16 October 2024


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


Component image 
Boolean Reference Driver`1 component as seen in the Scene Inspector


The BooleanReferenceDriver component is used to drive a reference to one value or another, depending on its State field.

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.
State Bool Determines whether TargetReference should be driven to TrueTarget or to FalseTarget.
TargetReference direct RefDrive`1<T> The field that should be driven.
FalseTarget T The value that the field will be driven to if State is false.
TrueTarget T The value that the field will be driven to if State is true.

Usage

Attach this component to a slot by first choosing what kind of value you want to boolean switch. See Interface on how similar types can be used that are different classes (Like materials for example). Once a type has been chosen, this component can be used to switch the value in a field between two different ones using State

Examples

Can be used as an alternative to Boolean Asset Driver to switch assets, and as a way of switching slot references around

Related Issues

Related Components