From 0eb33e011b80997c1df6759b79f97e3fef3d27dd Mon Sep 17 00:00:00 2001 From: Athanasius Date: Wed, 23 Nov 2022 15:57:25 +0000 Subject: [PATCH] PLUGINS.md: Document new `IsDocked` state flag. --- PLUGINS.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/PLUGINS.md b/PLUGINS.md index 1649b47e..e8d47a3e 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -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