Documentation

Mines extends AbstractWeapon
in package
Uses ForcesTrait

Table of Contents

Constants

DCS_DAMAGE_MODIFIER  = 0.75
FED_SHIP_DAMAGE_MODIFIER  = 0.5
PLANET_DAMAGE_MOD  = 0.2
Reduce the damage done to planets by this factor
TOTAL_ENEMY_MINES_MODIFIER  = 25

Properties

$accuracy  : int
$amount  : int
$armourDamage  : int
$damageRollover  : bool
$name  : string
$shieldDamage  : int

Methods

__construct()  : mixed
canShootForces()  : bool
canShootPlanets()  : bool
canShootPorts()  : bool
canShootTraders()  : bool
getAmount()  : int
Returns the amount of this type of force.
getArmourDamage()  : int
getBaseAccuracy()  : int
getDamage()  : WeaponDamageData
getModifiedAccuracy()  : float
getModifiedDamageAgainstForces()  : WeaponDamageData
getModifiedDamageAgainstPlanet()  : WeaponDamageData
getModifiedDamageAgainstPlayer()  : WeaponDamageData
getModifiedDamageAgainstPort()  : WeaponDamageData
getModifiedForceAccuracyAgainstPlayer()  : float
getModifiedForceDamageAgainstPlayer()  : WeaponDamageData
getModifiedPlanetDamageAgainstPlayer()  : WeaponDamageData
getModifiedPortDamageAgainstPlayer()  : WeaponDamageData
getName()  : string
getShieldDamage()  : int
isDamageRollover()  : bool
shootForces()  : ForceTakenDamageData, KillResults?: array{}}
shootPlayer()  : TakenDamageData, KillResults?: array{DeadExp: int, KillerExp: int, KillerCredits: int}}
shootPlayerAsForce()  : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
doForceDamageToPlayer()  : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
doPlanetDamageToPlayer()  : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
doPlayerDamageToForce()  : ForceTakenDamageData, KillResults?: array{}}
doPlayerDamageToPlanet()  : TakenDamageData, KillResults?: array{}}
doPlayerDamageToPlayer()  : TakenDamageData, KillResults?: array{DeadExp: int, KillerExp: int, KillerCredits: int}}
doPlayerDamageToPort()  : TakenDamageData, KillResults?: array{}}
doPortDamageToPlayer()  : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
getModifiedForceAccuracyAgainstPlayerUsingRandom()  : float

Constants

DCS_DAMAGE_MODIFIER

protected mixed DCS_DAMAGE_MODIFIER = 0.75

FED_SHIP_DAMAGE_MODIFIER

protected mixed FED_SHIP_DAMAGE_MODIFIER = 0.5

PLANET_DAMAGE_MOD

Reduce the damage done to planets by this factor

protected mixed PLANET_DAMAGE_MOD = 0.2

TOTAL_ENEMY_MINES_MODIFIER

protected mixed TOTAL_ENEMY_MINES_MODIFIER = 25

Properties

Methods

__construct()

public __construct(int $numberOfMines) : mixed
Parameters
$numberOfMines : int

canShootForces()

public canShootForces() : bool
Return values
bool

canShootPlanets()

public canShootPlanets() : bool
Return values
bool

canShootPorts()

public canShootPorts() : bool
Return values
bool

canShootTraders()

public canShootTraders() : bool
Return values
bool

getAmount()

Returns the amount of this type of force.

public getAmount() : int
Return values
int

getArmourDamage()

public abstract getArmourDamage() : int
Return values
int

getBaseAccuracy()

public abstract getBaseAccuracy() : int
Return values
int

getDamage()

public getDamage() : WeaponDamageData
Return values
WeaponDamageData

getModifiedAccuracy()

public getModifiedAccuracy() : float
Return values
float

getModifiedDamageAgainstForces()

public getModifiedDamageAgainstForces(AbstractPlayer $weaponPlayer, Force $forces) : WeaponDamageData
Parameters
$weaponPlayer : AbstractPlayer
$forces : Force
Return values
WeaponDamageData

getModifiedDamageAgainstPort()

public getModifiedDamageAgainstPort(AbstractPlayer $weaponPlayer, Port $port) : WeaponDamageData
Parameters
$weaponPlayer : AbstractPlayer
$port : Port
Return values
WeaponDamageData

getModifiedForceAccuracyAgainstPlayer()

public getModifiedForceAccuracyAgainstPlayer(Force $forces, AbstractPlayer $targetPlayer, bool $minesAreAttacker) : float
Parameters
$forces : Force
$targetPlayer : AbstractPlayer
$minesAreAttacker : bool
Return values
float

getModifiedForceDamageAgainstPlayer()

public getModifiedForceDamageAgainstPlayer(Force $forces, AbstractPlayer $targetPlayer[, bool $minesAreAttacker = false ]) : WeaponDamageData
Parameters
$forces : Force
$targetPlayer : AbstractPlayer
$minesAreAttacker : bool = false
Return values
WeaponDamageData

getModifiedPlanetDamageAgainstPlayer()

