Variables

EDDI Variables

EDDI provides many variables that can be used to help provide immersive scripts and more interesting. Most variables are held as objects that are exposed from EDDI. Access to the property of the object is using a period, for example cmdr.name - would obtain the name - value from the cmdr - object.

EDDI can also have event-specific variables in the event object. These usually come from external sources and so are not part of the standard objects, although they might reference them.

Details of the objects available are as follows:

Game state

Information on game state is available at the top level i.e. these values can be accessed directly.

environment - the commander's current environment. Can be one of "Docked", "Landed", "Normal space", "Supercruise" or "Witch space"
horizons - true when the game version includes 'Horizons' content
odyssey - true when the game version includes 'Odyssey' content
vehicle - the vehicle that is under the commander's control. Can be one of "Ship", "SRV", "Fighter", "Taxi", "Multicrew", or "On Foot"

EDDI states

capi_active - true when the companion API is active
icao_active - true if ICAO is currently enabled
ipa_active - true if phonetic speech ssml tags are currently enabled
va_active - true when the Voice Attack plug-in is active
version - the version level of EDDI which is currently running

Commander

Commander information is available under the cmdr object.

Any values might be missing, depending on EDDI's configuration.

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
combatrating - the current combat rating of the commander (this is a Rating object)
traderating - the current trade rating of the commander (this is a Rating object)
explorationrating - the exploration combat rating of the commander (this is a Rating object)
empirerating - the current Empire rating of the commander (this is a Rating object)
federationrating - the current Federation rating of the commander (this is a Rating object)
mercenaryrating - the current Mercenary rating of the commander (this is a Rating object)
exobiologistrating - the current Exobiologist rating of the commander (this is a Rating object)
credits - the number of credits the commander owns
debt - the amount of debt the commander owes
gender - the gender of the commander, as selected in EDDI's configuration (string, either 'Male', 'Female' or 'Neither')
squadronname - the name of the commander's squadron
squadronid - the ID of the commander's squadron
squadronrank - the current squadron rank of the commander (this is a Rating object)
squadronallegiance - the superpower allegiance of the commander's squadron (use squadronallegiance.name)
squadronpower - the power (e.g. Aisling Duval) to which the commander's squadron pledges fealty (use squadronpower.name)
squadronfaction - the faction within the squadron system to which the commander's squadron is aligned
friends - the commander's friends observed during the play session (this is a list of Friend objects)
engineers - the commander's relations with engineers, including any ranks or progression recorded during the play session (this is a list of Engineer objects)
power - (if pledged) the power which the commander serves

Engineer

An engineer object

name - the name of the engineer
systemname - the name of the star system at which the engineer resides
stationname - the name of the station at which the engineer resides
rank - the rank of your relationship with the engineer
stage - the current stage of your relations with the engineer (e.g. Invited/Known/Unlocked/Barred)
rankprogress - the percentage towards your next rank with the engineer
majorspecialties - the major specialties of the engineer
minorspecialties - the minor specialties of the engineer

Friend

A friend object.

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

Rating

A rating, for example a combat rating or empire rating.

rank - the numeric rank of the rating, for example 0
name - the name of the rating, for example 'Harmless'
femininename - the feminine name of the rating, for example 'Baroness', if it differs. Otherwise null / not set

Event

The event that triggered the speech responder. Information held in here is event-specific. The event specific variables can be found by clicking on the 'Variables' button while editing an event related script and accessing the appropriate values of the event - object.

Inventory

The inventory of cargo carried within the ship is available under the inventory object.

inventory - specific details on the cargo being carried
cargoCarried - total tons of cargo carried

Cargo

Details of an individual commodity being carried.

name - name of the cargo (e.g. Tea)
commodity - object containing commodity details
category - category of the commodity (e.g. Foods, Machinery, Technology)
owned - number of units privately purchased or collected (not stolen or mission related)
stolen - number of units flagged as stolen
haulage - number of units associated with a mission
total - total number of units
need - number of units needed to satisfy all mission requirements associated with cargo
price - price of an individual unit

Commodity

A commodity.

name - the name of the commodity (e.g. Tea)
category - the category of the commodity (e.g. Foods, Machinery, Technology)
rare - the rarity of the commodity (boolean true or false)

Additional properties may become available in station, via station.commodities.[property]
(see Commodity sale check and Commodity purchase check for sample usages).

buyprice - the price to purchase the commodity from the market
sellprice - the price being offered for the commodity in the market
avgprice - the average price offered for this commodity in a legal market
stock - the amount of the commodity available from the market
demand - the demand for the commodity from the market

Material

A material.

