This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Vegetation Shape Intersection Filter Component

Add the Vegetation Shape Intersection Filter component to contain vegetation or blocker instance placement within the bounds of a Shape component.

Provider

Vegetation Gem

Dependencies

Add one of the following required components when using the Vegetation Shape Intersection Filter component:

Vegetation Shape Intersection Filter properties

Vegetation Shape Intersection Filter component properties

PropertyDescriptionValuesDefault
Filter StageDefines if filters are applied before or after modifiers.PreProcess, PostProcess, or DefaultDefault
Shape Entity IdSelects an entity with a shape component. Instances are placed only within the bounds of the shape.EntityIdNone

ShapeIntersectionFilterRequestBus

Use the following request functions with the ShapeIntersectionFilterRequestBus EBus interface to communicate with Vegetation Shape Intersection Filter components in your game.

Method NameDescriptionParameterReturnScriptable
GetShapeEntityIdReturns the Shape Entity Id property of a Shape Intersection Filter.NoneEntityIdYes
SetShapeEntityIdSets the Shape Entity Id property of a Shape Intersection Filter.EntityIdNoneYes