Difference between revisions of "GetRemainingCooldown"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: re-import with default parameter value parameters set)
(One intermediate revision by the same user not shown)
Line 33: Line 33:
 
<!-- 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]]

Revision as of 22:43, 24 February 2010

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.

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