name - the name of the material (e.g. Iron)
category - the category of the material (Element, Data or Manufactured)
location - typical locations where the material can be found
rarity - the rarity of the material
blueprints - the blueprints for which the material is used (this is an array of blueprint objects)
bodyname - the body name with the highest known concentration of the material within the specified system (only available when using the MaterialDetails() function)
bodyshortname - the shortened body name with the highest known concentration of the material within the specified system (only available when using the MaterialDetails() function)

Blueprint

An engineering blueprint.

name - the name of the blueprint (e.g. 'heavy duty')
grade - the grade of the engineering blueprint (e.g. 'grade 4')
materials - the materials required to produce the blueprint (a list of items with material and amount keys for each item)

Rarity

A rarity rating.

name - the name of the rarity (e.g. Very common)
level - the level of the rarity (0 == Very common, 5 == Very rare)

Missions

The log of missions accepted by the commander is available under the missions object.

missions - list of missions within the commander's mission log'
missionsCount - the number of all accepted missions
missionWarning - the number of minutes before mission expiry in which a warning notification is generated

Mission

Details of an individual mission in the commander's mission log.

missionid - unique identifier ID of the mission
name - name of mission
localisedname - localised name of the mission
tags - localized tags (altruism, delivery, massacre, etc) describing the mission, as a list
invariantTags - invariant tags (altruism, delivery, massacre, etc) describing the mission, as a list
status - localized status (active, complete, failed) of the mission
faction - name of the faction issuing the mission
originsystem - origin system of the mission
originstation - origin station of the mission
originreturn - true if the commander must return to origin to complete the mission
destinationsystem - destination system of the mission (if applicable)
destinationstation - destination station of the mission (if applicable)
destinationsystems - list of destination systems for chained missions (if applicable)
influence - increase in the faction's influence in the system gained when completing the mission (None/Low/Med/High)
reputation - increase in the commander's reputation with the faction gained when completing the mission (None/Low/Med/High)
reward - expected cash reward from the mission
legal - true if the mission is legal
wing - true if the mission allows wing-mates
shared - true if the mission was shared by a wing-mate
communal - true if the mission is a community goal
commodity - commodity involved in the mission (if applicable)
passengertype - localized type of passengers (celebrity, doctor, etc) in the mission (if applicable)
passengervips - true if the passengers are VIPs (if applicable)
passengerwanted - true if the passengers are wanted
target - name of the target of the mission (if applicable)
targettype - localized type of the target (civilian, pirate, etc) of the mission (if applicable)
targetfaction - name of the faction of the target of the mission (if applicable)
amount - amount of the commodity, passengers or targets involved in the mission (if applicable)
expiry - expiry date and time of the mission
expiryseconds - amount of seconds remaining before mission expiration
sourcesystem - the system where the mission cargo has been found, as applicable
sourcebody - the body or station where the mission cargo has been found, as applicable
collected - the quantity of mission cargo which has been collected at a cargo depot
delivered - the quantity of mission cargo which has been delivered to a cargo depot

Crime & Punishment

The criminal record and derived properties of commander is available under the criminalrecord object.

criminalrecord - list of minor faction records, detailing bond & bounty claims, and fine and bounties incurred
claims - total credits for all unredeemed bond and bounty rewards
fines - total credits for all unpaid fines incurred
bounties - total credits for all unpaid bounties incurred
orbitalpriority - true when orbital stations are prioritized over planetary for station selection
shiptargets - list of ships targeted within the current system.

Record

Details of individual faction records, within the criminalrecord object

faction - name of the minor faction
allegiance - superpower to which the minor faction is aligned
system - faction presence determined by minor faction name or highest influence
station - station nearest to main star, filtered by landing pad & ship size
claims - total credits for minor faction's uncollected bond and bounty rewards
fines - total credits for minor faction's unpaid fines incurred
bounties - total credits for minor faction's unpaid bounties incurred
bondsAwarded - list of individual faction reports for uncollected bonds awarded
bountiesAwarded - list of individual faction reports for uncollected bounties awarded
finesIncurred - list of individual faction reports for unpaid fines incurred
bountiesIncurred - list of individual faction reports for unpaid bounties incurred

Report

Details of individual minor faction reports, within the FactionRecord object.

bounty - true if bounty awarded or incurred
shipId - ship ID in which the 'criminal' event occurred
crime - localized type of crime committed, 'None' when report is a claim
system - system in which the 'criminal' event occurred
station - nearby station (null if no station nearby)
body - nearby body (null if no body nearby)
victim - victim faction
amount - credits awarded or incurred

Target

Details of ship target data, within the shiptargets object.

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

Fleet Carrier

