Surface Mask Gradient Component

Add the Surface Mask Gradient component to generate a normalized gradient from a list of surface tags. The corresponding surface mask weights are used to generate the output gradient.

Provider

Gradient Signal Gem

Surface Mask Gradient properties

Surface Mask 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
Surface Tag ListAn array of surface tags to generate a gradient for.Array: Surface TagsNone

SurfaceMaskGradientRequestBus

Use the following request functions with the SurfaceMaskGradientRequestBus EBus interface to communicate with Surface Mask Gradient components in your game.

Request NameDescriptionParameterReturnScriptable
AddTagAdds a surface tag to the Surface Tag List array.Surface Tag: StringNoneYes
GetNumTagsReturns the number of tags in the Surface Tag List array.NoneCount: IntegerYes
GetTagReturns the surface tag at the specified index of the Surface Tag List array.Surface Tag Index: IntegerSurface Tag: StringYes
RemoveTagRemoves the surface tag at the specified index of the Surface Tag List array.Surface Tag Index: IntegerNoneYes