Vegetation Slope Alignment Modifier Component

Use the Slope Alignment Modifier component to align the orientation of vegetation or blocker instances with the underlying terrain. Use gradients to control and vary vegetation alignment. By default, this component is configured to always completely align a vegetation instance to the slope of the terrain. By setting the alignment coefficients to values less than 1, instances will only partially align with terrain.

Provider

Vegetation Gem

Dependencies

Add one of the following required components when using the Vegetation Slope Alignment Modifier component:

Vegetation Slope Alignment Modifier properties

Vegetation Slope Alignment Modifier component properties

PropertyDescriptionValuesDefault
Allow Per-Item OverridesIf Enabled, vegetation descriptor properties that are enabled can override this component’s properties.BooleanDisabled
Alignment Coefficient MinSets the minimum slope alignment coefficient.Float: 0.0 - 11.0
Alignment Coefficient MaxSets the maximum slope alignment coefficient.Float: 0.0 - 11.0
GradientRefer to Gradient properties below.

Gradient properties

Gradient properties

PropertyDescriptionValuesDefault
Gradient Entity IdSets an entity with an active Gradient component.EntityNone
OpacitySets the opacity of the input gradient.Float: 0.0 - 1.01.0
Invert InputInverts the values of the input gradient.BooleanDisabled
Preview (Inbound)Displays the gradient provided by the entity set in Gradient Entity Id.
Enable TransformIf Enabled, the translation, scale, and rotation of the input gradient may be modified.BooleanDisabled
TranslateSets the translation of the input gradient.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
ScaleSets the scale of the input gradient.Vector3: 0.0 to InfinityX:1.0, Y:1.0, Z:1.0
RotateSets the rotation of the input gradient.Vector3: -Infinity to InfinityX:0.0, Y:0.0, Z:0.0
Enable LevelsIf Enabled, the input and output values of the gradient may be modified.BooleanDisabled
Input MidSets the median value of the input gradient.Float: 0.0 - 1.01.0
Input MinSets a minimum value for the input gradient.Float: 0.0 - 1.00.0
Input MaxSets a maximum value for the input gradient.Float: 0.0 - 1.01.0
Output MinSets a minimum value for the output gradient.Float: 0.0 - 1.00.0
Output MaxSets a maximum value for the output gradient.Float: 0.0 - 1.01.0

SlopeAlignmentModifierRequestBus

Use the following request functions with the SlopeAlignmentModifierRequestBus EBus interface to communicate with Vegetation Slope Alignment Modifier components in your game.

Method NameDescriptionParameterReturnScriptable
GetAllowOverridesReturns the configuration of the Allow Per-Item Overrides property.NoneBooleanYes
GetGradientSamplerReturns the gradient sampler object of the slope alignment modifier.NoneGradient SamplerYes
GetRangeMaxReturns the value of the Alignment Coefficient Max property.NoneFloatYes
GetRangeMinReturns the value of the Alignment Coefficient Min property.NoneFloatYes
SetAllowOverridesSets the configuration of the Allow Per-Item Overrides property.BooleanNoneYes
SetRangeMaxSets the Alignment Coefficient Max property.FloatNoneYes
SetRangeMinSets the Alignment Coefficient Min property.FloatNoneYes