Details of the commander's fleet carrier (if purchased) are available within the carrier object. Data is primarily updated from the Carrier stats event and Frontier API data is integrated (if the Frontier API is enabled) after select carrier events.

name - The name of the carrier
callsign - The callsign (alphanumeric designation) of the carrier
currentStarSystem - The current location (star system) of the carrier
nextStarSystem - The next scheduled location (star system) of the carrier, if any
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)
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 'pendingDecomission')
dockingAccess - The carrier's last reported docking access (one of one of 'all', 'squadronfriends', 'friends', or 'none')
notoriousAccess - True if the last reported state permits docking access by notorious commanders
usedCapacity - The last reported total used capacity of the carrier
freeCapacity - The last reported free capacity of the carrier
bankBalance - The last reported total bank balance of the carrier
bankReservedBalance - The last reported reserved bank balance of the carrier
bankAvailableBalance - The last reported available bank balance of the carrier

Inara

Details of any available commander records from https://inara.cz, within the inaracmdr object. Some values may be missing, depending on the completeness of the records and on the commander's sharing settings on https://inara.cz.

username - The commander's Inara username
commandername - The commander name
commanderranks - The commander's last reported ranks (this is a list of inaracmdrranks objects)
preferredallegiance - The commander's last reported preferred allegiance
preferredpower - The commander's last reported preferred allegiance
squadron - The commander's last reported Inara squadron (this is an inaracmdrsquadron object)
preferredrole - The commander's last reported in-game role
url - The url of the commander's profile on https://inara.cz

InaraCmdrRanks

rank - The name of the rank
rankvalue - The rank as an integer value
progress - The process which has been made toward's the commander's next advancement in the rank

InaraCmdrSquadron

name - The commander's last reported squadron name
memberscount - The commander's squadron's last reported membership count
squadronrank - The commander's last reported rank with their Inara squadron
url - The url of the commander's squadron's profile on https://inara.ca

Ship

Information about your current ship is available under the ship object. Any values might be missing, depending on EDDI's configuration.

manufacturer - the manufacturer of the ship (Lakon, Core Dynamics etc)
model - the model of the ship (Cobra Mk III, Fer-de-Lance etc)
size - the size of the ship (small/medium/large)
value - the value of the ship without cargo, in credits
hullvalue - The value of the ship's hull (less modules), in credits
modulesvalue - The value of the ship's modules (less hull), in credits
hot - true if the ship is wanted
rebuy - The rebuy value of the ship, in credits
cargocapacity - the total tonnage cargo capacity
name - the name of the ship
phoneticname - the name 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
phoneticmanufacturer - the manufacturer of the ship, using any phonetic pronunciation that has been set and is supported by the current voice
ident - the identifier of the ship
role - the role of the ship
health - the last reported health of the hull, from 0 to 100
bulkheads - details of the ship's bulkheads (this is a Module object)
powerplant - details of the ship's powerplant (this is a Module object)
thrusters - details of the ship's thrusters (this is a Module object)
frameshiftdrive - details of the ship's FSD (this is a Module object)
lifesupport - details of the ship's life support (this is a Module object)
powerdistributor - details of the ship's power distributor (this is a Module object)
sensors - details of the ship's sensors (this is a Module object)
fueltank - details of the ship's fuel tank (this is a Module object)
fueltankcapacity - the capacity of the main fuel tank
fueltanktotalcapacity - the capacity of the main fuel tank plus all secondary fuel tanks
maxjumprange - maximum unladen jump range of the ship
maxfuelperjump - fuel required for a maximum range jump (excluding synthesis)
hardpoints - the ship's hardpoints (this is an array of HardPoint objects)
compartments - the ship's internal compartments (this is an array of Compartment objects)
launchbays - the ship's internal hangars, containing SRV or Fighter 'vehicles' (this is an array of launchbay objects)

Stored ship information

starsystem - system in which the ship is stored
station - station in which the ship is stored
marketid - market ID of the station in which the ship is stored
distance - the distance to the stored ship, in light years
intransit - true if the ship is in transit
transferprice - price to transfer ship to current location (0 if in transit)
transfertime - time to transfer ship to current location (0 if in transit)

Jump detail

distance - distance of jump range
jumps - number of jumps for given range

Shipyard

The inventory of ships mothballed and available under the shipyard object.

shipyard - a list of ships available using the ship object.

Module

An internal module.

