Variables

EDDI Variables

EDDI provides variables that can be used by Speech Responder scripts.

A variable can be a simple value, such as environment, or an object, such as cmdr. Object properties are accessed from the parent object with a period, for example cmdr.name. Array / list object values can be accessed using an index between square brackets, for example inventory[<index\>].name.

The root variable list below identifies the roots available to scripts. The object reference documents each object shape once and lists the roots that use it, so shared object types such as system, lastsystem, and nextsystem do not repeat the same property descriptions.

Event-specific variables are available under the event object while editing an event script and are documented on each event page.

Root Variables

body - Details about the commander's current stellar body.
bookmarks - A list of saved navigation bookmarks.
bounties - The total value of outstanding bounties.
capi_active - True if the Frontier companion API is active.
cargoCarried - The total tons of cargo currently held.
carrier - Details about the commander's fleet carrier.
carrierPlottedRoute - The currently plotted fleet carrier route.
claims - The total value of outstanding bounty claims.
cmdr - Details about the current commander.
criminalrecord - A list of active fine, bounty, and claim records by faction.
destinationdistance - The distance to the destination system, in light years.
destinationsystem - Details about the destination star system.
environment - The commander's current environment.
fines - The total value of outstanding fines.
galacticPOIs - A list of nearby points of interest, ordered by distance.
goalsCount - The number of community goals you are engaged in.
homestation - Details about the commander's home station.
homesystem - Details about the commander's home system.
horizons - True if the current game session is Horizons.
icao_active - True if ICAO speech processing is enabled.
inventory - A list of the cargo currently held by the ship.
ipa_active - True if IPA speech processing is enabled.
lastStatus - The commander's previous status.
lastsystem - Details about the commander's previous star system.
materials - A list of all materials currently held by the commander.
maxStationDistance - The maximum station distance from the arrival star, in light seconds.
missions - A list of active missions.
missionsCount - The number of active non-shared missions.
missionWarning - You will receive a warning when a mission is within this many minutes from expiring.
navRoute - The current in-game route.
nextsystem - Details about the next star system in the plotted route.
odyssey - True if the current game session is Odyssey.
orbitalpriority - True if orbital stations are prioritized in station searches.
powerplaybountybonus - The Powerplay bounty claim bonus currently available, if any.
powerplaycrimereduction - The Powerplay crime reduction currently available, if any.
searchdistance - The active search distance, in light years.
searchstation - Details about the active search station.
searchsystem - Details about the active search star system.
ship - Details about the current ship.
shipPlottedRoute - The currently plotted ship route.
shiptargets - A list of recently targeted ships.
shipyard - A list of the commander's stored ships.
squadronCarrier - Details about the commander's squadron fleet carrier.
squadronsystem - Details about the current squadron's star system.
station - Details about the commander's current station.
status - The commander's current status.
storedmodules - A list of the commander's stored modules.
system - Details about the commander's current star system.
va_active - True if the VoiceAttack plug-in is active.
vehicle - The commander's current vehicle.
version - The current EDDI version.

Object reference

AtmosphereComposition

Used by: Body.atmospherecompositions[\<index\>]

composition - an element in the composition of the atmosphere (Ammonia, Nitrogen, Oxygen, Hydrogen, etc.) Obsolete: Please use localizedComposition or invariantComposition
invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
percent - percent share of the element in the atmosphere

Body

Used by: body, StarSystem.bodies[\<index\>]

