Component:BoxConstantReferenceSpatialVariable: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Box Constant Reference Spatial Variable`1
|Name=Box Constant Reference Spatial Variable`1
}}
}}
The '''Box Constant Reference Spatial Variable`1''' component
The '''Box Constant Reference Spatial Variable`1''' component provides a constant value regardless of position inside of it as a contribution to a [[Spatial variables]] system.
{{stub}}


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|VariableName|String|
|VariableName|String| {{SpatialVariables_VariableName}}
|Priority|Int|
|Priority|Int| {{SpatialVariables_Priority}}
|Size|Float3|
|Size|Float3| How big the box is for the area of influence.
|BlendDistance|Float|
|BlendDistance|Float| {{SpatialVaraibles_BlendDistance}}
|BlendDistanceMode|SpatialVariableBlendDistanceMode|
|BlendDistanceMode|SpatialVariableBlendDistanceMode| {{SpatialVariables_BlendDistanceMode}}
|Reference|'''T'''|TypeAdv5=true|
|Reference|'''T'''|TypeAdv5=true| {{SpatialVariables_Value_Reference}}
}}
}}


== Usage ==
== Usage ==
Attach to a slot and provide a size and variable name in order for this to function.


== Examples ==
== Examples ==
{{stub}}


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


[[Category:Components:Data:Spatial:Box Variables{{#translation:}}|Box Constant Reference Spatial Variable`1]]
[[Category:Components:Data:Spatial:Box Variables{{#translation:}}|Box Constant Reference Spatial Variable`1]]
[[Category:Components{{#translation:}}|Box Constant Reference Spatial Variable`1]]
[[Category:Components{{#translation:}}|Box Constant Reference Spatial Variable`1]]
[[Category:Generic Components{{#translation:}}|Box Constant Reference Spatial Variable`1]]
[[Category:Generic Components{{#translation:}}|Box Constant Reference Spatial Variable`1]]
[[Category:ComponentStubs]]

Latest revision as of 05:20, 9 May 2025

Component image 
File:BoxConstantReferenceSpatialVariable`1Component.png
Box Constant Reference Spatial Variable`1 component as seen in the Scene Inspector

The Box Constant Reference Spatial Variable`1 component provides a constant value regardless of position inside of it as a contribution to a Spatial variables system.

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.
VariableName String The name of the variable this has within it's field of influence for the Spatial variables system.
Priority Int The priority this spatial variable has other others overlapping in the same space for the Spatial variables system.
Size Float3 How big the box is for the area of influence.
BlendDistance Float
BlendDistanceMode SpatialVariableBlendDistanceMode The mode used for blending the value with other variables for the Spatial variables system.
Reference T The value this spatial variable gives when sampled at 100%.

Usage

Attach to a slot and provide a size and variable name in order for this to function.

Examples

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

See Also