Data\Effect\Simple Area Search

Searches an area and applies effects to found simple units.


For more info about simple units, see Simple Units Guide.

Debug Draw

When checked, shows the area of this search effect in-game.

Area Search Type

MessageType: AreaSearchType

Determines whether to search in a circle, arc, rectangle, or the source unit's children units.

Max Unit Count

The maximum number of units that will be found by the search.

Filter

Parameters for which targets are valid for the search.

Primary Sort Keys

MessageType: SearchFilterSort

Potential targets are sorted based on these parameters.

Secondary Sort Keys

MessageType: SearchFilterSort

If a pair of targets have the same priority value due to Primary Sort Keys, this sort key is then used to determine which unit to target.

Player

EnumType: SimpleSearchFilter.Flag

Targets owned by the player that created the search will match the filter.

Ally

EnumType: SimpleSearchFilter.Flag

Targets owned by an ally of the player that created the search will match the filter.

Enemy

EnumType: SimpleSearchFilter.Flag

Targets owned by an enemy of the player that created the search will match the filter.

Neutral

EnumType: SimpleSearchFilter.Flag

Targets that are neutral to the player that created the search will match the filter.

Is Simple Unit

EnumType: SimpleSearchFilter.Flag

Targets that are simple units will match the filter.

Has Simple Health

EnumType: SimpleSearchFilter.Flag

Targets that have simple health components will match the filter.

Has Simple Collision

EnumType: SimpleSearchFilter.Flag

Targets that have simple collision components will match the filter.

Has Simple Mover

EnumType: SimpleSearchFilter.Flag

Targets that have simple mover components will match the filter.

Has Simple Mass

EnumType: SimpleSearchFilter.Flag

Targets that have simple mass components will match the filter.

Tag Mask

If set, requires the target has a tag component, if the (tag.value & tag_mask) != 0, it's considered a match

Distance Check Mode

EnumType: DistanceCheckModes

Determines whether to consider unit radius or center point when finding targets.

Effect

The effect created on targets found by the search.

Missing Effect

This effect is created if the number of targets found is less than the Max Unit Count (if set). This effect is created for each missing target. Ex: if the Max Unit Count is 3 but only 1 target is found, then the Effect will executed once on the target and the Missing Effect will be executed twice at the search location.

Location

MessageType: EffectLocation

where the area search is created

Orientation

MessageType: EffectOrientation

Orientation of the area search