Component:BooleanSpatialVariableDriver: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Boolean Spatial Variable Driver
|Name=Boolean Spatial Variable Driver
}}
}}
The '''Boolean Spatial Variable Driver''' component
The '''Boolean Spatial Variable Driver''' component is specifically for boolean values, which combines all the found bool spatial values at given point
{{stub}}
 


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Drive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv0=true|
|Drive|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv0=true| The field to drive with the combined values of all the bools at the sampled slot point.
|VariableName|String|
|VariableName|String| The variable name to sample.
|Mode|BooleanSpatialVariableMode|
|Mode|BooleanSpatialVariableMode| How to aggrigate values to determine the final result.
|DefaultValue|Bool|
|DefaultValue|Bool| The value to default to when no value can be sampled.
}}
}}


== Usage ==
== Usage ==
attach to a slot for it to use as the sample point. then it will sample spatial areas around it to get it's value.


== Examples ==
== Examples ==


== See Also ==
== See Also ==
* [[Spatial variables]]


[[Category:Components:Data:Spatial:Samplers{{#translation:}}|Boolean Spatial Variable Driver]]
[[Category:Components:Data:Spatial:Samplers{{#translation:}}|Boolean Spatial Variable Driver]]
[[Category:Components{{#translation:}}|Boolean Spatial Variable Driver]]
[[Category:Components{{#translation:}}|Boolean Spatial Variable Driver]]
[[Category:ComponentStubs]]

Latest revision as of 04:24, 9 May 2025

Component image 
File:BooleanSpatialVariableDriverComponent.png
Boolean Spatial Variable Driver component as seen in the Scene Inspector

The Boolean Spatial Variable Driver component is specifically for boolean values, which combines all the found bool spatial values at given point


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. Some components stop their functionality when this field is disabled, but some don't.
Drive field drive of Bool The field to drive with the combined values of all the bools at the sampled slot point.
VariableName String The variable name to sample.
Mode BooleanSpatialVariableMode How to aggrigate values to determine the final result.
DefaultValue Bool The value to default to when no value can be sampled.

Usage

attach to a slot for it to use as the sample point. then it will sample spatial areas around it to get it's value.

Examples

See Also