import Module from 'coriolis_shipyard/src/app/shipyard/Module.js'

public class | source

Module

Module - active module in a ship's buildout

Constructor Summary

Public Constructor
public	constructor(params: Object) Construct a new module

Member Summary

Public Members
public	[p]: *
public	mods: {}
public	origVals: {}

Method Summary

Public Methods
public	clone(): Object Clone an existing module
public	getAmmo(): Number Get the ammo size for this module, taking in to account modifications
public	getBays(): Number Get the bays for this module, taking in to account modifications
public	getBrokenRegenerationRate(): Number Get the broken regeneration rate for this module, taking in to account modifications
public	getBurst(): Number Get the burst size for this module, taking in to account modifications
public	getBurstRoF(): Number Get the burst rate of fire for this module, taking in to account modifications
public	getCaptureArc(): Number Get the capture arc for this module, taking in to account modifications
public	getClip(): Number Get the clip size for this module, taking in to account modifications
public	getDamage(): Number Get the damage for this module, taking in to account modifications
public	getDamageDist(): string Get the damage distribution for this module, taking in to account modifications
public	getDelay(): Number Get the delay for this module, taking in to account modifications
public	getDistDraw(): Number Get the distributor draw for this module, taking in to account modifications
public	getDps(): Number Get the DPS for this module, taking in to account modifications
public	getDuration(): Number Get the duration for this module, taking in to account modifications
public	getEnginesCapacity(): Number Get the engines capacity for this module, taking in to account modifications
public	getEnginesRechargeRate(): Number Get the engines recharge rate for this module, taking in to account modifications
public	getEps(): Number Get the EPS for this module, taking in to account modifications
public	getExplosiveResistance(): Number Get the explosive resistance for this module, taking in to account modifications
public	getFacingLimit(): Number Get the facing limit for this module, taking in to account modifications
public	getFalloff(): Number Get the falloff for this module, taking in to account modifications
public	getHackTime(): string Get the hack time for this module, taking in to account modifications
public	getHps(): Number Get the HPS for this module, taking in to account modifications
public	getHullBoost(): Number Get the hull boost for this module, taking in to account modifications
public	getHullReinforcement(): Number Get the hull reinforcement for this module, taking in to account modifications
public	getIntegrity(): Number Get the integrity of this module, taking in to account modifications
public	getJitter(): Number Get the jitter for this module, taking in to account modifications
public	getKineticResistance(): Number Get the kinetic resistance for this module, taking in to account modifications
public	getMass(): Number Get the mass of this module, taking in to account modifications
public	getMaxFuelPerJump(): Number Get the maximum fuel per jump for this module, taking in to account modifications
public	getMaxMass(): Number Get the maximum mass for this module, taking in to account modifications
public	getMaxMul(type: string): Number Get the maximum multiplier for this module, taking in to account modifications
public	getMinMass(): Number Get the minimum mass for this module, taking in to account modifications
public	getMinMul(type: string): Number Get the minimum multiplier for this module, taking in to account modifications
public	getModValue(name: Number, raw: Number): object Get a value for a given modification
public	getOptMass(): Number Get the optimum mass for this module, taking in to account modifications
public	getOptMul(type: string): Number Get the optimum multiplier for this module, taking in to account modifications
public	getPiercing(): Number Get the piercing for this module, taking in to account modifications
public	getPowerGeneration(): Number Get the power generation of this module, taking in to account modifications
public	getPowerUsage(): Number Get the power usage of this module, taking in to account modifications
public	getProtection(): Number Get the protection for this module, taking in to account modifications
public	getRange(): Number Get the range for this module, taking in to account modifications
public	getRangeT(): Number Get the range (in terms of seconds, for FSDI) for this module, taking in to account modifications
public	getRebuildsPerBay(): Number Get the rebuilds per bay for this module, taking in to account modifications
public	getRegenerationRate(): Number Get the regeneration rate for this module, taking in to account modifications
public	getReload(): Number Get the reload time for this module, taking in to account modifications
public	getRoF(): Number Get the rate of fire for this module, taking in to account modifications.
public	getRoundsPerShot(): Number Get the rounds per shot for this module, taking in to account modifications
public	getScanTime(): Number Get the scan time for this module, taking in to account modifications
public	getShieldBoost(): Number Get the shield boost for this module, taking in to account modifications
public	getShieldReinforcement(): Number Get the shield reinforcement for this module, taking in to account modifications
public	getShotSpeed(): string Get the shot speed for this module, taking in to account modifications
public	getSpinup(): string Get the spinup for this module, taking in to account modifications
public	getSystemsCapacity(): Number Get the systems capacity for this module, taking in to account modifications
public	getSystemsRechargeRate(): Number Get the systems recharge rate for this module, taking in to account modifications
public	getThermalEfficiency(): Number Get the thermal efficiency of this module, taking in to account modifications
public	getThermalLoad(): Number Get the thermal load for this module, taking in to account modifications
public	getThermalResistance(): Number Get the thermal resistance for this module, taking in to account modifications
public	getTime(): string Get the time for this module, taking in to account modifications
public	getWeaponsCapacity(): Number Get the weapons capacity for this module, taking in to account modifications
public	getWeaponsRechargeRate(): Number Get the weapons recharge rate for this module, taking in to account modifications
public	setModValue(name: Number, value: object, valueiswithspecial: Boolean) Set a value for a given modification ID

