References

app

summary
public	F Router(path: String, fn: Function) Register path with callback fn(), or route path`, or Router.start().

app/i18n

summary
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}
public	V formats: {"decimal": string, "thousands": string, "grouping": , "currency": , "dateTime": string, "date": string, "time": string, "periods": , "days": , "shortDays": , "months": , "shortMonths": *}

app/shipyard

summary
public	C Modification Modification - a modification and its value
public	C Module Module - active module in a ship's buildout
public	C ModuleSet The available module set for a specific ship
public	C Ship Ship Model - Encapsulates and models in-game ship behavior
private	F _sustainedDps(ship: Object, opponent: Object, opponentShields: Object, opponentArmour: Object, engagementrange: int): Object Calculate the sustained DPS for a ship against an opponent at a given range
private	F _weaponSustainedDps(m: Object, opponent: Object, opponentShields: Object, opponentArmour: Object, engagementrange: int): Object Calculate the sustained DPS for a weapon at a given range
public	F armourMetrics(ship: Object): Object Calculate armour metrics
public	F calcBoost(ship: Ship): number Calculate time from one boost to another
public	F calcPitch(mass: number, basePitch: number, thrusters: object, engpip: number, eng: number, boostFactor: number, boost: boolean): number Calculate pitch for a given setup
public	F calcRoll(mass: number, baseRoll: number, thrusters: ojbect, engpip: number, eng: number, boostFactor: number, boost: boolean): number Calculate roll for a given setup
public	F calcSpeed(mass: number, baseSpeed: number, thrusters: ojbect, engpip: number, eng: number, boostFactor: number, boost: boolean): number Calculate speed for a given setup
public	F calcYaw(mass: number, baseYaw: number, thrusters: ojbect, engpip: number, eng: number, boostFactor: number, boost: boolean): number Calculate yaw for a given setup
public	F defenceMetrics(ship: Object, opponent: Object, sys: int, opponentWep: int, engagementrange: int): Object Calculate defence metrics for a ship
public	F jumpRange(mass: number, fsd: object, fuel: number): number Calculate the maximum single jump range based on mass and a specific FSD
public	F offenceMetrics(ship: Object, opponent: Object, wep: int, opponentSys: int, engagementrange: int): array Calculate offence metrics for a ship
public	F pitch(mass: number, basePitch: number, thrusters: object, engpip: number): array Calculate pitch of a ship based on mass and thrusters
public	F roll(mass: number, baseRoll: number, thrusters: object, engpip: number): array Calculate roll of a ship based on mass and thrusters
public	F shieldMetrics(ship: Object, sys: int): Object Calculate shield metrics
public	F shieldStrength(mass: number, baseShield: number, sg: object, multiplier: number): number Calculate the a ships shield strength based on mass, shield generator and shield boosters used.
public	F speed(mass: number, baseSpeed: number, thrusters: object, engpip: number): array Calculate the a ships speed based on mass, and thrusters.
public	F sustainedDps(ship: Object, opponent: Object, sys: number, engagementrange: int): Object Calculate the sustained DPS for a ship against an opponent at a given range
public	F sysRechargeRate(pd: Object, sys: number): number Obtain the recharge rate of the SYS capacitor of a power distributor given pips
public	F sysResistance(sys: integer): integer Calculate the resistance provided by SYS pips
public	F timeToDeplete(amount: number, dps: number, eps: number, capacity: number, recharge: number): number Calculate the time to deplete an amount of shields or armour
public	F timeToDrainWep(ship: object, wep: number): number Calculate time to drain WEP capacitor
public	F totalJumpRange(mass: number, fsd: object, fuel: number): number Calculate the total jump range based on mass and a specific FSD, and all fuel available
public	F yaw(mass: number, baseYaw: number, thrusters: object, engpip: number): array Calculate yaw of a ship based on mass and thrusters
public	F bulkheadIndex(bulkheadName: String): number Get the bulkhead index for the given bulkhead name
public	F cargoHatch(): Object Created a cargo hatch model
public	F findHardpoint(groupName: String, clss: integer, rating: String, name: String, mount: String, missile: String): String Finds a hardpoint Module based on Class, Rating, Group and/or name.
public	F findHardpointId(groupName: String, clss: integer, rating: String, name: String, mount: String, missile: String): String Finds a hardpoint module ID based on Class, Rating, Group and/or name.
public	F findInternal(groupName: String, clss: integer, rating: String, name: String): Object Finds an internal module based on Class, Rating, Group and/or name.
public	F findInternalId(groupName: String, clss: integer, rating: String, name: String): String Finds an internal Module ID based on Class, Rating, Group and/or name.
public	F findMaxInternal(groupName: String, clss: integer, rating: String, name: String): Object Finds an internal module based on Class, Rating, Group and/or name.
public	F findModule(grp: String, id: String): Object Finds the module with the specific group and ID
public	F findStandard(groupName: String, clss: integer, rating: String, name: String): Object Finds a standard module based on Class, Rating, Group and/or name.
public	F findStandardId(groupName: String, clss: integer, rating: String, name: String): String Finds a standard Module ID based on Class, Rating, Group and/or name.
public	F forShip(shipId: String): ModuleSet Creates a new ModuleSet that contains all available modules that the specified ship is eligible to use.
public	F hardpoints(id: String): Object Finds the hardpoint with the specified ID
public	F internal(id: String): Object Finds the internal module with the specified ID
public	F isShieldGenerator(g: String): Boolean Determine if a module group is a shield generator
public	F standard(type: String \| Number, id: String): Object Finds the standard module type with the specified ID
public	F fromComparison(name: string, builds: array, facets: array, predicate: string, desc: boolean): string Serializes a comparion and all of the ships to zipped Base 64 encoded JSON.
public	F fromDetailedBuild(detailedBuild: Object): Ship Instantiates a ship from a ship-loadout object
public	F toComparison(code: string): Object Parses the comarison data string back to an object.
public	F toDetailedBuild(buildName: string, ship: Ship): Object Generates an object conforming to the ship-loadout JSON schema from a Ship model
public	F toDetailedExport(builds: Array): Array Generates an array of ship-loadout JSON Schema object for export
public	F explorer(ship: Ship, planetary: Boolean) Explorer Role
public	F miner(ship: Ship, shielded: Boolean) Miner Role
public	F multiPurpose(ship: Ship, shielded: Boolean, bulkheadIndex: integer) Standard / typical role for multi-purpose or combat (if shielded with better bulkheads)
public	F racer(ship: Ship) Racer Role
public	F trader(ship: Ship, shielded: Boolean, standardOpts: Object) Trader Role
public	V BulkheadNames: string[]
public	V Discounts: {"0%": number, "2.5%": number, "5%": number, "10%": number, "12.5%": number, "15%": number, "20%": number, "25%": number} Set of all available / theoretical discounts
public	V Insurance: {"standard": number, "alpha": number, "beta": number} Set of all insurance levels
public	V ModuleGroupToName: {"pp": string, "gpp": string, "gpd": string, "t": string, "fsd": string, "ls": string, "pd": string, "s": string, "ft": string, "pas": string, "fs": string, "sc": string, "am": string, "bsg": string, "cr": string, "fh": string, "fi": string, "hb": string, "hr": string, "mrp": string, "rf": string, "scb": string, "sg": string, "pv": string, "psg": string, "dc": string, "fx": string, "pc": string, "pce": string, "pci": string, "pcm": string, "pcq": string, "cc": string, "ss": string, "bl": string, "ul": string, "c": string, "ch": string, "cs": string, "cm": string, "ec": string, "fc": string, "rfl": string, "hs": string, "ws": string, "kw": string, "nl": string, "ml": string, "mr": string, "axmr": string, "pa": string, "po": string, "mc": string, "axmc": string, "pl": string, "rg": string, "sb": string, "tp": string, "sfn": string, "xs": string, "rcpl": string, "gpc": string, "ggc": string}
public	V ModuleNameToGroup: *
public	V MountMap: {"F": string, "G": string, "T": string, "Fixed": string, "Gimballed": string, "Turret": string}
public	V ShipFacets: Array Array of all Ship properties (facets) organized into groups used for ship comparisons.
public	V SizeMap: string[]
public	V StandardArray: string[]

app/stores

summary
public	C Persist Persist store / service for all user settings.
public	V persist: Persist

app/utils

summary
public	F comparisonBBCode(translate: Function, formats: object, facets: array, builds: object, link: string): string Generate a BBCode (Forum) compatible table from comparisons
public	F shipFromJson(json: object): Ship Build a ship from the companion API JSON
public	F shipModelFromJson(json: object): string Obtain a ship's model from the companion API JSON
public	F shipFromLoadoutJSON(json: object): Ship Build a ship from the journal Loadout event JSON
public	F shorternUrl(url: string, success: function, error: function) Shorten a URL
public	F outfitURL(shipId: String, code: String, buildName: String): String Generates a URL for the outiffing page
public	F fromUrlSafe(data: string): string Turn a URL-safe base-64 encoded string in to a normal version.
public	F isEmpty(obj: object): bool Check if an object is empty
public	F shallowEqual(objA: any, objB: any): boolean Compares A and B and return true using strict comparison (===)
public	F stopCtxPropagation(event: SyntheticEvent) Stop context menu / right-click propagation unless shift is held.
public	F wrapCtxMenu(cb: Function): Function Wraps the callback/context menu handler such that the default operation can proceed if the SHIFT key is held while right-clicked
public	V HARDPOINT_NUM_TO_CLASS: {"0": string, "1": string, "2": string, "3": string, "4": string}

Directories