Mass removal of useless @param/@return PHPDoc annotations, pass 1

This commit is contained in:
Dylan K. Taylor
2020-01-21 15:10:18 +00:00
parent 7532c609fb
commit c4793241f5
322 changed files with 0 additions and 5360 deletions

View File

@ -75,9 +75,6 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
/**
* @param Entity $entity
* @param int $cause
* @param float $damage
* @param float[] $modifiers
*/
public function __construct(Entity $entity, int $cause, float $damage, array $modifiers = []){
@ -89,17 +86,12 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
$this->originals = $this->modifiers;
}
/**
* @return int
*/
public function getCause() : int{
return $this->cause;
}
/**
* Returns the base amount of damage applied, before modifiers.
*
* @return float
*/
public function getBaseDamage() : float{
return $this->baseDamage;
@ -109,8 +101,6 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
* Sets the base amount of damage applied, optionally recalculating modifiers.
*
* TODO: add ability to recalculate modifiers when this is set
*
* @param float $damage
*/
public function setBaseDamage(float $damage) : void{
$this->baseDamage = $damage;
@ -118,8 +108,6 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
/**
* Returns the original base amount of damage applied, before alterations by plugins.
*
* @return float
*/
public function getOriginalBaseDamage() : float{
return $this->originalBase;
@ -132,11 +120,6 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
return $this->originals;
}
/**
* @param int $type
*
* @return float
*/
public function getOriginalModifier(int $type) : float{
return $this->originals[$type] ?? 0.0;
}
@ -148,42 +131,24 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
return $this->modifiers;
}
/**
* @param int $type
*
* @return float
*/
public function getModifier(int $type) : float{
return $this->modifiers[$type] ?? 0.0;
}
/**
* @param float $damage
* @param int $type
*/
public function setModifier(float $damage, int $type) : void{
$this->modifiers[$type] = $damage;
}
/**
* @param int $type
*
* @return bool
*/
public function isApplicable(int $type) : bool{
return isset($this->modifiers[$type]);
}
/**
* @return float
*/
public function getFinalDamage() : float{
return $this->baseDamage + array_sum($this->modifiers);
}
/**
* Returns whether an entity can use armour points to reduce this type of damage.
* @return bool
*/
public function canBeReducedByArmor() : bool{
switch($this->cause){
@ -204,8 +169,6 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
/**
* Returns the cooldown in ticks before the target entity can be attacked again.
*
* @return int
*/
public function getAttackCooldown() : int{
return $this->attackCooldown;
@ -215,8 +178,6 @@ class EntityDamageEvent extends EntityEvent implements Cancellable{
* Sets the cooldown in ticks before the target entity can be attacked again.
*
* NOTE: This value is not used in non-Living entities
*
* @param int $attackCooldown
*/
public function setAttackCooldown(int $attackCooldown) : void{
$this->attackCooldown = $attackCooldown;