Area (CEffectDamage)

From HIVE
Jump to: navigation, search

Area is a member array of CEffectDamage.

Documentation

Name 
Area
Fully-Qualified Name
CEffectDamage.AreaArray[]
Type
data array
Description
The Area field is an array of different search areas, each one with its own set of properties. When Area contains at least one element, the damage applied by the effect will be dealt in an area of effect specified by the element(s) of Area. The origin of all search areas is the location of the triggering Damage Effect's initial target. The Offset by Unit Radius flag in the Damage Effect's Search Flags field may change the origin. If a target lies within more than one search area, the damage effect will be applied to it multiple times. To prevent this from happening, add Outer to the Exclude field. The primary target of the damage effect may also be enumerated by search areas. To prevent this from happening, add Target to the Exclude field.

Member Fields

Arc

Name 
Arc
Fully-Qualified Name
CEffectDamage.AreaArray[].Arc
Type
fixed (0. - 360.)
Description
The arc (expressed in degrees) that this area sweeps out. The area sweeps out in the direction of a straight line running from the damage effect's source to the primary target. The line will also perfectly bisect the arc.

Bonus

Name 
Bonus
Fully-Qualified Name
CEffectDamage.AreaArray[].Bonus
Type
fixed
Description
The amount of bonus damage added to that which is dealt to targets enumerated in this area.

Fraction

Name 
Fraction
Fully-Qualified Name
CEffectDamage.AreaArray[].Fraction
Type
fixed
Description
The multiplier to apply to the damage dealt to targets enumerated in this area.

Maximum Count

Name 
Maximum Count
Fully-Qualified Name
CEffectDamage.AreaArray[].MaxCount
Type
int
Description
The maximum number of targets to be enumerated in this area. Only targets that successfully pass all search and validation filters specified by this area and its parent damage effect count toward this limit. A value of -1 means no limit.

Radius

Name 
Radius
Fully-Qualified Name
CEffectDamage.AreaArray[].Radius
Type
fixed
Description
The radius out to which this area sweeps. The radius is calculated from the center point of the initial target of the damage effect. A target is enumerated by this area if any part of its collision sphere falls within the specified radius (and arc).

Radius Bonus

Name 
Radius Bonus
Fully-Qualified Name
CEffectDamage.AreaArray[].RadiusBonus
Type
fixed
Description
??

Validator

Name 
Validator
Fully-Qualified Name
CEffectDamage.AreaArray[].Validator
Type
object reference
Description
The validator to apply to targets enumerated by this area. Targets must pass the validator, if one is specified, before they are damaged.

Notes

While using search areas within Damage Effects is a simple method of implementing area of effect damage, a more general and powerful alternative is to use Search Area Effects in conjunction with Damage Effects.