DamageReflectionEvent
extends BattleEvent
in package
A battle event representing damage being reflected back on the attacker.
Table of Contents
- $damage : int
- $message : string
- $target : FighterInterface
- $applied : mixed
- __construct() : mixed
- Construct a DamageReflectionEvent with the target $target, damage amount $damage and the message $message.
- apply() : mixed
- Applies the event.
- decorate() : string
- Returns a string describing the event.
- getDamage() : int
- Returns the damage.
Properties
$damage
protected
int
$damage
$message
protected
string
$message
$target
protected
FighterInterface
$target
$applied
private
mixed
$applied
= false
Methods
__construct()
Construct a DamageReflectionEvent with the target $target, damage amount $damage and the message $message.
public
__construct(FighterInterface $target, int $damage, 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
- $damage : 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 —getDamage()
Returns the damage.
public
getDamage() : int