public getModifiedPlanetDamageAgainstPlayer(Planet $planet, AbstractPlayer $targetPlayer) : WeaponDamageData
Parameters
$planet : Planet
$targetPlayer : AbstractPlayer
Return values
WeaponDamageData

getModifiedPortDamageAgainstPlayer()

public getModifiedPortDamageAgainstPlayer(Port $port, AbstractPlayer $targetPlayer) : WeaponDamageData
Parameters
$port : Port
$targetPlayer : AbstractPlayer
Return values
WeaponDamageData

getName()

public abstract getName() : string
Return values
string

getShieldDamage()

public abstract getShieldDamage() : int
Return values
int

isDamageRollover()

public isDamageRollover() : bool
Return values
bool

shootForces()

public shootForces(AbstractPlayer $weaponPlayer, Force $forces) : ForceTakenDamageData, KillResults?: array{}}
Parameters
$weaponPlayer : AbstractPlayer
$forces : Force
Return values
ForceTakenDamageData, KillResults?: array{}}

shootPlayer()

public shootPlayer(AbstractPlayer $weaponPlayer, AbstractPlayer $targetPlayer) : TakenDamageData, KillResults?: array{DeadExp: int, KillerExp: int, KillerCredits: int}}
Parameters
$weaponPlayer : AbstractPlayer
$targetPlayer : AbstractPlayer
Return values
TakenDamageData, KillResults?: array{DeadExp: int, KillerExp: int, KillerCredits: int}}

shootPlayerAsForce()

public shootPlayerAsForce(Force $forces, AbstractPlayer $targetPlayer[, bool $minesAreAttacker = false ]) : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
Parameters
$forces : Force
$targetPlayer : AbstractPlayer
$minesAreAttacker : bool = false
Return values
TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}

doForceDamageToPlayer()

protected doForceDamageToPlayer(array<string|int, mixed> $return, Force $forces, AbstractPlayer $targetPlayer[, bool $minesAreAttacker = false ]) : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
Parameters
$return : array<string|int, mixed>
$forces : Force
$targetPlayer : AbstractPlayer
$minesAreAttacker : bool = false
Return values
TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}

doPlanetDamageToPlayer()

protected doPlanetDamageToPlayer(AbstractPlayer, Hit: bool} $return, Planet $planet, AbstractPlayer $targetPlayer) : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
Parameters
$return : AbstractPlayer, Hit: bool}
$planet : Planet
$targetPlayer : AbstractPlayer
Return values
TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}

doPlayerDamageToForce()

protected doPlayerDamageToForce(Force, Hit: bool} $return, AbstractPlayer $weaponPlayer, Force $forces) : ForceTakenDamageData, KillResults?: array{}}
Parameters
$return : Force, Hit: bool}
$weaponPlayer : AbstractPlayer
$forces : Force
Return values
ForceTakenDamageData, KillResults?: array{}}

doPlayerDamageToPlanet()

protected doPlayerDamageToPlanet(Planet, Hit: bool} $return, AbstractPlayer $weaponPlayer, Planet $planet) : TakenDamageData, KillResults?: array{}}
Parameters
$return : Planet, Hit: bool}
$weaponPlayer : AbstractPlayer
$planet : Planet
Return values
TakenDamageData, KillResults?: array{}}

doPlayerDamageToPlayer()

protected doPlayerDamageToPlayer(AbstractPlayer, Hit: bool} $return, AbstractPlayer $weaponPlayer, AbstractPlayer $targetPlayer) : TakenDamageData, KillResults?: array{DeadExp: int, KillerExp: int, KillerCredits: int}}
Parameters
$return : AbstractPlayer, Hit: bool}
$weaponPlayer : AbstractPlayer
$targetPlayer : AbstractPlayer
Return values
TakenDamageData, KillResults?: array{DeadExp: int, KillerExp: int, KillerCredits: int}}

doPlayerDamageToPort()

protected doPlayerDamageToPort(Port, Hit: bool} $return, AbstractPlayer $weaponPlayer, Port $port) : TakenDamageData, KillResults?: array{}}
Parameters
$return : Port, Hit: bool}
$weaponPlayer : AbstractPlayer
$port : Port
Return values
TakenDamageData, KillResults?: array{}}

doPortDamageToPlayer()

protected doPortDamageToPlayer(AbstractPlayer, Hit: bool} $return, Port $port, AbstractPlayer $targetPlayer) : TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}
Parameters
$return : AbstractPlayer, Hit: bool}
$port : Port
$targetPlayer : AbstractPlayer
Return values
TakenDamageData, KillResults?: array{DeadExp: int, LostCredits: int}}

getModifiedForceAccuracyAgainstPlayerUsingRandom()

protected getModifiedForceAccuracyAgainstPlayerUsingRandom(Force $forces, AbstractPlayer $targetPlayer, int $random, bool $minesAreAttacker) : float
Parameters
$forces : Force
$targetPlayer : AbstractPlayer
$random : int
$minesAreAttacker : bool
Return values
float 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results