absolutemagnitude - The absolute magnitude of the star
absolutemagnitudeprobability - the cumulative probability describing the star's absolute magnitude, relative to other stars of the same stellar class.
age - The age of the star, in millions of years
ageprobability - the cumulative probability describing the star's age, relative to other stars of the same stellar class.
alreadydiscovered - Whether you are the first commander to discover this body
alreadyfirstfootfalled - Whether you are the first commander to set foot on this body
alreadymapped - Whether you are the first commander to map this body
atmosphere - The localized atmosphere of the planet or moon Obsolete: Please use AtmosphereClass instead
atmospherecompositions - A list of the major elemental components of the atmosphere of the planet or moon See: AtmosphereComposition.
bodyId - The numeric ID of this body in the star system
bodyname - The name of the body
bodytype - The body type of the body (e.g. Star or Planet) Obsolete: For use with Cottle. Please use bodyType instead.
chromaticity - The localized color of the star
density - Density in Kg per cubic meter
densityprobability - the cumulative probability describing the body's density, relative to other bodies of the same planet type or stellar class.
distance - The distance of the body from the arrival star, in light seconds
earthmass - The mass of the planet or moon expressed relative to the mass of Earth
eccentricity - The orbital eccentricity of the planet
eccentricityprobability - the cumulative probability describing the body's orbital eccentricity, relative to other bodies of the same planet type or stellar class.
estimatedhabzoneinner - Minimum estimated single-star habitable zone (target black body temperature of 315°K / 42°C / 107°F or less, radius in km)
estimatedhabzoneouter - Maximum estimated single-star habitable zone (target black body temperature of 223.15°K / -50°C / -58°F or more, radius in km)
estimatedvalue - The estimated current value of the body to Universal Cartographics
footfalled - When you first set foot on this body, if you have, as a unix timestamp
gravity - The gravity of the planet or moon, in G's
gravityprobability - the cumulative probability describing the body's gravity, relative to other bodies of the same planet type.
inclination - The orbital inclination of the body, in degrees
inclinationprobability - the cumulative probability describing the body's orbital inclination, relative to other bodies of the same planet type or stellar class.
landable - True if this planet or moon can be landed upon
luminosity - The luminosity of the star
luminosityclass - the luminosity class of the star
mainstar - True if this star is the primary star for the star system
mapped - When you mapped this object, if you have, as a unix timestamp
mappedEfficiently - Whether you received an efficiency bonus when mapping this body
massprobability - the cumulative probability describing the body's mass, relative to other bodies of the same planet type or stellar class.
materials - The materials present at the surface of the planet or moon See: MaterialPresence.
maxestimatedvalue - The estimated maximum value of the body to Universal Cartographics (after scanning and mapping efficiently)
orbitalperiod - The orbital period of the body, in days
orbitalperiodprobability - the cumulative probability describing the body's orbital period, relative to other bodies of the same planet type or stellar class.
periapsis - The argument of periapsis, in degrees
periapsisprobability - the cumulative probability describing the body's argument of periapsis, relative to other bodies of the same planet type or stellar class.
planettype - The localized type of the planet or moon Obsolete: Please use PlanetClass instead
pressure - The pressure at the surface of the planet or moon, in Earth atmospheres
pressureprobability - the cumulative probability describing the body's atmospheric pressure, relative to other bodies of the same planet type.
radius - The radius of the body, in km
radiusprobability - the cumulative probability describing the body's radius, relative to other bodies of the same planet type or stellar class.
reserves - The localized mining mineral reserve level Obsolete: Please use reserveLevel instead
rings - The body's rings See: Ring.
rotationalperiod - The rotational period of the body, in days
rotationalperiodprobability - the cumulative probability describing the body's rotational period, relative to other bodies of the same planet type or stellar class.
scanned - When you scanned this object, if you have, as a unix timestamp
scoopable - True if you can scoop fuel from this star
semimajoraxis - The semi-major axis of the body, in light seconds
semimajoraxisprobability - the cumulative probability describing the body's semi-major axis, relative to other bodies of the same planet type or stellar class.
shortname - The short name of the body
solarday - The duration of a solar day on the body, in Earth days
solarmass - The mass of the star expressed relative to the mass of Sol
solarradius - The radius of the star expressed relative to the radius of Sol
solarsurfacevelocity - The ground speed of the parent body's shadow on the surface of the body in meters per second
solidcompositions - A list of the major elemental components of the solid features of the planet or moon See: SolidComposition.
stellarclass - The stellar class of the star
stellarsubclass - The stellar subclass of the star (0-9)
systemAddress - The unique numeric ID value for the star system
systemname - The name of the star system where the body resides
temperature - The surface temperature of the body, in Kelvin
tempprobability - the cumulative probability describing the body's temperature, relative to other bodies of the same planet type or stellar class.
terraformstate - The localized terraform state of the planet or moon Obsolete: Please use TerraformState instead
tidallylocked - True if this planet or moon is tidally locked
tilt - The axial tilt, in degrees
tiltprobability - the cumulative probability describing the body's orbital tilt, relative to other bodies of the same planet type or stellar class.
volcanism - The volcanism of the planet or moon, as an object See: Volcanism.

Boxel

Used by: StarSystemId64.boxel

boxelId - The numeric boxel ID.
boxelWidthLy - Boxel width in light years.
boxelX - Boxel X coordinate.
boxelY - Boxel Y coordinate.
boxelZ - Boxel Z coordinate.

Cargo

Used by: inventory[\<index\>]

category - category of the commodity (e.g. Foods, Machinery, Technology) Obsolete: Please use localizedCategory instead
commodity - object containing commodity details Obsolete: Please use commodityDef instead See: CommodityDefinition.
haulage - number of units currently on-board and related to a mission
missionCargo - A dictionary where the key is a mission ID and the value is the amount of cargo associated with that mission ID
name - name of the cargo (e.g. Tea) Obsolete: Please use localizedName or invariantName
need - number of units needed to satisfy all mission requirements associated with cargo
owned - number of units privately purchased or collected (not stolen or mission related)
price - price of an individual unit
stolen - number of units flagged as stolen
total - total number of units

CombatRating

Used by: Commander.combatrating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - rank, as an integer from 0 to 13

Commander

Used by: cmdr

combatrating - the commander's combat rating See: CombatRating.
cqcrating - the commander's CQC rating, as an object See: CQCRating.
credits - the number of credits the commander holds
debt - the amount of debt the commander owes
empirerating - the commander's empire rating, as an object See: EmpireRating.
engineers - the commander's relations with engineers, including any ranks or progression recorded during the play session (this is a list of Engineer objects) See: Engineer.
exobiologistrating - the commander's exobiologist rating, as an object See: ExobiologistRating.
explorationrating - the commander's exploration rating, as an object See: ExplorationRating.
federationrating - the commander's federation rating, as an object See: FederationRating.
friends - the commander's friends observed during the play session (this is a list of Friend objects) See: Friend.
gender - the gender of the commander, as selected in EDDI's configuration (string, either 'Male', 'Female' or 'Neither')
mercenaryrating - the commander's mercenary rating, as an object See: MercenaryRating.
name - the commander's name
phoneticname - the commander's name, using any phonetic pronunciation that has been set and is supported by the current voice
power - (if pledged) the power which the commander serves
squadronallegiance - the superpower allegiance of the commander's squadron (use squadronallegiance.name) See: Superpower.
squadronfaction - the faction within the squadron system to which the commander's squadron is aligned
squadronname - the commander's squadron name
squadronpower - the power (e.g. Aisling Duval) to which the commander's squadron pledges fealty (use squadronpower.name) See: Power.
squadronrank - the current squadron rank of the commander (this is a Rating object) See: SquadronRank.
squadronSystemAddress - the numeric address of the star system where the commander's squadron is based
squadronSystemName - the system name of the star system where the commander's squadron is based
squadrontag - the commander's squadron tag
traderating - the commander's trade rating, as an object See: TradeRating.

CommodityAmount

Used by: Ring.hotspots[\<index\>]

amount - amount
commodity - localized commodity name

CommodityDefinition

Used by: Cargo.commodity, Mission.CommodityDefinition, Station.prohibited[\<index\>]

avgprice - The latest known average market price for the commodity
category - the category of the commodity (e.g. Foods, Machinery, Technology)
corrosive - True if the commodity is known to be corrosive
invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rare - True if the commodity is a rare market commodity

CommodityMarketQuote

Used by: Station.commodities[\<index\>], Station.exports[\<index\>], Station.imports[\<index\>]