name - localized name of the module
class - numeric class of the module
grade - character grade of the module
value - base value of the module
cost - amount of credits paid for the module
hot - true if the module is/was installed in a hot ship
modified - true if has been engineering modified
modification - localized name of the engineering modification
engineerlevel - (int) level of engineer modification applied (1-5)
engineerquality - (decimal) quality of the engineer modification at the present level (0-1)
enabled - true if the module is currently enabled
priority - current power priority of the module
position - position of module in 'Modules' panel, according to power usage (highest = 1)
power - power usage, measured in MegaWatts (MW)
health - last reported health of the module
mount - only for weapons, this defines the type of mount (fixed, gimballed, turreted)
clipcapacity - only for weapons with ammunition, this defines the clip capacity of the loaded weapon
hoppercapacity - only for weapons with ammunition, this defines the hopper capacity of the loaded weapon
ammoinclip - amount of ammo loaded in the clip at time of 'Loadout' event
ammoinhopper - amount of ammo loaded in the hopper at time of 'Loadout' event

StoredModules

The inventory of modules stored at various stations and available under the storedmodules object.

storedmodules - a list of stored modules available using the storedmodule object.

StoredModule

A module stored at a station.

name - localized name of the module
module - module definition (this is a Module object)
system - system in which the module is stored
station - station in which the module is stored
marketid - market ID of the station in which the module is stored
intransit - true if the module is in transit
transfercost - cost to transfer ship to current location (0 if in transit)
transfertime - time to transfer ship to current location (0 if in transit)

Hardpoint

A harpoint, which may or may not contain a module.

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

Compartment

A compartment, which may or may not contain a module.

size - the numeric size of the compartment, from 1 to 8
module - the module in the compartment

Vehicle

An SRV or Fighter, within an associated launchbay.

name - the name of the vehicle, for example 'F63 Condor'
loadout - the loadout of the vehicle, for example 'Starter' for SRV or 'Gelid' for Fighter
mount - only for Fighters, this defines the type of mount ('F' = fixed, 'G' = gimballed)
rebuilds - the number of rebuilds remaining for the vehicle

Launchbay

An SRV or Fighter hangar.

type - the of launchbay, 'SRV' of 'Fighter'
size - the numeric size of the launchbay
vehicles - the vehicles within the launchbay (this is an array of vehicle objects)

Starsystem

Current starsystem

Information about your current starsystem is available under the system object.

Any values might be missing, depending on EDDI's configuration and the information available about the system.

systemname - the name of the starsystem
population - the population of the starsystem
allegiance - the superpower allegiance of this starsystem (Federation, Empire etc)
government - the type of government in this starsystem (Democracy, Confederacy etc)
faction - the name of the dominant faction in this starsystem
factions - the starsystem's factions (array of Faction objects)
primaryeconomy - the primary economy in this starsystem (High Technology, Agriculture, etc)
state - the state of the starsystem (Boom, War, etc)
security - the level of security in the starsystem (Low, Medium, High)
power - the power who is controlling the starsystem (Edmund Mahon, Zachary Hudson etc)
powerstate - the state of the system for the power (controlled, contested etc)
x - the X co-ordinate of the starsystem
y - the Y co-ordinate of the starsystem
z - the Z co-ordinate of the starsystem
stations - the starsystem's stations (array of Station objects)
planetarystations - the starsystem's stations, filtered to only return planetary stations (array of Station objects)
orbitalstations - the starsystem's stations, filtered to only return orbital stations (array of Station objects)
bodies - the starsystem's bodies (array of Body objects)
visits - the number of visits that the commander has made to this starsystem
lastVisitSeconds - the time that the commander last visited this starsystem, expressed as a Unix timestamp in seconds
distancefromhome - the distance in LY from the commander's home starsystem
comment - any comment the commander has made on the starsystem
updatedat - the timestamp at which the system information was last updated, expressed as a Unix timestamp in seconds
requirespermit - (If using SystemDetails()) Whether this system requires a permit (as a boolean)
permitname - (If using SystemDetails()) The name of the permit required for visiting this system, if any
signalsources - a list of signals detected within the starsystem (for the current starsystem only)
carriersignalsources - a list of signals detected within the starsystem, filtered to only return fleet carrier signals (for the current star system only)
surfaceelements - the elements available from bodies in this starsystem (as an array of material names)
isgreen - true if bodies in this starsystem contain all elements required for FSD synthesis
isgold - true if bodies in this starsystem contain all elements available from surface prospecting
estimatedvalue - the estimated exploration value of the starsystem (includes bonuses for fully scanning and mapping)
totalbodies - the total number of discoverable bodies within the system (only available after a discovery scan)
scannedbodies - the total number of bodies you have scanned within the system
mappedbodies - the total number of bodies you have mapped within the system
scoopable - true if a fuel scoop equipped ship can refuel at at least one star in this starsystem
reserves - the reserve level of the system

Last starsystem

Information about your last starsystem is available under the lastsystem object.

Any values might be missing, depending on EDDI's configuration and the information avaialable about the system.