Documentation

CriticalHitEvent extends BattleEvent
in package

Battle event representing a stronger than average attack.

Table of Contents

$attacker  : FighterInstance
$criticalAttackValue  : int
$applied  : mixed
__construct()  : mixed
Construct a CriticalHitEvent with attacker $attacker.
apply()  : mixed
Applies the event.
decorate()  : string
Returns a string describing the event.

Properties

Methods

__construct()

Construct a CriticalHitEvent with attacker $attacker.

public __construct(FighterInterface $attacker, int $criticalAttackValue) : mixed
Parameters
$attacker : FighterInterface
$criticalAttackValue : int
Return values
mixed

decorate()

Returns a string describing the event.

public decorate(Game $game) : string
Parameters
$game : Game
Tags
inheritDoc
Return values
string

Search results