ED/EDMarketConnector
1
0
Fork 0
mirror of https://github.com/EDCD/EDMarketConnector.git synced 2025-04-17 17:42:20 +03:00
Code Issues Projects Releases Wiki Activity

PLUGINS.md: Document state['on_foot']

Browse Source 
* Also restore 'New in' bits to just below the table.
This commit is contained in:
Athanasius 2021-03-30 18:34:43 +01:00
parent 734cb9ed11
commit f40f6464b6
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
PLUGINS.md
View File

@ -530,6 +530,28 @@ Content of `state` (updated to the current journal entry):
| `Modules` | `dict` | Currently fitted modules |
| `NavRoute` | `dict` | Last plotted multi-hop route |
| `ModuleInfo` | `dict` | Last loaded ModulesInfo.json data |
| `on_foot` | `bool` | Whether you're on_foot |
New in version 4.1.6:
`CargoJSON` contains the raw data from the last read of `Cargo.json` passed
through json.load. It contains more information about the cargo contents, such
as the mission ID for mission specific cargo
**NB: Because this is only the data loaded from the `Cargo.json` file, and that
is not written at Commander login (instead the in-Journal `Cargo` event
contains all the data), this will not be populated at login.**
New in version 5.0.0:
`NavRoute` contains the `json.load()` of `NavRoute.json` as indicated by a
journal `NavRoute` event.
`ModuleInfo` contains the `json.load()` of `ModulesInfo.json` as indicated by a
Journal `ModuleInfo` event.
`on_foot` is an indication as to if the player is on-foot, rather than in a
vehicle.
##### Synthetic Events
@ -587,24 +609,6 @@ Examples of this are:
(noting that we used the singular form there to stay consistent with the
Journal event name).
New in version 4.1.6:
`CargoJSON` contains the raw data from the last read of `Cargo.json` passed
through json.load. It contains more information about the cargo contents, such
as the mission ID for mission specific cargo
**NB: Because this is only the data loaded from the `Cargo.json` file, and that
is not written at Commander login (instead the in-Journal `Cargo` event
contains all the data), this will not be populated at login.**
New in version 5.0.0:
`NavRoute` contains the `json.load()` of `NavRoute.json` as indicated by a
journal `NavRoute` event.
`ModuleInfo` contains the `json.load()` of `ModulesInfo.json` as indicated by a
Journal `ModuleInfo` event.
---
### Shutdown