Effect: document that duration is expected in ticks

This commit is contained in:
Dylan K. Taylor 2019-12-29 19:03:32 +00:00
parent 3e23a568ca
commit a908197907
2 changed files with 6 additions and 1 deletions

View File

@ -195,7 +195,8 @@ class Effect{
}
/**
* Returns the default duration this effect will apply for if a duration is not specified.
* Returns the default duration (in ticks) this effect will apply for if a duration is not specified.
*
* @return int
*/
public function getDefaultDuration() : int{

View File

@ -75,6 +75,8 @@ class EffectInstance{
}
/**
* Returns the number of ticks remaining until the effect expires.
*
* @return int
*/
public function getDuration() : int{
@ -82,6 +84,8 @@ class EffectInstance{
}
/**
* Sets the number of ticks remaining until the effect expires.
*
* @param int $duration
*
* @throws \InvalidArgumentException