Vegetation Layer Blocker Component

Create an area where dynamic vegetation cannot spawn with the Vegetation Layer Blocker component.

Provider

Vegetation Gem

Dependencies

Add the following required components when using the Vegetation Layer Blocker component:

Vegetation Layer Blocker properties

Vegetation Layer Blocker component properties

PropertyDescriptionValuesDefault
Override Preview SettingsIf Enabled, the Preview Settings properties determine the shape of the blocker. If Disabled, the bounds of the blocker are set by the attached Shape component.BooleanDisabled
Pin Preview to ShapeSets an entity with a compatible shape component to use as the bounds of the blocker 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 blocker.

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 blocker 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 blocker 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 and blockers are applied.Background or ForegroundForeground
Sub PriorityDefines the order that vegetation areas or blockers are applied within a layer. Larger numbers have a higher priority.0-1000010000
Inherit BehaviorAllow shapes, modifiers and filters of a parent entity to affect this vegetation layer.BooleanEnabled

BlockerRequestBus

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

Method NameDescriptionParameterReturnScriptable
GetAreaLayerReturns the Layer Priority of a blocker. Returns 0 for Background and 1 for Foreground.NoneLayer Priority: IntegerYes
GetAreaPriorityReturns the Sub Priority of a blocker.NoneSub Priority: IntegerYes
GetAreaProductCountReturns the number of vegetation instances spawned in a blocker’s vegetation area.NoneCount: IntegerYes
GetInheritBehaviorReturns the configuration of a blocker’s Inherit Behavior property.NoneBooleanYes
SetAreaLayerSets the Layer Priority of a blocker. Returns 0 for Background and 1 for Foreground.Layer Priority: IntegerNoneYes
SetAreaPrioritySets the Sub Priority of a blocker.Sub Priority: IntegerNoneYes
SetInheritBehaviorSets the configuration of a blocker’s Inherit Behavior property.BooleanNoneYes

Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.