Private Methods
private	_getModifiedValue(name: String): Number Helper to obtain a modified value using standard multipliers

Public Constructors

public constructor(params: Object) source

Construct a new module

Params:

Name	Type	Attribute	Description
params	Object		Module parameters. Either grp/id or template

Public Members

public [p]: * source

public mods: {} source

public origVals: {} source

Public Methods

public clone(): Object source

Clone an existing module

Return:

Object

A clone of the existing module

public getAmmo(): Number source

Get the ammo size for this module, taking in to account modifications

Return:

Number

the ammo size of this module

public getBays(): Number source

Get the bays for this module, taking in to account modifications

Return:

Number

the bays for this module

public getBrokenRegenerationRate(): Number source

Get the broken regeneration rate for this module, taking in to account modifications

Return:

Number

the broken regeneration rate of this module

public getBurst(): Number source

Get the burst size for this module, taking in to account modifications

Return:

Number

the burst size of this module

public getBurstRoF(): Number source

Get the burst rate of fire for this module, taking in to account modifications

Return:

Number

the burst rate of fire of this module

public getCaptureArc(): Number source

Get the capture arc for this module, taking in to account modifications

Return:

Number

the capture arc of this module

public getClip(): Number source

Get the clip size for this module, taking in to account modifications

Return:

Number

the clip size of this module

public getDamage(): Number source

Get the damage for this module, taking in to account modifications

Return:

Number

the damage of this module

public getDamageDist(): string source

Get the damage distribution for this module, taking in to account modifications

Return:

string

the damage distribution for this module

public getDelay(): Number source

Get the delay for this module, taking in to account modifications

Return:

Number

the delay of this module

public getDistDraw(): Number source

Get the distributor draw for this module, taking in to account modifications

Return:

Number

the distributor draw of this module

public getDps(): Number source

Get the DPS for this module, taking in to account modifications

Return:

Number

the DPS of this module

public getDuration(): Number source

Get the duration for this module, taking in to account modifications

Return:

Number

the duration of this module

public getEnginesCapacity(): Number source

Get the engines capacity for this module, taking in to account modifications

Return:

Number

the engines capacity of this module

public getEnginesRechargeRate(): Number source

Get the engines recharge rate for this module, taking in to account modifications

Return:

Number

the engines recharge rate of this module

public getEps(): Number source

Get the EPS for this module, taking in to account modifications

Return:

Number

the EPS of this module

public getExplosiveResistance(): Number source

Get the explosive resistance for this module, taking in to account modifications

Return:

Number

the explosive resistance of this module

public getFacingLimit(): Number source

Get the facing limit for this module, taking in to account modifications

Return:

Number

the facing limit for this module

public getFalloff(): Number source

Get the falloff for this module, taking in to account modifications

Return:

Number

the falloff of this module

public getHackTime(): string source

Get the hack time for this module, taking in to account modifications

Return:

string

the time for this module

public getHps(): Number source

Get the HPS for this module, taking in to account modifications

Return:

Number

the HPS of this module

public getHullBoost(): Number source

Get the hull boost for this module, taking in to account modifications

Return:

Number

the hull boost for this module

public getHullReinforcement(): Number source

Get the hull reinforcement for this module, taking in to account modifications

Return:

Number

the hull reinforcement of this module

public getIntegrity(): Number source

Get the integrity of this module, taking in to account modifications

Return:

Number

the integrity of this module

public getJitter(): Number source

Get the jitter for this module, taking in to account modifications

Return:

Number

the jitter for this module

public getKineticResistance(): Number source

Get the kinetic resistance for this module, taking in to account modifications

Return:

Number

the kinetic resistance of this module

public getMass(): Number source

Get the mass of this module, taking in to account modifications

Return:

Number

the mass of this module

public getMaxFuelPerJump(): Number source

Get the maximum fuel per jump for this module, taking in to account modifications

Return:

Number

the maximum fuel per jump of this module

public getMaxMass(): Number source

Get the maximum mass for this module, taking in to account modifications

Return:

Number

the maximum mass of this module

public getMaxMul(type: string): Number source

Get the maximum multiplier for this module, taking in to account modifications

Params:

Name	Type	Attribute	Description
type	string		the type for which we are obtaining the multiplier. Can be 'speed', 'rotation', 'acceleration', or null

Return:

Number

the maximum multiplier of this module

public getMinMass(): Number source

Get the minimum mass for this module, taking in to account modifications

Return:

Number

the minimum mass of this module

public getMinMul(type: string): Number source

Get the minimum multiplier for this module, taking in to account modifications

