Difference between revisions of "GetRemainingCooldown"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
m (also, looks okay, removing tag)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=GetRemainingCooldown
 
|name=GetRemainingCooldown
Line 6: Line 5:
 
|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 check the cooldown
 
|param2desc=ability to check the cooldown
 +
|param2default=
 
|param3type=string
 
|param3type=string
 
|param3name=sSourceItemTag
 
|param3name=sSourceItemTag
 
|param3desc=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
 
|param3desc=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
 +
|param3default=""
 
|returntype=float
 
|returntype=float
 
|returndesc=0.0f if the ability is ready to be used again
 
|returndesc=0.0f if the ability is ready to be used again
Line 30: Line 32:
 
<!-- This section contains links to articles, functions or constant groups. -->
 
<!-- This section contains links to articles, functions or constant groups. -->
 
[[SetCooldown]]
 
[[SetCooldown]]
[[Category: Abilities]]
+
[[Category:Ability functions]]

Latest revision as of 22:44, 24 February 2010

Get the remaining time for an ability to be used

float GetRemainingCooldown(
object oCreature,
int nAbilityId,
string sSourceItemTag = ""
);
Parameters:
oCreature
owner of the ability
nAbilityId
ability to check the cooldown
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:

0.0f if the ability is ready to be used again

Source:

script.ldf



See also

SetCooldown