Altitude Gradient Component

Add the Altitude Gradient component to generate a normalized gradient from an altitude range. The output gradient may be optionally constrained by surface tags.

Provider

Gradient Signal Gem

Altitude Gradient properties

Altitude 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
Altitude MinSets the minimum altitude that generates gradient values.Float: -Infinity to Infinity0.0
Altitude MaxSets the maximum altitude that generates gradient values.Float: -Infinity to Infinity128.0
Surface Tags to trackAn optional array of surface tags. This component generates a gradient only where these surface tags exist.Array: Surface TagsNone

SurfaceAltitudeGradientRequestBus

Use the following request functions with the SurfaceAltitudeGradientRequestBus EBus interface to communicate with Altitude Gradient components in your game.

Request NameDescriptionParameterReturnScriptable
AddTagAdds a surface tag to the Surface Tags to track array.Surface Tag: StringNoneYes
GetAltitudeMaxReturns the value of the Altitude Max property.NoneAltitude: FloatYes
GetAltitudeMinReturns the value of the Altitude Min property.NoneAltitude: FloatYes
GetNumTagsReturns the number of tags in the Surface Tags to track array.NoneCount: IntegerYes
GetShapeEntityIdReturns the value of the Pin Preview to Shape property.NoneEntityIdYes
GetTagReturns the surface tag at the specified index of the Surface Tags to track array.Surface Tag Index: IntegerSurface Tag: StringYes
RemoveTagRemoves the surface tag at the specified index of the Surface Tags to track array.Surface Tag Index: IntegerNoneYes
SetAltitudeMaxSets the value of the Altitude Max property.Altitude: FloatNoneYes
SetAltitudeMinSets the value of the Altitude Min property.Altitude: FloatNoneYes
SetShapeEntityIdSets the value of the Pin Preview to Shape property.EntityIdNoneYes