Difference between revisions of "SetCooldown"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (1 revision: re-import with default parameter value parameters set)
Line 6: Line 6:
 
|param1name=oCreature
 
|param1name=oCreature
 
|param1desc=owner of the ability
 
|param1desc=owner of the ability
 +
|param1default=
 
|param2type=int
 
|param2type=int
 
|param2name=nAbilityId
 
|param2name=nAbilityId
 
|param2desc=ability to set the cooldown
 
|param2desc=ability to set the cooldown
 +
|param2default=
 
|param3type=float
 
|param3type=float
 
|param3name=fCooldownTime
 
|param3name=fCooldownTime
 
|param3desc=time that the ability should be inactive (in seconds)
 
|param3desc=time that the ability should be inactive (in seconds)
 +
|param3default=
 
|param4type=string
 
|param4type=string
 
|param4name=sSourceItemTag
 
|param4name=sSourceItemTag
 
|param4desc=if an item ability, specify the specific item providing the ability.  If an empty string, the engine will grab the first item with this ability, this may not be the desired intention if the player has several items with the same ability
 
|param4desc=if an item ability, specify the specific item providing the ability.  If an empty string, the engine will grab the first item with this ability, this may not be the desired intention if the player has several items with the same ability
 +
|param4default=""
 
|returntype=void
 
|returntype=void
 
|returndesc=
 
|returndesc=

Revision as of 23:33, 31 July 2009

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

The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.

This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.

Please remove the {{Generated}} tag once the page has been confirmed or corrected.

Set the cooldown for an ability. This is the initial value. The engine timer will automaticaly decrease the cooldown until it reaches zero.

void SetCooldown(
object oCreature,
int nAbilityId,
float fCooldownTime,
string sSourceItemTag = ""
);
Parameters:
oCreature
owner of the ability
nAbilityId
ability to set the cooldown
fCooldownTime
time that the ability should be inactive (in seconds)
sSourceItemTag
if an item ability, specify the specific item providing the ability. If an empty string, the engine will grab the first item with this ability, this may not be the desired intention if the player has several items with the same ability
Returns:

Nothing.

Source:

script.ldf



See also

GetRemainingCooldown