avgprice - the average price offered for this commodity in a legal market
buyprice - the price to purchase the commodity from the market
category - the category of the commodity (e.g. Foods, Machinery, Technology) Obsolete: Please use localizedName or InvariantName
demand - the demand for the commodity from the market
name - the localized name of the commodity Obsolete: deprecated for UI usage but retained for JSON conversion from the cAPI
rare - the rarity of the commodity (boolean true or false)
sellprice - the price being offered for the commodity in the market
stock - the amount of the commodity available from the market

Compartment

Used by: Ship.compartments[\<index\>]

module - the module in the compartment, as an object See: Module.
size - the numeric size of the compartment, from 1 to 8

Conflict

Used by: StarSystem.conflicts[\<index\>]

conflictdays - the number of days that the conflict has been ongoing
faction1 - the name of the first faction in the conflict
faction1dayswon - the number of days that the first faction has won
faction2 - the name of the second faction in the conflict
faction2dayswon - the number of days that the second faction has won
margin - the difference between the number of days won by one faction vs. the other
stake - the system asset at stake in the conflict (if any)
state - the faction state of the factions in conflict (e.g. war, civil war, or election)
status - the status of the conflict

CQCRating

Used by: Commander.cqcrating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - the numeric rank, from 0 to 13

Economy

Used by: StarSystem.Economies[\<index\>]

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

EmpireRating

Used by: Commander.empirerating

feminineInvariantName - the invariant feminine name
femininename - the localized feminine name
invariantName - the invariant masculine name
name - the localized masculine name

Engineer

Used by: Commander.engineers[\<index\>]

bodyId - the numeric ID of the body where the engineer is located
bodyname - the name of the body where the engineer is located
majorSpecialties - the major specialties of the engineer, as objects See: EngineerSpecialty.
marketId - the ID of the market where the engineer is located
minorSpecialties - the minor specialties of the engineer, as objects See: EngineerSpecialty.
name - the name of the engineer
rank - the current rank of your relationship with the engineer
rankprogress - your progress towards the next rank in your relationship with the engineer
stage - the progress stage of your relationship with the engineer
stationname - the name of the station where the engineer is located
systemAddress - the numeric address of the system where the engineer is located
systemname - the name of the system where the engineer is located

EngineerSpecialty

Used by: Engineer.majorSpecialties[\<index\>], Engineer.minorSpecialties[\<index\>]

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

ExobiologistRating

Used by: Commander.exobiologistrating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - the numeric rank, from 0 to 13

ExplorationRating

Used by: Commander.explorationrating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - the numeric rank, from 0 to 13

Faction

Used by: StarSystem.Faction, StarSystem.factions[\<index\>], Station.Faction

Allegiance - The allegiance of the faction, if known, as an object See: Superpower.
Government - The government of the faction, if known, as an object See: Government.
myreputation - Your reputation with the faction, out of 100%
name - The name of the faction
presences - A list of FactionPresence objects. Unless called from the FactionDetails() function, only details from the current system will be included here See: FactionPresence.
squadronfaction - True if the faction is the pilot's current squadron faction

FactionPresence

Used by: Faction.presences[\<index\>]

ActiveStates - (For recently visited systems only) A list of FactionState objects See: FactionState.
FactionState - The faction's current dominant state in this system, as an object See: FactionState.
Happiness - (For recently visited systems only) The current happiness level of the faction within the system, as an object See: Happiness.
influence - The faction's influence level within the system, as a percentage
PendingStates - (For recently visited systems only) A list of pending FactionState objects and trend values See: FactionTrendingState.
RecoveringStates - (For recently visited systems only) A list of recent prior FactionState objects and trend values See: FactionTrendingState.
squadronhomesystem - (For recently visited systems only) True if the faction is the pilot's current squadron faction
state - The faction's current (localized) dominant state in this system Obsolete: Please use FactionState instead
systemAddress - The unique 64 bit system address where this faction has a presence
systemName - The system name where this faction hasa presence

FactionRecord

Used by: criminalrecord[\<index\>]

allegiance - the superpower to which the minor faction is aligned, if any
basebounties - journal credits for minor faction's unpaid bounties incurred
basebountyclaims - journal credits for the minor faction's uncollected bounty voucher rewards only before known current voucher modifiers
baseclaims - journal credits for minor faction's uncollected bounty voucher and combat bond rewards before known current voucher modifiers
basefines - journal credits for minor faction's unpaid fines incurred
bondsAwarded - list of individual faction reports for uncollected bonds awarded See: FactionReport.
bounties - total journal credits for minor faction's unpaid bounties incurred, including any reductions already applied by the game
bountiesAwarded - list of individual faction reports for uncollected bounties awarded See: FactionReport.
bountiesIncurred - list of individual faction reports for unpaid bounties incurred See: FactionReport.
bountyclaims - estimated final credits for the minor faction's uncollected bounty voucher rewards only, after known current voucher modifiers
claims - estimated final credits for minor faction's uncollected bounty voucher and combat bond rewards, after known current voucher modifiers. Pending claim values do not subtract NPC crew wages.
faction - name of the minor faction
fines - total journal credits for minor faction's unpaid fines incurred, including any reductions already applied by the game
finesIncurred - list of individual faction reports for unpaid fines incurred See: FactionReport.
station - station nearest to main star, filtered by landing pad & ship size
system - faction presence determined by minor faction name or highest influence

FactionReport

Used by: FactionRecord.bondsAwarded[\<index\>], FactionRecord.bountiesAwarded[\<index\>], FactionRecord.bountiesIncurred[\<index\>], FactionRecord.finesIncurred[\<index\>]

amount - the amount of credits associated with the voucher
body - the body near which the voucher was claimed
bounty - true if the report is for a bounty (false indicates a bond)
claimtype - type of voucher claim: 'bond' or 'bounty'
claimvehicle - the vehicle in which the voucher was claimed
crime - localized type of crime committed, 'None' when report is a claim Obsolete: Please use localizedCrime instead
station - the station near which the voucher was claimed
system - the system in which the voucher was claimed
victim - the victim of the voucher
victimAllegiance - the allegiance of the victim

