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

PLUGINS.md: Document new IsDocked state flag.

Browse Source
This commit is contained in:
Athanasius 2022-11-23 15:57:25 +00:00
parent 95fa9d577c
commit 0eb33e011b
No known key found for this signature in database
GPG Key ID: 772697E181BB2767
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
PLUGINS.md
View File

@ -617,6 +617,7 @@ 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 |
| `IsDocked` | `bool` | Whether the Cmdr is currently docked *in their own ship*. |
| `OnFoot` | `bool` | Whether the Cmdr is on foot |
| `Component` | `dict` | 'Component' MicroResources in Odyssey, `int` count each. |
| `Item` | `dict` | 'Item' MicroResources in Odyssey, `int` count each. |
@ -710,6 +711,17 @@ NB: It *is* possible, if a player is quick enough, to plot and clear a route
before we load it, in which case we'd be retaining the *previous* plotted
route.
New in version 5.6.0:
`IsDocked` boolean added to `state`. This is set True for a `Location` event
having `"Docked":true"`, or the `Docked` event. It is set back to False (its
default value) for an `Undocked` event. Being on-foot in a station at login
time does *not* count as docked for this.
In general on-foot, including being in a taxi, might not set this 100%
correctly. Its main use in core code is to detect being docked so as to send
any stored EDDN messages due to "Delay sending until docked" option.
___
##### Synthetic Events