Shape Falloff Gradient Component

Add the Shape Falloff Gradient component to generate a gradient of a shape surrounded by a configurable falloff.

Provider

Gradient Signal Gem

Shape Falloff Gradient properties

Shape Falloff Gradient component properties

PropertyDescriptionValuesDefault
PreviewDisplays the output gradient of this component after all properties are applied.
Pin Preview to ShapeSets an entity with a compatible Shape component to use as the bounds of the preview if Constrain to Shape is Enabled.EntityIdCurrent Entity
Preview PositionSets the world location of the preview.

This field is available only if there is no entity selected in Pin Preview to Shape.
Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Preview SizeSets the dimensions of the preview.Vector3: 0.0 to InfinityX:1.0, Y:1.0, Z:1.0
Constrain to ShapeIf Enabled, the gradient preview uses the bounds of the entity selected in Pin Preview to Shape.

This field is available only if an entity is selected in Pin Preview to Shape.
BooleanDisabled
Shape Entity IdSets the shape that this component will generate a falloff gradient around.EntityIdNone
Falloff WidthSets the maximum distance (in meters) of the falloff.Float: 0.0 - 100.01.0

ShapeAreaFalloffGradientRequestBus

Use the following request functions with the ShapeAreaFalloffGradientRequestBus EBus interface to communicate with Shape Falloff Gradient components in your game.

Request NameDescriptionParameterReturnScriptable
GetFalloffTypeReturns the value of the Falloff Type property.NoneFalloff Type Index: IntegerYes
GetFalloffWidthReturns the value of the Falloff Width property.NoneFloatYes
GetShapeEntityIdReturns the value of the Pin Preview to Shape property.NoneEntityIdYes
SetFalloffTypeSets the value of the Falloff Type property.Falloff Type Index: IntegerNoneYes
SetFalloffWidthSets the value of the Falloff Width property.FloatNoneYes
SetShapeEntityIdSets the value of the Pin Preview to Shape property.EntityIdNoneYes