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

journal/CQC: Minor documentation tweaks for language/grammar

Browse Source
This commit is contained in:
Athanasius 2021-08-13 13:19:46 +01:00
parent 8c9ffec869
commit 411bd0edf2
No known key found for this signature in database
GPG Key ID: AE3E527847057C7D
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
PLUGINS.md
View File

@ -678,6 +678,8 @@ New in version 5.1.1:
`state` now has a `ShipLockerJSON` member containing the un-changed, loaded, `state` now has a `ShipLockerJSON` member containing the un-changed, loaded,
JSON from the `ShipLockerJSON.json` file. JSON from the `ShipLockerJSON.json` file.
___
##### Synthetic Events ##### Synthetic Events
A special "StartUp" entry is sent if EDMC is started while the game is already A special "StartUp" entry is sent if EDMC is started while the game is already
@ -703,6 +705,8 @@ between the two scenarios.
This event is not sent when EDMC is running on a different This event is not sent when EDMC is running on a different
machine so you should not *rely* on receiving this event. machine so you should not *rely* on receiving this event.
---
##### Augmented Events ##### Augmented Events
In some cases we augment the events, as seen in the Journal, with extra data. In some cases we augment the events, as seen in the Journal, with extra data.
@ -740,9 +744,7 @@ Examples of this are:
--- ---
--- ### Journal entry in CQC
### Journal entry CQC
New in version 5.2.0 New in version 5.2.0
```python ```python
def journal_entry_cqc(cmdr: str, is_beta: bool, entry: Dict[str, Any], state: Dict[str, Any]) -> None: def journal_entry_cqc(cmdr: str, is_beta: bool, entry: Dict[str, Any], state: Dict[str, Any]) -> None:
@ -758,7 +760,8 @@ def journal_entry_cqc(cmdr: str, is_beta: bool, entry: Dict[str, Any], state: Di
logger.info(f'Loaded to CQC map {cqc_map}') logger.info(f'Loaded to CQC map {cqc_map}')
``` ```
This gets called when EDMC sees a new entry in the game's journal and we are currently in CQC. This is called for new journal entries, instead of `journal_entry()`, when the
player is in Arena (CQC).
| Parameter | Type | Description | | Parameter | Type | Description |
| :-------- | :--------------: | :--------------------------------------------------------------------- | | :-------- | :--------------: | :--------------------------------------------------------------------- |
@ -767,9 +770,10 @@ This gets called when EDMC sees a new entry in the game's journal and we are cur
| `entry` | `Dict[str, Any]` | The journal event | | `entry` | `Dict[str, Any]` | The journal event |
| `state` | `Dict[str, Any]` | More info about the commander, their ship, and their cargo (see below) | | `state` | `Dict[str, Any]` | More info about the commander, their ship, and their cargo (see below) |
Content of `state` same as for [`journal_entry`](#journal-entry). The content of `state` will be the same as for [`journal_entry`](#journal-entry),
so check there for documentation.
___ ---
### Shutdown ### Shutdown