RegenerationBuffEvent
extends BattleEvent
in package
Battle event that represents regenerating health.
Table of Contents
- $effectMessage : mixed
- $noEffectMessage : mixed
- $regeneration : mixed
- $target : mixed
- $applied : mixed
- __construct() : mixed
- Construct a RegenerationBuffEvent against $target, with regenerating value $regeneration. $effectMessage is shown if there is an effect of regeneration, and $noEffectMessage is shown if the $regeneation is 0.
- apply() : mixed
- Applies the event.
- decorate() : string
- Returns a string describing the event.
Properties
$effectMessage
protected
mixed
$effectMessage
$noEffectMessage
protected
mixed
$noEffectMessage
$regeneration
protected
mixed
$regeneration
$target
protected
mixed
$target
$applied
private
mixed
$applied
= false
Methods
__construct()
Construct a RegenerationBuffEvent against $target, with regenerating value $regeneration. $effectMessage is shown if there is an effect of regeneration, and $noEffectMessage is shown if the $regeneation is 0.
public
__construct(FighterInterface $target, int $regeneration, string $effectMessage, string $noEffectMessage) : mixed
$effectMessage and $noEffectMessage can contain '{target}' and '{amount}' which will be replaced by the name of the target and the damage, respectively.
Parameters
- $target : FighterInterface
- $regeneration : int
- $effectMessage : string
- $noEffectMessage : 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