Difference between revisions of "Engine ApplyEffectOnParty"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (Correcting category)
m (Adding remarks)
Line 34: Line 34:
 
== Description ==
 
== Description ==
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
Applies eEffect to every member of the player's party!
+
Applies <code>eEffect</code> to every member of the player's party.
<!-- == Remarks == -->
+
== Remarks ==
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 +
The [[EFFECT_DURATION_TYPE_*]] constant which are valid for the <code>nDurationType</code> parameter are:
 +
* <code>EFFECT_DURATION_TYPE_INSTANTANEOUS</code>
 +
* <code>EFFECT_DURATION_TYPE_PERMANENT</code>
 +
* <code>EFFECT_DURATION_TYPE_TEMPORARY</code>
 
<!-- == Examples == -->
 
<!-- == Examples == -->
 
<!-- This section contains examples transcluded from the snippet library. -->
 
<!-- This section contains examples transcluded from the snippet library. -->

Revision as of 19:51, 10 March 2012

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was unable to extract and/or match all the information required and has flagged this page as containing one or more errors. The source file was not formatted correctly and the information presented is incomplete or incorrect.

This page must be reviewed by a knowledgeable scripter as it will need to be updated. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with errors}} tag once the page has been corrected.

This function applies an effect on an object.

void Engine_ApplyEffectOnParty(
int nDurationType,
effect eEffect,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0,
int bExcludeCreator = FALSE
);
Parameters:
nDurationType
a EFFECT_DURATION_TYPE_* constant
eEffect
the effect to be applied *
fDuration
[Undocumented]
oCreator
effect creator
nAbilityId
ability id
bExcludeCreator
Exclude the creator of the effect
Returns:

Nothing.

Source:

script.ldf

Description

Applies eEffect to every member of the player's party.

Remarks

The EFFECT_DURATION_TYPE_* constant which are valid for the nDurationType parameter are:

  • EFFECT_DURATION_TYPE_INSTANTANEOUS
  • EFFECT_DURATION_TYPE_PERMANENT
  • EFFECT_DURATION_TYPE_TEMPORARY