Difference between revisions of "Engine ApplyEffectOnParty"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: re-import with default parameter value parameters set) |
m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Generated with errors}} | {{Generated with errors}} | ||
{{dafunction | {{dafunction | ||
| − | |name=Engine_ApplyEffectOnParty | + | |name = Engine_ApplyEffectOnParty |
| − | |brief=This function applies an effect on an object. | + | |brief = This function applies an effect on an object. |
| − | |param1type=int | + | |param1type = int |
| − | |param1name=nDurationType | + | |param1name = nDurationType |
| − | |param1desc= | + | |param1desc = an [[EFFECT_DURATION_TYPE_*]] constant or literal |
| − | |param1default= | + | |param1default = |
| − | |param2type=effect | + | |param2type = effect |
| − | |param2name=eEffect | + | |param2name = eEffect |
| − | |param2desc=the effect to be applied | + | |param2desc = the effect to be applied |
| − | |param2default= | + | |param2default = |
| − | |param3type=float | + | |param3type = float |
| − | |param3name=fDuration | + | |param3name = fDuration |
| − | |param3desc= | + | |param3desc = |
| − | |param3default=0.0 | + | |param3default = 0.0 |
| − | |param4type=object | + | |param4type = object |
| − | |param4name=oCreator | + | |param4name = oCreator |
| − | |param4desc=effect creator | + | |param4desc = an object to be the effect creator |
| − | |param4default=OBJECT_SELF | + | |param4default = OBJECT_SELF |
| − | |param5type=int | + | |param5type = int |
| − | |param5name=nAbilityId | + | |param5name = nAbilityId |
| − | |param5desc= | + | |param5desc = an [[ABILITY_*]] constant or literal |
| − | |param5default=0 | + | |param5default = 0 |
| − | |param6type=int | + | |param6type = int |
| − | |param6name=bExcludeCreator | + | |param6name = bExcludeCreator |
| − | |param6desc=Exclude the creator of the effect | + | |param6desc = Exclude the creator of the effect |
| − | |param6default=FALSE | + | |param6default = FALSE |
| − | |returntype=void | + | |returntype = void |
| − | |returndesc= | + | |returndesc = |
| − | |sourcefile=script.ldf | + | |sourcefile = script.ldf |
| − | |sourcemodule= | + | |sourcemodule = |
}} | }} | ||
| − | |||
== 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 == | |
| − | + | ||
<!-- 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. --> | ||
| − | |||
<!-- == See also == --> | <!-- == See also == --> | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | [[Category: Effect | + | [[Category:Effect functions]] |
Latest revision as of 19:55, 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
);
int nDurationType,
effect eEffect,
float fDuration = 0.0,
object oCreator = OBJECT_SELF,
int nAbilityId = 0,
int bExcludeCreator = FALSE
);
- Parameters:
- nDurationType
- an EFFECT_DURATION_TYPE_* constant or literal
- eEffect
- the effect to be applied
- fDuration
- [Undocumented]
- oCreator
- an object to be the effect creator
- nAbilityId
- an ABILITY_* constant or literal
- 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
