Vegetation Scale Modifier Component

Add variation to the vegetation instances in your level with the Vegetation Scale Modifier component. Use gradients to control how vegetation or blocker instances individually scale. By default, this component is configured to scale the vegetation instance by the same value, 1. Change the values of Range Min or Range Max to values that are appropriate for the mesh instances you are modifying.

Provider

Vegetation Gem

Dependencies

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

Vegetation Scale Modifier properties

Vegetation Scale Modifier component properties

PropertyDescriptionValuesDefault
Allow Per-Item OverridesIf Enabled, vegetation descriptor properties that are enabled can override this component’s properties.BooleanDisabled
Range MinSets the minimum modified scale of the vegetation instance.Float: 0.01 to Infinity1.0
Range MaxSets the maximum modified scale of the vegetation instance.Float: 0.01 to Infinity1.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

ScaleModifierRequestBus

Use the following request functions with the ScaleModifierRequestBus EBus interface to communicate with Vegetation Scale 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 scale modifier.NoneGradient SamplerYes
GetRangeMaxReturns the value of the Range Max property.NoneFloatYes
GetRangeMinReturns the value of the Range Min property.NoneFloatYes
SetAllowOverridesSets the configuration of the Allow Per-Item Overrides property.BooleanNoneYes
SetRangeMaxSets the Range Max property.FloatNoneYes
SetRangeMinSets the Range Min property.FloatNoneYes