summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2014-07-17 18:36:06 +0200
committerWuzzy <almikes@aol.com>2014-07-17 18:36:06 +0200
commita97ddfd942208249ce3c4df06154b1fad41f71f7 (patch)
treee280978095e2f7a87edf43721fa470a4fac29027 /README.md
parent7bfd30ce392ace5b4795fab2dcb63926cf02ea67 (diff)
Add API functions to get the current effect time
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4d6a575..086b792 100644
--- a/README.md
+++ b/README.md
@@ -170,6 +170,24 @@ Careful! This function has *not* been tested yet!
##### Return value
Always `nil`.
+#### `playereffects.get_remaining_effect_time(effect_id)`
+Returns the remaining time of an effect.
+
+##### Parameter
+* `effect_id`: The effect identifier of the effect in question
+
+##### Return value
+Iff the effect exists, the remaining effect time is returned in full seconds. Iff the effect does not exist, `nil` is returned.
+
+#### `playereffects.get_passed_effect_time(effect_id)`
+Returns the time an effect was in place.
+
+##### Parameter
+* `effect_id`: The effect identifier of the effect in question
+
+##### Return value
+Iff the effect exists, the number of seconds the effect is in place is returned. Iff the effect does not exist, `nil` is returned.
+
#### `playereffects.get_player_effects(playername)`
Returns all active effects of a player.