Location event - EDCD/EDDI GitHub Wiki
Triggered when the commander's location is reported, usually when they reload their game..
Where values are indexed (the compartments on a ship for example), the index will be represented by '<index>'. For VoiceAttack, a variable with the root name of the indexed array shall identify the total number of entries in the array. For example, if compartments 1 and 2 are available then the value of the corresponding 'compartments' variable will be 2.
When using this event in the Speech responder the information about this event is available under the event
object. The available variables are as follows:
-
{event.bodyname} - The nearest body to the commander
-
{event.bodytype} - The type of the nearest body to the commander
-
{event.conflicts} - A list of conflict objects describing any conflicts between factions in the system, if any
-
{event.conflicts[<index>].conflictdays}
-
{event.conflicts[<index>].faction1}
-
{event.conflicts[<index>].faction1dayswon}
-
{event.conflicts[<index>].faction2}
-
{event.conflicts[<index>].faction2dayswon}
-
{event.conflicts[<index>].margin}
-
{event.conflicts[<index>].stake}
-
{event.conflicts[<index>].state}
-
{event.conflicts[<index>].status}
-
{event.distancefromstar} - The distance of the nearest body (when close) from the main star
-
{event.docked} - True if the commander is docked
-
{event.economy} - The economy of the system in which the commander resides
-
{event.economy2} - The secondary economy of the system in which the commander resides, if any
-
{event.factions} - A list of faction objects describing the factions in the system, if any
-
{event.factions[<index>].allegiance}
-
{event.factions[<index>].government}
-
{event.factions[<index>].myreputation}
-
{event.factions[<index>].name}
-
{event.factions[<index>].presences}
-
{event.factions[<index>].presences[<index>].ActiveStates}
-
{event.factions[<index>].presences[<index>].ActiveStates[<index>].invariantName}
-
{event.factions[<index>].presences[<index>].ActiveStates[<index>].name}
-
{event.factions[<index>].presences[<index>].happiness}
-
{event.factions[<index>].presences[<index>].influence}
-
{event.factions[<index>].presences[<index>].PendingStates}
-
{event.factions[<index>].presences[<index>].PendingStates[<index>].factionState}
-
{event.factions[<index>].presences[<index>].PendingStates[<index>].factionState.invariantName}
-
{event.factions[<index>].presences[<index>].PendingStates[<index>].factionState.name}
-
{event.factions[<index>].presences[<index>].PendingStates[<index>].trend}
-
{event.factions[<index>].presences[<index>].RecoveringStates}
-
{event.factions[<index>].presences[<index>].RecoveringStates[<index>].factionState}
-
{event.factions[<index>].presences[<index>].RecoveringStates[<index>].factionState.invariantName}
-
{event.factions[<index>].presences[<index>].RecoveringStates[<index>].factionState.name}
-
{event.factions[<index>].presences[<index>].RecoveringStates[<index>].trend}
-
{event.factions[<index>].presences[<index>].state}
-
{event.factions[<index>].presences[<index>].systemName}
-
{event.factions[<index>].squadronfaction}
-
{event.latitude} - The latitude of the commander (if on the ground)
-
{event.longitude} - The longitude of the commander (if on the ground)
-
{event.marketId} - The market ID of the station at which the commander is docked
-
{event.population} - The population of the system to which the commander has jumped
-
{event.power} - (Only when pledged) The powerplay power exerting influence over the star system. If the star system is
Contested
, this will be empty -
{event.powerstate} - (Only when pledged) The state of powerplay efforts within the star system
-
{event.security} - The security of the system in which the commander resides
-
{event.station} - The name of the station at which the commander is docked
-
{event.stationallegiance} - The super power allegiance of the station, if the commander is docked
-
{event.stationfaction} - The faction controlling the station, if the commander is docked
-
{event.stationgovernment} - The government of the station, if the commander is docked
-
{event.stationstate} - The state of the faction controlling the station, if the commander is docked
-
{event.stationtype} - The type of the station at which the commander is docked
-
{event.systemallegiance} - The super power allegiance of the star system in which the commander is located
-
{event.systemfaction} - The faction controlling the system in which the commander is located
-
{event.systemgovernment} - The government of the system in which the commander is located
-
{event.systemname} - The name of the system in which the commander is located
-
{event.systemstate} - The state of the faction controlling the system in which the commander is located
-
{event.ThargoidWar} - Thargoid war data, when applicable
-
{event.ThargoidWar.CurrentState} - The current phase of the Thargoid war, as a localizable object.
-
{event.ThargoidWar.CurrentState.invariantName}
-
{event.ThargoidWar.CurrentState.name}
-
{event.ThargoidWar.FailureState} - The next phase of the Thargoid war, if success is not achieved, as a localizable object.
-
{event.ThargoidWar.FailureState.invariantName}
-
{event.ThargoidWar.FailureState.name}
-
{event.ThargoidWar.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'.
-
{event.ThargoidWar.remainingDays} - The number of remaining days in the current phase of the Thargoid war.
-
{event.ThargoidWar.remainingPorts} - The number of ports which have not yet fallen into Thargoid control.
-
{event.ThargoidWar.succeeded} - True if commanders have achieved a success state in the current phase of the Thargoid war.
-
{event.ThargoidWar.SuccessState} - The next phase of the Thargoid war, if success is achieved, as a localizable object.
-
{event.ThargoidWar.SuccessState.invariantName}
-
{event.ThargoidWar.SuccessState.name}
-
{event.x} - The X co-ordinate of the system in which the commander is located
-
{event.y} - The Y co-ordinate of the system in which the commander is located
-
{event.z} - The Z co-ordinate of the system in which the commander is located
To respond to this event in VoiceAttack, create a command entitled ((EDDI location)). VoiceAttack variables will be generated to allow you to access the event information.
The following VoiceAttack variables are available for this event:
-
{TXT:EDDI location bodyname} - The nearest body to the commander
-
{TXT:EDDI location bodytype} - The type of the nearest body to the commander
-
{INT:EDDI location conflicts} - A list of conflict objects describing any conflicts between factions in the system, if any
-
{INT:EDDI location conflicts <index> conflictdays}
-
{TXT:EDDI location conflicts <index> faction1}
-
{INT:EDDI location conflicts <index> faction1dayswon}
-
{TXT:EDDI location conflicts <index> faction2}
-
{INT:EDDI location conflicts <index> faction2dayswon}
-
{INT:EDDI location conflicts <index> margin}
-
{TXT:EDDI location conflicts <index> stake}
-
{TXT:EDDI location conflicts <index> state}
-
{TXT:EDDI location conflicts <index> status}
-
{DEC:EDDI location distancefromstar} - The distance of the nearest body (when close) from the main star
-
{BOOL:EDDI location docked} - True if the commander is docked
-
{TXT:EDDI location economy} - The economy of the system in which the commander resides
-
{TXT:EDDI location economy2} - The secondary economy of the system in which the commander resides, if any
-
{INT:EDDI location factions} - A list of faction objects describing the factions in the system, if any
-
{TXT:EDDI location factions <index> allegiance}
-
{TXT:EDDI location factions <index> government}
-
{DEC:EDDI location factions <index> myreputation}
-
{TXT:EDDI location factions <index> name}
-
{INT:EDDI location factions <index> presences}
-
{INT:EDDI location factions <index> presences <index> active states}
-
{TXT:EDDI location factions <index> presences <index> active states <index> invariant name}
-
{TXT:EDDI location factions <index> presences <index> active states <index> name}
-
{TXT:EDDI location factions <index> presences <index> happiness}
-
{DEC:EDDI location factions <index> presences <index> influence}
-
{INT:EDDI location factions <index> presences <index> pending states}
-
{TXT:EDDI location factions <index> presences <index> pending states <index> faction state invariant name}
-
{TXT:EDDI location factions <index> presences <index> pending states <index> faction state name}
-
{INT:EDDI location factions <index> presences <index> pending states <index> trend}
-
{INT:EDDI location factions <index> presences <index> recovering states}
-
{TXT:EDDI location factions <index> presences <index> recovering states <index> faction state invariant name}
-
{TXT:EDDI location factions <index> presences <index> recovering states <index> faction state name}
-
{INT:EDDI location factions <index> presences <index> recovering states <index> trend}
-
{TXT:EDDI location factions <index> presences <index> state}
-
{TXT:EDDI location factions <index> presences <index> system name}
-
{BOOL:EDDI location factions <index> squadronfaction}
-
{DEC:EDDI location latitude} - The latitude of the commander (if on the ground)
-
{DEC:EDDI location longitude} - The longitude of the commander (if on the ground)
-
{DEC:EDDI location market id} - The market ID of the station at which the commander is docked
-
{DEC:EDDI location population} - The population of the system to which the commander has jumped
-
{TXT:EDDI location power} - (Only when pledged) The powerplay power exerting influence over the star system. If the star system is
Contested
, this will be empty -
{TXT:EDDI location powerstate} - (Only when pledged) The state of powerplay efforts within the star system
-
{TXT:EDDI location security} - The security of the system in which the commander resides
-
{TXT:EDDI location station} - The name of the station at which the commander is docked
-
{TXT:EDDI location stationallegiance} - The super power allegiance of the station, if the commander is docked
-
{TXT:EDDI location stationfaction} - The faction controlling the station, if the commander is docked
-
{TXT:EDDI location stationgovernment} - The government of the station, if the commander is docked
-
{TXT:EDDI location stationstate} - The state of the faction controlling the station, if the commander is docked
-
{TXT:EDDI location stationtype} - The type of the station at which the commander is docked
-
{TXT:EDDI location systemallegiance} - The super power allegiance of the star system in which the commander is located
-
{TXT:EDDI location systemfaction} - The faction controlling the system in which the commander is located
-
{TXT:EDDI location systemgovernment} - The government of the system in which the commander is located
-
{TXT:EDDI location systemname} - The name of the system in which the commander is located
-
{TXT:EDDI location systemstate} - The state of the faction controlling the system in which the commander is located
-
{TXT:EDDI location thargoid war current state invariant name}
-
{TXT:EDDI location thargoid war current state name}
-
{TXT:EDDI location thargoid war failure state invariant name}
-
{TXT:EDDI location thargoid war failure state name}
-
{DEC:EDDI location thargoid war 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'.
-
{INT:EDDI location thargoid war remaining days} - The number of remaining days in the current phase of the Thargoid war.
-
{INT:EDDI location thargoid war remaining ports} - The number of ports which have not yet fallen into Thargoid control.
-
{BOOL:EDDI location thargoid war succeeded} - True if commanders have achieved a success state in the current phase of the Thargoid war.
-
{TXT:EDDI location thargoid war success state invariant name}
-
{TXT:EDDI location thargoid war success state name}
-
{DEC:EDDI location x} - The X co-ordinate of the system in which the commander is located
-
{DEC:EDDI location y} - The Y co-ordinate of the system in which the commander is located
-
{DEC:EDDI location z} - The Z co-ordinate of the system in which the commander is located
For more details on VoiceAttack integration, see https://github.com/EDCD/EDDI/wiki/VoiceAttack-Integration.