FactionState

Used by: FactionPresence.ActiveStates[\<index\>], FactionPresence.FactionState, FactionTrendingState.factionState, SignalSource.spawningState, ThargoidWar.CurrentState, ThargoidWar.FailureState, ThargoidWar.SuccessState

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

FactionTrendingState

Used by: FactionPresence.PendingStates[\<index\>], FactionPresence.RecoveringStates[\<index\>]

factionState - The faction state being tracked. See: FactionState.
trend - The recent trend for the faction state.

FederationRating

Used by: Commander.federationrating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - the numeric rank, from 0 to 14

FleetCarrier

Used by: carrier, squadronCarrier

bankAvailableBalance - The last reported available bank balance of the carrier
bankBalance - The last reported bank balance of the carrier
bankReservedBalance - The last reported reserved bank balance of the carrier
callsign - The callsign (alphanumeric designation) of the carrier (requires Frontier API access or a 'Carrier Stats' event)
currentBodyID - The numeric ID of the body the carrier is orbiting
currentStarSystem - The current location (star system) of the carrier
currentStarSystemAddress - The numeric system address of the star system where the carrier is located
dockingAccess - The carrier's last reported docking access (one of one of 'all', 'squadronfriends', 'friends', or 'none')
freeCapacity - The last reported free capacity of the carrier
fuel - The last reported tritium fuel level of the carrier
fuelInCargo - The last reported amount of stored tritium held in the carrier's cargo (requires Frontier API access)
jumpRangeMax - The maximum single jump range of the carrier in light years
Market - Market details for this fleet carrier
name - The name of the carrier (requires Frontier API access or a 'Carrier Stats' event)
nextBodyID - The numeric ID of the next scheduled body the carrier shall orbit
nextStarSystem - The next scheduled location (star system) of the carrier, if any
nextStarSystemAddress - The numeric system address of the next scheduled star system where the carrier shall be located
notoriousAccess - True if the last reported state permits docking access by notorious commanders
state - The carrier's current operating state (requires Frontier API access) (one of 'normalOperation', 'debtState' (if services are offline due to lack of funds), or 'pendingDecommission')
usedCapacity - The last reported total used capacity of the carrier

Friend

Used by: Commander.friends[\<index\>]

name - the name of the friend
status - the status of the friend (one of the following: Requested, Declined, Added, Lost, Offline, Online)

GalacticRegion

Used by: StarSystemId64.region

regionId - The stellar numeric region ID.
regionName - The stellar region name.

Government

Used by: Faction.Government

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Happiness

Used by: FactionPresence.Happiness

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Hardpoint

Used by: Ship.hardpoints[\<index\>]

module - the module in the hardpoint See: Module.
size - the numeric size of the hardpoint, from 0 (utility) to 4 (huge)

LaunchBay

Used by: Ship.launchbays[\<index\>]

size - the numeric size of the launchbay
type - the type of launchbay, 'SRV' or 'Vessel'
vehicles - the vehicles within the launchbay (this is an array of vehicle objects) See: Vehicle.

MaterialAmount

Used by: materials[\<index\>]

amount - the amount
category - the material's localized category
desired - your desired amount
material - the material's localized name
maximum - your maximum amount
minimum - your minimum amount
Rarity - the material's rarity, as an object See: Rarity.

MaterialPresence

Used by: Body.materials[\<index\>]

category - the material's localized category
name - the material's localized name
percentage - the percentage of the material
rarity - the material's localized rarity

MercenaryRating

Used by: Commander.mercenaryrating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - the numeric rank, from 0 to 13

MicroResource

Used by: Mission.MicroResourceDefinition

category - The localized category name
invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Mission

Used by: missions[\<index\>]

amount - The amount of the commodity or micro-resource required to complete the mission.
cargodepot - true if the mission delivers to a cargo depot
collected - The quantity of mission cargo which has been collected at a cargo depot
commodity - The localized name of the commodity required to complete the mission, as applicable
CommodityDefinition - The commodity object for the commodity required to complete the mission, as applicable See: CommodityDefinition.
communal - true if the mission is a communnity goal
communalContribution - (for community goals) the amount contributed
communalPercentileBand - (for community goals) the percentile band for your current contributions
communalTier - (for community goals) the current award tier
delivered - The quantity of mission cargo which has been delivered to a cargo depot
destinationstation - destination station of the mission (if applicable)
destinationsystem - destination system of the mission (if applicable)
destinationsystems - list of destination systems for missions with multiple destinations See: NavWaypoint.
expiry - the date and time when the mission expires, as a DateTime object
expiryseconds - amount of seconds remaining before mission expiration
faction - the faction sponsoring the mission
influence - faction influence gained upon successful completion
invariantTags - invariant tags (altruism, delivery, massacre, etc) describing the mission, as a list
legal - true if the mission is legal
localisedname - localised name of the mission
microresource - The localized name of the micro-resource required to complete the mission, as applicable
MicroResourceDefinition - The micro-resource object for the micro-resource required to complete the mission, as applicable See: MicroResource.
missionid - the numeric ID of the mission
name - name of mission
notes - notes you have recorded about the mission.
originreturn - true if the commander must return to origin to complete the mission
originstation - the station in which the mission was accepted
originsystem - the system in which the mission was accepted
passengertype - localized type of passengers (celebrity, doctor, etc) in the mission (if applicable)
passengervips - true if the passengers are VIPs
passengerwanted - true if the passengers are wanted
reputation - faction reputation gained upon successful completion
reward - Credits awarded upon successful completion
shared - true if the mission is shared
sourcebody - The body or station where the mission cargo has been found, as applicable
sourcesystem - The system where the mission cargo has been found, as applicable
status - localized status (active, complete, failed) of the mission Obsolete: Please use localizedName or invariantName
tags - localized tags (altruism, delivery, massacre, etc) describing the mission, as a list
target - the target of the mission (if applicable)
targetfaction - name of the faction of the target of the mission (if applicable)
targettype - localized type of the target (civilian, pirate, etc) of the mission (if applicable)
type - Obsolete: type has been deprecated in favor of tags Obsolete: type has been deprecated in favor of tags
wing - true if the mission allows wing-mates

