Vegetation Layer Blender Component

Combine vegetation layers with the Vegetation Layer Blender component.

Provider

Vegetation Gem

Vegetation Layer Blender properties

Vegetation Layer Blender component properties

PropertyDescriptionValuesDefault
Override Preview SettingsIf Enabled, the Preview Settings properties determine the shape of the vegetation layer preview. If Disabled, the bounds of the vegetation layer preview are set by the Shape components of the vegetation layers selected in Vegetation Areas.BooleanDisabled
Pin Preview to ShapeSets an entity with a compatible shape component to use as the bounds of the vegetation layer preview if Constrain to Shape is Enabled.

This field is available only if Override Preview Settings is Enabled.
EntityIdCurrent Entity
Preview PositionSets the world location of the vegetation layer preview.

This field is available only if Override Preview Settings is Enabled and 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 vegetation layer preview if Constrain to Shape is Disabled.

This field is available only if Override Preview Settings is Enabled.
Vector3: 0.0 to InfinityX:1.0, Y:1.0, Z:1.0
Constrain to ShapeIf Enabled, the vegetation layer preview will use the bounds of the entity selected in Pin Preview to Shape.

This field is available only if Override Preview Settings is Enabled and an entity is selected in Pin Preview to Shape.
BooleanDisabled
Layer PriorityDefines a high level order that vegetation areas are applied.Background or ForegroundForeground
Sub PriorityDefines the order that vegetation areas are applied within a layer. Larger numbers have a higher priority.0-100000
Inherit BehaviorAllow shapes, modifiers and filters of a parent entity to affect this vegetation layer.BooleanEnabled
Propagate BehaviorAllow shapes, modifiers and filters of this vegetation layer to affect child entities.BooleanEnabled
Vegetation AreasAn ordered list of vegetation layers.Array: EntityIdNone

AreaBlenderRequestBus

Use the following request functions with the AreaBlenderRequestBus EBus interface to communicate with Vegetation Layer Blender components in your game.

Method NameDescriptionParameterReturnScriptable
AddAreaEntityIdAdds a vegetation layer to a Vegetation Areas array.EntityIdNoneYes
GetAreaEntityIdReturns the EntityId of an entry in a Vegetation Areas array at the specified index.Vegetation Areas Index: IntegerEntityIdYes
GetAreaLayerReturns the Layer Priority of a layer blender. Returns 0 for Background and 1 for Foreground.NoneLayer Priority: IntegerYes
GetAreaPriorityReturns the Sub Priority of a layer blender.NoneSub Priority: IntegerYes
GetAreaProductCountReturns the number of vegetation instances spawned in a layer blender’s vegetation area.NoneCount: IntegerYes
GetInheritBehaviorReturns the configuration of a layer blender’s Inherit Behavior property.NoneBooleanYes
GetNumAreasReturns the number of entries in a layer blender’s Vegetation Areas array.NoneCount: IntegerYes
GetPropagateBehaviorReturns the configuration of a layer blender’s Propagate Behavior property.NoneBooleanYes
RemoveAreaEntityIdRemoves a vegetation layer from the Vegetation Areas array of a layer blender.Vegetation Areas Index: IntegerNoneYes
SetAreaLayerSets the Layer Priority of layer blender.Layer Priority: IntegerNoneYes
SetAreaPrioritySets the Sub Priority of a layer blender.Sub Priority: IntegerNoneYes
SetInheritBehaviorSets the Inherit Behavior property of a layer blender.BooleanNoneYes
SetPropagateBehaviorSets the Propagate Behavior property of a layer blender.BooleanNoneYes