Params:

Name	Type	Attribute	Description
type	string		the type for which we are obtaining the multiplier. Can be 'speed', 'rotation', 'acceleration', or null

Return:

Number

the minimum multiplier of this module

public getModValue(name: Number, raw: Number): object source

Get a value for a given modification

Params:

Name	Type	Attribute	Description
name	Number		The name of the modification
raw	Number		True if the value returned should be raw i.e. without the influence of special effects

Return:

object

The value of the modification. If it is a numeric value then it is returned as an integer value scaled so that 1.23% == 123

public getOptMass(): Number source

Get the optimum mass for this module, taking in to account modifications

Return:

Number

the optimum mass of this module

public getOptMul(type: string): Number source

Get the optimum multiplier for this module, taking in to account modifications

Params:

Name	Type	Attribute	Description
type	string		the type for which we are obtaining the multiplier. Can be 'speed', 'rotation', 'acceleration', or null

Return:

Number

the optimum multiplier of this module

public getPiercing(): Number source

Get the piercing for this module, taking in to account modifications

Return:

Number

the piercing for this module

public getPowerGeneration(): Number source

Get the power generation of this module, taking in to account modifications

Return:

Number

the power generation of this module

public getPowerUsage(): Number source

Get the power usage of this module, taking in to account modifications

Return:

Number

the power usage of this module

public getProtection(): Number source

Get the protection for this module, taking in to account modifications

Return:

Number

the protection of this module

public getRange(): Number source

Get the range for this module, taking in to account modifications

Return:

Number

the range rate of this module

public getRangeT(): Number source

Get the range (in terms of seconds, for FSDI) for this module, taking in to account modifications

Return:

Number

the range of this module

public getRebuildsPerBay(): Number source

Get the rebuilds per bay for this module, taking in to account modifications

Return:

Number

the rebuilds per bay for this module

public getRegenerationRate(): Number source

Get the regeneration rate for this module, taking in to account modifications

Return:

Number

the regeneration rate of this module

public getReload(): Number source

Get the reload time for this module, taking in to account modifications

Return:

Number

the reload time of this module

public getRoF(): Number source

Get the rate of fire for this module, taking in to account modifications. The rate of fire is a combination value, and needs to take in to account bursts of fire. Firing goes [burst 1] [burst interval] [burst 2] [burst interval] ... [burst n] [interval] where 'n' is 'burst', 'burst interval' is '1/burstrof' and 'interval' is '1/rof'

Return:

Number

the rate of fire for this module

public getRoundsPerShot(): Number source

Get the rounds per shot for this module, taking in to account modifications

Return:

Number

the rounds per shot of this module

public getScanTime(): Number source

Get the scan time for this module, taking in to account modifications

Return:

Number

the scan time of this module

public getShieldBoost(): Number source

Get the shield boost for this module, taking in to account modifications

Return:

Number

the shield boost of this module

public getShieldReinforcement(): Number source

Get the shield reinforcement for this module, taking in to account modifications

Return:

Number

the shield reinforcement for this module

public getShotSpeed(): string source

Get the shot speed for this module, taking in to account modifications

Return:

string

the shot speed for this module

public getSpinup(): string source

Get the spinup for this module, taking in to account modifications

Return:

string

the spinup for this module

public getSystemsCapacity(): Number source

Get the systems capacity for this module, taking in to account modifications

Return:

Number

the systems capacity of this module

public getSystemsRechargeRate(): Number source

Get the systems recharge rate for this module, taking in to account modifications

Return:

Number

the systems recharge rate of this module

public getThermalEfficiency(): Number source

Get the thermal efficiency of this module, taking in to account modifications

Return:

Number

the thermal efficiency of this module

public getThermalLoad(): Number source

Get the thermal load for this module, taking in to account modifications

Return:

Number

the thermal load of this module

public getThermalResistance(): Number source

Get the thermal resistance for this module, taking in to account modifications

Return:

Number

the thermal resistance of this module

public getTime(): string source

Get the time for this module, taking in to account modifications

Return:

string

the time for this module

public getWeaponsCapacity(): Number source

Get the weapons capacity for this module, taking in to account modifications

Return:

Number

the weapons capacity of this module

public getWeaponsRechargeRate(): Number source

Get the weapons recharge rate for this module, taking in to account modifications

Return:

Number

the weapons recharge rate of this module

public setModValue(name: Number, value: object, valueiswithspecial: Boolean) source

Set a value for a given modification ID

Params:

Name	Type	Attribute	Description
name	Number		The name of the modification
value	object		The value of the modification. If it is a numeric value then it should be an integer scaled so that -2.34% == -234
valueiswithspecial	Boolean		true if the value includes the special effect (when coming from a UI component)

Private Methods

private _getModifiedValue(name: String): Number source

Helper to obtain a modified value using standard multipliers

Params:

Name	Type	Attribute	Description
name	String		the name of the modifier to obtain

Return:

Number

the mass of this module