Module

Used by: Compartment.module, Hardpoint.module, Ship.bulkheads, Ship.canopy, Ship.cargohatch, Ship.frameshiftdrive, Ship.fueltank, Ship.lifesupport, Ship.powerdistributor, Ship.powerplant, Ship.sensors, Ship.thrusters, Station.outfitting[\<index\>], StoredModule.module

ammoinclip - only for weapons, this defines the amount of ammunition present in the clip during the last Loadout event
ammoinhopper - only for weapons, this defines the amount of ammunition present in the hopper during the last Loadout event
class - numeric class of the module
clipcapacity - only for weapons, this defines the maximum amount of ammunition the clip can hold
enabled - whether the module is enabled
engineerlevel - the level of the engineering modification
engineerquality - the percent quality of the engineering modification
grade - letter grade of the module
health - the last reported health of the module, as a percentage
hoppercapacity - only for weapons, this defines the maximum amount of ammunition the hopper can store
hot - whether the module is legally 'hot'
invariantName - The invariant English name.
mercPrice - the price paid for the module, in merc coins
modification - the localized name of the engineering modification Obsolete: Please use localizedModification instead
modified - whether the module has been modified
mount - only for weapons, this defines the type of mount (fixed, gimballed, turreted)
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
position - the position of the module in the Modules panel, sorted according to power usage
power - the power consumption of the module, measured in MegaWatts (MW)
price - the price paid for the module, in credits
priority - the power priority of the module
value - base value of the module, in credits

NavWaypoint

Used by: Mission.destinationsystems[\<index\>]

systemAddress - the unique numeric address of the star system
systemName - the name of the star system
x - the x-coordinate of the star system
y - the y-coordinate of the star system
z - the z-coordinate of the star system

Power

Used by: Commander.squadronpower, StarSystem.ContestingPowers[\<index\>], StarSystem.NearbyPowers[\<index\>], StarSystem.Power

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

PowerplayState

Used by: StarSystem.powerState

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Rarity

Used by: MaterialAmount.Rarity

invariantName - The invariant English name.
level - the level of the rarity (0 == Very common, 5 == Very rare)
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

ReserveLevel

Used by: StarSystem.Reserve

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Ring

Used by: Body.rings[\<index\>]

composition - the composition of the ring Obsolete: Please use localizedComposition or invariantComposition
hotspots - a list of ring hotspots (as objects with properties 'commodity' and 'amount'), available for mapped rings only See: CommodityAmount.
innerradius - the inner radius of the ring, in km
mapped - a DateTime value that is set when the ring is mapped and unset otherwise.
mass - the mass of the ring, in megatons
name - the name of the ring
outerradius - the outer radius of the ring, in km

SecurityLevel

Used by: StarSystem.securityLevel

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Ship

Used by: ship, shipyard[\<index\>], Station.shipyard[\<index\>]

bulkheads - details of the ship's bulkheads (this is a Module object) See: Module.
canopy - details of the ship's canopy (this is a Module object) See: Module.
cargocapacity - the total tonnage cargo capacity
cargohatch - details of the ship's cargo hatch (this is a Module object) See: Module.
compartments - the ship's internal compartments (this is an array of Compartment objects) See: Compartment.
distance - The distance to the ship in light years
frameshiftdrive - details of the ship's FSD (this is a Module object) See: Module.
fueltank - details of the ship's fuel tank (this is a Module object) See: Module.
fueltankcapacity - the capacity of the main fuel tank
fueltanktotalcapacity - the capacity of the main fuel tank plus all secondary fuel tanks
hardpoints - the ship's hardpoints (this is an array of HardPoint objects) See: Hardpoint.
health - the last reported health of the hull, from 0 to 100
hot - true if the ship is wanted
hullvalue - The value of the ship's hull (less modules), in credits
ident - the identifier of the ship
intransit - true if the ship is already in transit
launchbays - the ship's internal hangars, containing SRV or Fighter 'vehicles' (this is an array of launchbay objects) See: LaunchBay.
lifesupport - details of the ship's life support (this is a Module object) See: Module.
manufacturer - the manufacturer of the ship (Lakon, Core Dynamics etc)
marketid - market ID of the station in which the ship is stored
maxfuelperjump - fuel required for a maximum range jump (excluding synthesis)
maxjumprange - maximum unladen jump range of the ship
model - the model of the ship (Cobra Mk III, Fer-de-Lance etc)
modulesvalue - The value of the ship's modules (less hull), in credits
name - the name of the ship
phoneticmanufacturer - the manufacturer of the ship, using any phonetic pronunciation that has been set and is supported by the current voice
phoneticmodel - the model of the ship, using any phonetic pronunciation that has been set and is supported by the current voice
phoneticname - the name of the ship, using any phonetic pronunciation that has been set and is supported by the current voice
powerdistributor - details of the ship's power distributor (this is a Module object) See: Module.
powerplant - details of the ship's powerplant (this is a Module object) See: Module.
rebuy - The rebuy value of the ship, in credits
role - the role of the ship Obsolete: Please use localizedName or invariantName
sensors - details of the ship's sensors (this is a Module object) See: Module.
size - the size of the ship (small/medium/large)
starsystem - system in which the ship is stored
station - station in which the ship is stored
thrusters - details of the ship's thrusters (this is a Module object) See: Module.
transferprice - the price of transferring the ship to the current location
transfertime - the time to transfer ship to current location (0 if in transit), in seconds
value - the value of the ship without cargo, in credits

SignalSource

Used by: StarSystem.signalSources[\<index\>]

