Version:

# Vegetation Surface Mask Filter Component

Add the Vegetation Surface Mask Filter component to define vegetation and blocker placement areas with surface tags and weight ranges.

Vegetation Gem

## Dependencies

Add one of the following required components when using the Vegetation Surface Mask Filter component:

## Vegetation Surface Mask Filter properties

PropertyDescriptionValuesDefault
Filter StageDefines if filters are applied before or after modifiers.PreProcess, PostProcess, or DefaultDefault
Allow Per-Item OverridesIf Enabled, vegetation descriptor properties that are enabled can override this component’s properties.BooleanDisabled
Inclusion - Surface TagsAn array of surface tags that allow vegetation or blocker instance placement if the surface tag weight of the location is within the Inclusion - Weight properties.Array: Surface TagsNone
Inclusion - Weight MinSets the minimum weight of an Inclusion - Surface Tag that allows vegetation placement.Float: 0.0 - 1.00.1
Inclusion - Weight MaxSets the maximum weight of an Inclusion - Surface Tag that allows vegetation placement.Float: 0.0 - 1.01.0
Exclusion - Surface TagsAn array of surface tags that don’t allow vegetation or blocker instance placement if the surface tag weight of the location is within the Exclusion - Weight properties.Array: Surface TagsNone
Exclusion - Weight MinSets the minimum weight of an Exclusion - Surface Tag that blocks vegetation.Float: 0.0 - 1.00.1
Exclusion - Weight MaxSets the maximum weight of an Exclusion - Surface Tag that blocks vegetation.Float: 0.0 - 1.01.0

Use the following request functions with the SurfaceMaskFilterRequestBus EBus interface to communicate with Vegetation Surface Mask Filter components in your game.

Method NameDescriptionParameterReturnScriptable
AddExclusiveTagAdds a surface tag to the Exclusion - Surface Tags array.Surface Tag: StringNoneYes
AddInclusiveTagAdds a surface tag to the Inclusion - Surface Tags array.Surface Tag: StringNoneYes
GetAllowOverridesReturns the configuration of the Allow Per-Item Overrides property.NoneBooleanYes
GetNumExclusiveTagsReturns the number of surface tags in the Exclusion - Surface Tags array.NoneCount: IntegerYes
GetNumInclusiveTagsReturns the number of surface tags in the Inclusion - Surface Tags array.NoneCount: IntegerYes
GetExclusiveTagReturns the surface tag at the specified index of the Exclusion - Surface Tags array.Surface Tag Index: IntegerSurface Tag: StringYes
GetInclusiveTagReturns the surface tag at the specified index of the Inclusion - Surface Tags array.Surface Tag Index: IntegerSurface Tag: StringYes
RemoveExclusiveTagRemoves the surface tag at the specified index of the Exclusion - Surface Tags array.Surface Tag Index: IntegerNoneYes
RemoveInclusiveTagRemoves the surface tag at the specified index of the Inclusion - Surface Tags array.Surface Tag Index: IntegerNoneYes
SetAllowOverridesSets the configuration of the Allow Per-Item Overrides property.BooleanNoneYes