From 1bb0bf9f74fcfee2a0b64da036b63a7a92e23af3 Mon Sep 17 00:00:00 2001
From: Athanasius <github@miggy.org>
Date: Wed, 10 Aug 2022 11:47:51 +0100
Subject: [PATCH] PLUGINS.md: Document `NavRouteClear` behaviour

---
 PLUGINS.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/PLUGINS.md b/PLUGINS.md
index b26ee58b..be479920 100644
--- a/PLUGINS.md
+++ b/PLUGINS.md
@@ -698,6 +698,18 @@ New in version 5.1.1:
 `state` now has a `ShipLockerJSON` member containing the un-changed, loaded,
 JSON from the `ShipLockerJSON.json` file.
 
+New in version 5.4.2+:
+
+We now handle the 'Update 13' `NavRouteClear` event by detecting if that's what
+is in the `NavRoute.json` file.  If this is the case then we log that, **but
+do NOT clear `state['NavRoute']`**.  Plugins will get sent the Journal
+`NavRouteClear` event anyway, and there might be some value to them retaining
+access to the prior plotted route.
+
+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.
+
 ___
 
 ##### Synthetic Events