invariantName - The invariant English name.
isStation - whether the signal is associated with a station
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
opposingPower - the localized name of the power that is opposing the signal, if any
signalType - the type of the signal, as an object See: SignalType.
spawningFaction - the faction that spawned the signal, if any
spawningPower - the localized name of the power that spawned the signal, if any
spawningState - the faction state associated with the signal, if any, as an object See: FactionState.
threatLevel - the level of threat posed by the signal, if any

SignalType

Used by: SignalSource.signalType

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

SolidComposition

Used by: Body.solidcompositions[\<index\>]

composition - an solid type in the composition of the body (Ice, Rock, or Metal) Obsolete: Please use localizedComposition or invariantComposition
invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
percent - percent share of the element in the solid body

SquadronRank

Used by: Commander.squadronrank

invariantName - The invariant name of the squadron rank.
localizedName - The localized name of the squadron rank.
rankID - The numeric squadron rank ID.

StarSystem

Used by: destinationsystem, homesystem, lastsystem, nextsystem, searchsystem, squadronsystem, system

allegiance - The localized superpower alleginace of the star system controlling faction, if any Obsolete: Please use Faction.Allegiance instead
bodies - The star system's bodies (stars/planets/moons), as an array of Body objects See: Body.
carriersignalsources - (For the current star system only) A list of fleet carrier signals detected within the star system
comment - Any comment the commander has made on the starsystem (via VoiceAttack or EDSM entry)
conflicts - Faction conflicts data. Currently only available for recently visited star systems. See: Conflict.
ContestingPowers - Powerplay powers with at least 30% progress towards acquiring control of an uncontrolled star system, if any, as objects, in descending order See: Power.
distancefromhome - The distance in LY from the commander's home star system
Economies - The economies in this star system (High Technology, Agriculture, etc), as objects See: Economy.
estimatedvalue - The estimated exploration value of the star system (including bonuses for fully scanning and mapping)
Faction - The star system controlling faction, if any, as an object See: Faction.
factions - The star system's factions, if any, as objects See: Faction.
government - The localized government of the star system controlling faction, if any Obsolete: Please use Faction.Government instead
id64 - Metadata encoded into the unique 64 bit ID for the star system. See: StarSystemId64.
isgold - True if bodies in this star system contain all elements available from surface prospecting
isgreen - True if bodies in this star system contain all elements required for FSD synthesis
lastVisitSeconds - The time that the commander last visited this star system, expressed as a Unix timestamp in seconds
mappedbodies - The total number of bodies you have mapped within the system
NearbyPowers - Powerplay powers having star systems with acquisition radii which overlap the star system, less the controlling power, if any, as objects See: Power.
orbitalstations - The star system's stations, filtered to only return dockable and permanent orbital stations (array of Station objects) See: Station.
planetarystations - The star system's stations, filtered to only return dockable and permanent planetary stations (array of Station objects) See: Station.
population - The population of the star system
Power - The powerplay power controlling the star system, if any, as an object. See: Power.
powerAcquisitionProgress - The progress of nearby powerplay powers towards obtaining control of the star system, as a list of objects with keys Power (as an object) and progress (as a percent)
powerControlProgress - The percent progress of the controlling power, if any, in consolidating control over the star system. Values below 0% indicate a reduction in the control level at the end of the cycle while values above 100% indicate an increase in the control level at the end of the cycle (if the current control state is less than 'Stronghold')
powerReinforcementControlPoints - The control points accumulated by the controlling power via powerplay reinforcement activities during the current cycle
powerState - The state of powerplay efforts within the star system, as an object See: PowerplayState.
powerUnderminingControlPoints - The control points lost by the controlling power via powerplay undermining activities during the current cycle
primaryeconomy - The localized primary economy in this star system (High Technology, Agriculture, etc)
requirespermit - Whether this system requires a permit to enter (as a boolean)
Reserve - The reserve level applicable to the system's rings, as an object See: ReserveLevel.
reserves - The localized reserve level applicable to the system's rings
scannedbodies - The total number of bodies you have scanned within the system
scoopable - True if a fuel scoop equipped ship can refuel at at least one star in this star system
security - The localized security level in the star system (Low, Medium, High)
securityLevel - The security level in the star system, as an object See: SecurityLevel.
signalSources - (For the current star system only) A list of signals detected within the star system, as objects See: SignalSource.
state - The state of the star system's controlling faction (Boom, War, etc)
stations - The star system's stations (as an array of Station objects) See: Station.
surfaceelements - the elements available from bodies in this starsystem (as an array of localized material names)
systemAddress - The unique 64 bit ID for the star system
systemname - The name of the star system
ThargoidWar - Thargoid war data. Currently only available for recently visited star systems. See: ThargoidWar.
totalbodies - The total number of discoverable bodies within the system (only available after a discovery scan)
updatedat - the timestamp at which the system information was last updated, expressed as a Unix timestamp in seconds
visits - The number of visits that the commander has made to this star system
x - The 'X' coordinates of the star system
y - The 'Y' coordinates of the star system
z - The 'Z' coordinates of the star system

StarSystemId64

Used by: StarSystem.id64

boxel - Boxel data, as an object. See: Boxel.
massCode - The mass code for the star system (ranging from 'H' to 'A' with 'H' tending to contain high mass star systems and 'A' tending to contain low mass systems).
region - Region data, as an object. See: GalacticRegion.
sizeClass - The integer equivalent of the mass code for the star system (ranging from 0 to 7 with 0 tending to contain high mass star systems and 7 tending to contain low mass systems).

Station

Used by: homestation, searchstation, StarSystem.orbitalstations[\<index\>], StarSystem.planetarystations[\<index\>], StarSystem.stations[\<index\>], station

