Difference between revisions of "Include (CEffectDamage)"

From HIVE
Jump to navigation Jump to search
(Created page with "'''''Include''''' is a member array of CEffectDamage. ==Documentation== {{Documentation Template| name=Include| fname=CEffectDamage.IncludeArray[]| type=data array| d...")
 
m
 
(2 intermediate revisions by one other user not shown)
Line 15: Line 15:
 
fname=CEffectDamage.IncludeArray[].Effect|
 
fname=CEffectDamage.IncludeArray[].Effect|
 
type=object reference|
 
type=object reference|
desc=The [[effect]] to use as the scope in which to apply the [[Include (CEffectDamage)#Value|''Value'' field]]. If no effect is specified, the scope is assumed to be the [[Damage|damage effect]] itself.
+
desc=The [[effect]] to use as the scope in which to apply the [[#Value|''Value'' field]]. If no effect is specified, the scope is assumed to be the [[Damage|damage effect]] itself.
 
}}
 
}}
  
Line 23: Line 23:
 
fname=CEffectDamage.IncludeArray[].Value|
 
fname=CEffectDamage.IncludeArray[].Value|
 
type=variable reference|
 
type=variable reference|
desc=The marker to use to determine the target being included. The scope of the marker is specified by the [[Include (CEffectDamage)#Effect|''Effect'' field]].
+
desc=The marker to use to determine the target being included. The scope of the marker is specified by the [[#Effect|''Effect'' field]].
*''Caster'': Includes the caster of the parent effect.
+
*''Caster'': Includes the caster of the scoped effect.
*''Outer'': Includes any target already enumerated by another search area specified by the parent effect.
+
*''Outer'': Includes any target already enumerated by another search area specified by the scoped effect.
*''Source'': Includes the source of the parent effect.
+
*''Source'': Includes the source of the scoped effect.
*''Target'': Includes the target of the parent effect.
+
*''Target'': Includes the target of the scoped effect.
 
}}
 
}}
 +
 +
[[Category:StarCraft II]]
 +
[[Category:Data Editor]]
 +
[[Category:Reference]]

Latest revision as of 11:56, 26 November 2010

Include is a member array of CEffectDamage.

Documentation

Name
Include
Fully-Qualified Name
CEffectDamage.IncludeArray[]
Type
data array
Description
A list of targets to forceably include in all search areas listed in the Area field of a damage effect.

Member Fields

Effect

Name
Effect
Fully-Qualified Name
CEffectDamage.IncludeArray[].Effect
Type
object reference
Description
The effect to use as the scope in which to apply the Value field. If no effect is specified, the scope is assumed to be the damage effect itself.

Value

Name
Value
Fully-Qualified Name
CEffectDamage.IncludeArray[].Value
Type
variable reference
Description
The marker to use to determine the target being included. The scope of the marker is specified by the Effect field.
  • Caster: Includes the caster of the scoped effect.
  • Outer: Includes any target already enumerated by another search area specified by the scoped effect.
  • Source: Includes the source of the scoped effect.
  • Target: Includes the target of the scoped effect.