Ability ApplyUpkeepEffects - Revision history

Sunjammer: Enabling headings

2012-04-26T11:48:57Z

Enabling headings

Sunjammer: Cleaning up prior to review

2012-04-26T11:42:53Z

Cleaning up prior to review

Sunjammer: Flagging for my attention

2011-08-31T22:15:34Z

Flagging for my attention

Yokmp: added some explains

2011-03-04T01:04:13Z

added some explains

Yokmp: added description

2011-03-04T00:42:57Z

added description

BryanDerksen at 00:05, 25 February 2010

2010-02-25T00:05:32Z

BryanDerksen: Created page with '{{dafunction |name = Ability_ApplyUpkeepEffects |brief = {{undocumented}} |param1type = object |param1name = oCaster |param1desc = {{undocumented}} |param1default = |param2type =...'

2010-02-25T00:05:01Z

Created page with '{{dafunction |name = Ability_ApplyUpkeepEffects |brief = {{undocumented}} |param1type = object |param1name = oCaster |param1desc = {{undocumented}} |param1default = |param2type =...'

New page

{{dafunction
|name = Ability_ApplyUpkeepEffects
|brief = {{undocumented}}
|param1type = object
|param1name = oCaster
|param1desc = {{undocumented}}
|param1default =
|param2type = int
|param2name = nAbility
|param2desc = {{undocumented}}
|param2default =
|param3type = effect
|param3arra=true
|param3name = eEffects
|param3desc = {{undocumented}}
|param3default =
|param4type = object
|param4name = oTarget
|param4desc = {{undocumented}}
|param4default =OBJECT_INVALID
|param5type = int
|param5name = bPartywide
|param5desc = {{undocumented}}
|param5default =FALSE
|returntype = void
|returndesc =
|sourcefile = ability_h
|sourcemodule = Core Resources
}}

← Older revision		Revision as of 22:15, 31 August 2011
Line 1:		Line 1:
		+	{{ToDoListItem\|Sunjammer}}
	{{dafunction		{{dafunction
	\|name = Ability_ApplyUpkeepEffects		\|name = Ability_ApplyUpkeepEffects

@@ Line 5: / Line 5: @@
 |param1type    = object
 |param1name    = oCaster
-|param1desc    = The Caster of the Ability on which the upkeep will be applied.
+|param1desc    = The caster of the ability on which the upkeep will be applied.
 |param1default =
 |param2type    = int
 |param2name    = nAbility
-|param2desc    = The Ability itself.
+|param2desc    = The ability itself.
 |param2default =
 |param3type    = effect
 |param3arra    = yes
 |param3name    = eEffects
-|param3desc    = The Effects on which the upkeep come from.
+|param3desc    = The effects on which the upkeep come from.
 |param3default =
 |param4type    = object
 |param4name    = oTarget
-|param4desc    = The Target is the Caster. It is not needed to change the default value.
+|param4desc    = The target is the caster. It is not needed to change the default value.
 |param4default = OBJECT_INVALID
 |param5type    = int
@@ Line 29: / Line 29: @@
 |sourcemodule = Core Game Resources
 }}
 == Description ==
-<!-- == Description == -->
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 Upkeep effects are permanent until the effect is removed. They also set the UI-icon toggle inside the effect based on the ability ID.
 <!-- == Remarks == -->
 <!-- This section contains additional comments, observations and known issues. -->
-Ability_ApplyUpkeepEffects is more a Wrapper for [[_ApplyUpkeepEffect]] than a Function.
+== Examples ==
-−
-<!-- == Examples == -->
 <!-- This section contains examples transcluded from the snippet library. -->
-Here is some code from the function itself:
+The following snippet is taken from the function itself:
 <dascript>
@@ Line 52: / Line 48: @@
      for(i = 0; i < nCount; i++)
+     {
-         _ApplyUpkeepEffect( oCaster, eEffects[i], nAbility, oTarget, bPartywide);
+         _ApplyUpkeepEffect(oCaster, eEffects[i], nAbility, oTarget, bPartywide);
+     }
@@ Line 59: / Line 55: @@
      // apply the effect on the target (caster)
-     ApplyEffectOnObject(EFFECT_DURATION_TYPE_PERMANENT, eUpkeep, oCaster, 0.0f, oCaster, nAbility);
+     ApplyEffectOnObject(EFFECT_DURATION_TYPE_PERMANENT, eUpkeep, oCaster, 0.0, oCaster, nAbility);
 </dascript>
 == See also ==
 <!-- This section contains links to articles, functions or constant groups. -->
-[[Ability_ApplyUpkeepEffect]]
+[[_ApplyUpkeepEffect]], [[Ability_ApplyUpkeepEffect]]