allegiance - the superpower allegiance of the faction that controls this station (Federation, Empire etc) Obsolete: Please use Faction.Allegiance instead
commodities - the commodities that are bought and sold by this station (array of Commodity objects) See: CommodityMarketQuote.
commoditiesupdatedat - the timestamp at which the station commodities information was last updated
distancefromstar - the distance from the main star to this station (in light years)
exports - the commodities that are sold by this station (array of Commodity objects) See: CommodityMarketQuote.
Faction - the faction that controls this station, as an object See: Faction.
government - the type of government in this station (Democracy, Confederacy etc) Obsolete: Please use Faction.Government instead
hasblackmarket - true if this station has a black market
hasmarket - true if this station has a market
hasoutfitting - true if this station has outfitting
hasrearm - true if this station has rearming
hasrefuel - true if this station has refuelling
hasrepair - true if this station has repairs
hasshipyard - true if this station has a shipyard
imports - the commodities that are bought by this station (array of Commodity objects) See: CommodityMarketQuote.
landingPads - the landing pads available at this station, as objects
largestpad - the localized largest pad available at this station (None, Small, Medium, Large) Obsolete: Please use LargestPad instead
localizedName - the localized name of the station, if any
marketId - the unique numeric ID for this station
model - the model of the station (Orbis, Coriolis, etc) Obsolete: Please use Model instead
name - the name of the station
outfitting - the modules that are available for outfitting at this station (array of Module objects) See: Module.
primaryeconomy - the primary economy in this station (High Technology, Agriculture, etc)
prohibited - the commodities prohibited by the station (array of Commodity objects, requires Frontier API access) See: CommodityDefinition.
secondaryeconomy - the secondary economy in this station (if any)
shipyard - the ships that are available for purchase at this station (array of Ship objects) See: Ship.
state - the state of the station (Boom, War, etc) Obsolete: Please use Faction.factionState instead
stationServices - a list of the station services available at this station, as objects See: StationService.
systemAddress - the unique numeric ID for the system in which this station resides
systemname - the name of the system in which this station resides
updatedat - the timestamp at which the station information was last updated

StationService

Used by: Station.stationServices[\<index\>]

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Status

Used by: lastStatus, status

