DamageLifetapEvent
extends BattleEvent
in package
Damage event where damage is the result of a life tap.
Table of Contents
- $healAmount : int
- $message : string
- $target : FighterInterface
- $applied : mixed
- __construct() : mixed
- Construct a new DamageLifetapEvent where healing amount is $healAmount and target is $target.
- apply() : mixed
- Applies the event.
- decorate() : string
- Returns a string describing the event.
- getHealAmount() : int
- Return the heal amount.
Properties
$healAmount
protected
int
$healAmount
$message
protected
string
$message
$target
protected
FighterInterface
$target
$applied
private
mixed
$applied
= false
Methods
__construct()
Construct a new DamageLifetapEvent where healing amount is $healAmount and target is $target.
public
__construct(FighterInterface $target, int $healAmount, string $message) : mixed
$message can contain '{target}' and '{damage}' which will be replaced by the name of the target and the damage, respectively.
Parameters
- $target : FighterInterface
- $healAmount : int
- $message : string
Return values
mixed —apply()
Applies the event.
public
apply() : mixed
Tags
Return values
mixed —decorate()
Returns a string describing the event.
public
decorate(Game $game) : string
Parameters
- $game : Game
Tags
Return values
string —getHealAmount()
Return the heal amount.
public
getHealAmount() : int