diff --git a/PLUGINS.md b/PLUGINS.md index e7f7488b..fae13d0d 100644 --- a/PLUGINS.md +++ b/PLUGINS.md @@ -566,6 +566,8 @@ Content of `state` (updated to the current journal entry): | `CargoJSON` | `dict` | content of cargo.json as of last read. | | `Credits` | `int` | Current credits balance | | `FID` | `str` | Frontier commander ID | +| `Horizons` | `bool` | From `LoadGame` event. | +| `Odyssey` | `bool` | From `LoadGame` event. `False` if not present, else the event value. | | `Loan` | `Optional[int]` | Current loan amount, if any | | `Raw` | `dict` | Current raw engineering materials | | `Manufactured` | `dict` | Current manufactured engineering materials | @@ -631,6 +633,19 @@ the same when you're on-foot. `SuitCurrent`, `Suits`, `SuitLoadoutCurrent` & `SuitLoadouts` hold CAPI data relating to suits and their loadouts. +New in version 5.0.1: + +`Odyssey` boolean based on the presence of such a flag in the `LoadGame` +event. Defaults to `False`, i.e. if no such key in the event. + +The previously undocumented`Horizons` boolean is similarly from `LoadGame`, +but blindly retrieves the value rather than having a strict default. There's +be an exception if it wasn't there, and the value would be `None`. Note that +this is **NOT** the same as the return from +[plugins/eddn.py:is_horizons()](./plugins/eddn.py). That function is necessary +because CAPI data doesn't (didn't always?) have an indication of Horizons or +not. + ##### Synthetic Events A special "StartUp" entry is sent if EDMC is started while the game is already