aim_down_sight - true if you are on foot and aiming through a scope.
altitude - a decimal value indicating the ship's current altitude (if in flight near a surface)
altitude_from_average_radius - true if the altitude is computed relative to the average radius (which is used at higher altitudes) rather than surface directly below the srv
analysis_mode - a boolean value indicating whether the ship's HUD is currently in Analysis Mode
being_interdicted - a boolean value indicating whether the commander is currently being interdicted
bodyname - the name of the current body (if landed or in an srv)
breathable_atmosphere - true if you are on foot in an area with a breathable atmosphere.
cargo_carried - the tons of cargo you are currently carrying
cargo_scoop_deployed - a boolean value indicating whether the cargo scoop has been deployed
credit_balance - the current credit balance of the commander, if available.
destination_localized_name - the localized name of the currently selected destination, if available
destination_name - the name of the currently selected destination (including in-system destinations)
docked - a boolean value indicating whether the ship is currently docked (at a station)
engine_pips - a decimal value indicating the power distributor allocation to engines
firegroup - an integer value indicating the ship's currently selected firegroup
flight_assist_off - a boolean value indicating whether flight assistance has been deactivated
fsd_cooldown - a boolean value indicating whether the FSD is currently cooling down after a jump to hyperspace or supercruise.
fsd_hyperdrive_charging - a boolean value indicating whether the FSD is currently charging for a jump to hyperspace.
fsd_mass_locked - a boolean value indicating whether the FSD is currently mass locked.
fsd_status - The current status of the ship's frame shift drive as a string. Can be one of "ready", "cooldown", "charging", "masslock", "hyperspace", or "supercruise"
fsd_supercruise_assist - a boolean value indicating whether FSD supercruise assist (SCA) mode is activated.
fsd_supercruise_boosting - a boolean value indicating whether FSD supercruise overdrive (SCO) mode is activated.
fsd_supercruise_charging - a boolean value indicating whether the FSD is currently charging for a jump to supercruise.
fuel - a decimal value indicating the ship's current fuel (including fuel in the active fuel reservoir)
fuel_percent - a decimal percent value calculated from your current total fuel capacity
fuel_seconds - an integer value projecting the time remaining before you run out of fuel, in seconds
gliding - true if your ship is in glide mode near a planet surface.
gravity - a decimal value indicating the surface gravity relative to 1G (when on foot)
gui_focus - the commander's current focus. Can be one of: "none", "internal panel" (right panel), "external panel" (left panel), "communications panel" (top panel), "role panel" (bottom panel), "station services", "galaxy map", "system map", "orrery", "fss mode", "saa mode", or "codex"
hardpoints_deployed - a boolean value indicating whether hardpoints are currently deployed
heading - a decimal value indicating the ship's current heading (if near a surface)
health - a decimal value (0-100) indicating your current health level (when on foot)
hyperspace - a boolean value indicating whether the ship is currently jumping between star systems
in_danger - a boolean value indicating whether the commander is currently in danger
in_wing - a boolean value indicating whether the commander is currently in a wing
landed - a boolean value indicating whether the ship is currently landed (on a surface)
landing_gear_down - a boolean value indicating whether the ship's landing gears have been deployed
latitude - a decimal value indicating the ship's current latitude (if near a surface)
legalstatus - the ship's current legal status. Can be one of "Clean", "Illegal cargo", "Speeding", "Wanted", "Hostile", "Passenger wanted", or "Warrant"
lights_on - a boolean value indicating whether the vehicle's external lights are active
longitude - a decimal value indicating the ship's current longitude (if near a surface)
low_fuel - a boolean value indicating whether the commander has less than 25% fuel remaining
low_health - true if you are on foot and health is running low.
low_oxygen - true if you are on foot and oxygen is running low.
near_surface - a boolean value indicating whether the commander is near a landable surface (within it's gravity well)
night_vision - a boolean value indicating whether night vision is currently active
npc_crew_active - true if at least one NPC crew member is assigned to active duty on your ship.
on_foot_exterior - true if you've disembarked to an exterior space.
on_foot_in_hangar - true if you've disembarked in a vehicle hangar.
on_foot_in_station - true if you've disembarked at a station.
on_foot_on_planet - true if you've disembarked on a planet surface.
on_foot_social_space - true if you've disembarked to a social space (e.g. station concourse).
on_foot_temperature - the environment temperature when on foot. May be one of "very cold", "cold", "temperate", "hot", or "very hot".
overheating - a boolean value indicating whether the commander's vehicle is overheating
oxygen - a decimal value (0-100) indicating your current oxygen level (when on foot)
physical_multicrew - true if you are participating in physical multicrew.
planetradius - the radius of the current body in meters (if landed or in an srv)
scooping_fuel - a boolean value indicating whether the ship is currently scooping fuel
selected_weapon - the model of your current selected weapon (when on foot)
shields_up - a boolean value indicating whether the ship's shields are maintaining their integrity
silent_running - a boolean value indicating whether silent running is active
slope - a decimal value indicating the ship's current slope relative to the horizon (if near a surface)
srv_drive_assist - a boolean value indicating whether SRV drive assist is active
srv_handbrake_activated - a boolean value indicating whether the SRV's handbrake has been activated
srv_high_beams - true if the lights in your SRV are set to the high beam mode.
srv_turret_deployed - a boolean value indicating whether the SRV's turret has been deployed
srv_under_ship - a boolean value indicating whether the SRV in within the proximity zone around the ship
supercruise - a boolean value indicating whether the ship is currently in supercruise
system_pips - a decimal value indicating the power distributor allocation to systems
telepresence_multicrew - true if you are participating in telepresence multicrew.
temperature - a decimal value indicating the current surface temperature in Kelvin (when on foot)
vehicle - the vehicle that is under the commander's control. Can be one of "Ship", "SRV", "Fighter", "On Foot", "Taxi", and "Multicrew"
weapon_pips - a decimal value indicating the power distributor allocation to weapons

StoredModule

Used by: storedmodules[\<index\>]

intransit - true if the module is currently in transit
marketid - the market ID where the module is stored
module - the module being stored, as an object See: Module.
name - localized name of the module
slot - the storage slot where the module is assigned
station - the station where the module is stored
system - the system where the module is stored
transfercost - the cost of transferring the module, in credits
transfertime - the time required to transfer the module, in seconds

Superpower

Used by: Commander.squadronallegiance, Faction.Allegiance

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName

Target

Used by: shiptargets[\<index\>]

allegiance - superpower to which the minor faction is aligned
bounty - the bounty assigned to the target
faction - the faction to which the pilot is aligned
legalstatus - the legal status (clean, enemy, wanted, warrant, etc) of the pilot
name - the name of the target
power - power ( Aisling Duval, Yuri Grom, Denton Patreus, etc) to which the pilot is pledged
rank - rank of the pilot
ship - the model of the ship

ThargoidWar

Used by: StarSystem.ThargoidWar

CurrentState - The current phase of the Thargoid war, as a localizable object. See: FactionState.
FailureState - The next phase of the Thargoid war, if success is not achieved, as a localizable object. See: FactionState.
progress - Percent progress in achieving a success state in the current phase of the Thargoid war. Progress can decrease if success is not reached before the weekly 'tick'.
remainingDays - The number of remaining days in the current phase of the Thargoid war.
remainingPorts - The number of ports which have not yet fallen into Thargoid control.
succeeded - True if commanders have achieved a success state in the current phase of the Thargoid war.
SuccessState - The next phase of the Thargoid war, if success is achieved, as a localizable object. See: FactionState.

TradeRating

Used by: Commander.traderating

invariantName - The invariant English name.
name - The localized name. Obsolete: Please be explicit and use localizedName or invariantName
rank - the numeric rank of the trade rating, from 0 to 13

Vehicle

Used by: LaunchBay.vehicles[\<index\>]

description - the localized description of the vehicle's loadout Obsolete: Please be explicit and use localizedDescription
invariantDescription - the invariant description of the vehicle's loadout
invariantName - the invariant name of the vehicle, for example 'F63 Condor'
isRemotePiloted - true if the vehicle is remotely piloted via telepresence
loadout - the short name of the vehicle's loadout
name - the localized name of the vehicle, for example 'F63 Condor' Obsolete: Please be explicit and use localizedName or invariantName
rebuilds - the number of times the vehicle may be rebuilt

Volcanism

Used by: Body.volcanism

amount - the localized amount of volcanism ("Major", "Minor" or nothing) Obsolete: Please use localizedAmount
composition - the localized composition of the volcanism (Iron, Carbon dioxide, Nitrogen etc.) Obsolete: Please use localizedComposition
invariantAmount - the invariant amount of volcanism ("Major", "Minor" or nothing)
invariantComposition - the invariant composition of the volcanism (Iron, Carbon dioxide, Nitrogen etc.)
invariantType - the invariant type of volcanism: either "Geysers" or "Magma"
type - the localized type of volcanism: either "Geysers" or "Magma" Obsolete: Please use localizedType

Uh oh!

Variables

EDDI Variables

Root Variables

Object reference

AtmosphereComposition

Body

Boxel

Cargo

CombatRating

Commander

CommodityAmount

CommodityDefinition

CommodityMarketQuote

Compartment

Conflict

CQCRating

Economy

EmpireRating

Engineer

EngineerSpecialty

ExobiologistRating

ExplorationRating

Faction

FactionPresence

FactionRecord

FactionReport

FactionState

FactionTrendingState

FederationRating

FleetCarrier

Friend

GalacticRegion

Government

Happiness

Hardpoint

LaunchBay

MaterialAmount

MaterialPresence

MercenaryRating

MicroResource

Mission

Module

NavWaypoint

Power

PowerplayState

Rarity

ReserveLevel

Ring

SecurityLevel

Ship

SignalSource

SignalType

SolidComposition

SquadronRank

StarSystem

StarSystemId64

Station

StationService

Status

StoredModule

Superpower

Target

ThargoidWar

TradeRating

Vehicle

Volcanism

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!