Component:BoxGradientValueSpatialVariable

From Resonite Wiki
Component image 
File:BoxGradientValueSpatialVariable`1Component.png
Box Gradient Value Spatial Variable`1 component as seen in the Scene Inspector

The Box Gradient Value Spatial Variable`1 component is a Spatial variables variable where the value changes from Start to End value along a Direction. This works best when the direction is aligned with one of the cube's axes. Start value starts at the edge of the shape and goes inwards towards the center.

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 The size of the cube in which this variable can be sampled from.
BlendDistance Float How the gradient for this variable within it's volume determines the sampled value for the Spatial variables system.
BlendDistanceMode SpatialVariableBlendDistanceMode The mode used for blending the value with other variables for the Spatial variables system.
StartValue T The value this spatial variable gives when sampled at 0%.
EndValue T The value this spatial variable gives when sampled at 100%.
GradientDirection Float3 The direction the Gradient goes in local space to the Spatial variable.

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