CombatantResult
in package
Tags
Table of Contents
Properties
- $combatant : CombatantInterface
- $deadBeforeShot : bool
- $dronesResult : HitWeaponResult|null
- $weaponResults : array<string|int, mixed>
Methods
- __construct() : mixed
- create() : CombatantResult<string|int, TCreateTarget>
- getTotalDamage() : int
- Returns the total actual damage done by this combatant in this round of combat.
- getTotalDamagePerTarget() : array<int, int>
- getTotalShieldDamage() : int
- Returns the total actual damage to shields by this combatant in this round of combat.
- getHitWeaponResults() : iterable<string|int, HitWeaponResult<string|int, TTarget>>
Properties
$combatant read-only
public
CombatantInterface
$combatant
$deadBeforeShot read-only
public
bool
$deadBeforeShot
= false
$dronesResult read-only
public
HitWeaponResult|null
$dronesResult
= null
$weaponResults read-only
public
array<string|int, mixed>
$weaponResults
= []
Methods
__construct()
public
__construct(CombatantInterface $combatant[, bool $deadBeforeShot = false ][, array<int, MissedWeaponResult|HitWeaponResult<string|int, TTarget>> $weaponResults = [] ][, HitWeaponResult<string|int, TTarget>|null $dronesResult = null ]) : mixed
Parameters
- $combatant : CombatantInterface
- $deadBeforeShot : bool = false
- $weaponResults : array<int, MissedWeaponResult|HitWeaponResult<string|int, TTarget>> = []
- $dronesResult : HitWeaponResult<string|int, TTarget>|null = null
create()
public
static create(CombatantInterface $combatant[, bool $deadBeforeShot = false ][, array<int, MissedWeaponResult|HitWeaponResult<string|int, TCreateTarget>> $weaponResults = [] ][, HitWeaponResult<string|int, TCreateTarget>|null $dronesResult = null ]) : CombatantResult<string|int, TCreateTarget>
Parameters
- $combatant : CombatantInterface
- $deadBeforeShot : bool = false
- $weaponResults : array<int, MissedWeaponResult|HitWeaponResult<string|int, TCreateTarget>> = []
- $dronesResult : HitWeaponResult<string|int, TCreateTarget>|null = null
Tags
Return values
CombatantResult<string|int, TCreateTarget>getTotalDamage()
Returns the total actual damage done by this combatant in this round of combat.
public
getTotalDamage() : int
Return values
intgetTotalDamagePerTarget()
public
getTotalDamagePerTarget() : array<int, int>
Return values
array<int, int>getTotalShieldDamage()
Returns the total actual damage to shields by this combatant in this round of combat.
public
getTotalShieldDamage() : int
Includes shield damage from both weapon and CD NormalDamage hits.
Return values
intgetHitWeaponResults()
private
getHitWeaponResults() : iterable<string|int, HitWeaponResult<string|int, TTarget>>