Vegetation Layer Blocker (Mesh) Component

Create an area around a mesh or actor where dynamic vegetation cannot spawn with the Vegetation Layer Blocker (Mesh) component.

Provider

Vegetation Gem

Dependencies

Add one of the following required components when using the Vegetation Layer Blocker (Mesh) component:

  • A Mesh component or an Actor component, to define the blocker’s area.

Vegetation Layer Blocker (Mesh) properties

Vegetation Layer Blocker (Mesh) 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 Mesh or Actor 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
Mesh Height Percent MinSets the percentage of the mesh height (from the bottom up) used to determine the lower bound for intersection tests.Float: 0.0 - 1.00.0
Mesh Height Percent MaxSets the percentage of the mesh height (from the bottom up) used to determine the upper bound for intersection tests.Float: 0.0 - 1.01.0
Block When InvisibleIf Disabled, the blocker will only block vegetation if the Mesh or Actor component is visible.BooleanEnabled
Draw Debug BoundsDraw the mesh height bounds.BooleanDisabled

MeshBlockerRequestBus

Use the following request functions with the MeshBlockerRequestBus EBus interface to communicate with Vegetation Layer Blocker (Mesh) components in your game.

Method NameDescriptionParameterReturnScriptable
GetAreaLayerReturns the Layer Priority of a mesh blocker. Returns 0 for Background and 1 for Foreground.NoneLayer Priority: IntegerYes
GetAreaPriorityReturns the Sub Priority of a mesh blocker.NoneSub Priority: IntegerYes
GetAreaProductCountReturns the number of vegetation instances spawned in a mesh blocker’s vegetation area.NoneCount: IntegerYes
GetBlockWhenInvisibleReturns the configuration of a mesh blocker’s Block When Invisible property.NoneBooleanYes
GetInheritBehaviorReturns the configuration of a mesh blocker’s Inherit Behavior property.NoneBooleanYes
GetMeshHeightPercentMaxReturns the Mesh Height Percent Max property of a mesh blocker.NoneHeight Ratio: FloatYes
GetMeshHeightPercentMinReturns the Mesh Height Percent Min property of a mesh blocker.NoneHeight Ratio: FloatYes
SetAreaLayerSets the Layer Priority of a mesh blocker. Returns 0 for Background and 1 for Foreground.Layer Priority: IntegerNoneYes
SetAreaPrioritySets the Sub Priority of a mesh blocker.Sub Priority: IntegerNoneYes
SetBlockWhenInvisibleSets the configuration of a mesh blocker’s Block When Invisible property.BooleanNoneYes
SetInheritBehaviorSets the configuration of a mesh blocker’s Inherit Behavior property.BooleanNoneYes
SetMeshHeightPercentMaxSets the Mesh Height Percent Max property of a mesh blocker.Height Ratio: FloatNoneYes
SetMeshHeightPercentMinSets the Mesh Height Percent Min property of a mesh blocker.Height Ratio: FloatNoneYes