BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-04-05 14:25:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

update docs

Browse source
This commit is contained in:
Bastian Schroll 2019-10-26 10:18:55 +02:00
parent 2939bb9389
commit a92dd8d94c
No known key found for this signature in database
GPG key ID: 0AE96912A20E9F5F
8 changed files with 24 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docu/docs/develop/ModulPlugin.md
View file

@ -98,20 +98,31 @@ was zur weiteren Ausführung des Routers mit dem original Paket führt. Daher ma
---
## Nutzung der Wildcards
Es gibt einige vordefinierte Wildcards welche in der [BOSWatch Paket](packet.md) Dokumentation zu finden sind.
Außerdem sind die folgenden allgemeinen Wildcards definiert:
- `{BR}` - Zeilenumbruch `\r\n`
- `{LPAR}` - öffnende Klammer `(`
- `{RPAR}` - schließende Klammer `)`
- `{TIME}` - Aktueller Zeitstempel im Format `%d.%m.%Y %H:%M:%S`
### Wildcards registrieren [Module]
Module können zusätzliche Wildcards registrieren welche anschließend in den Plugins ebenfalls geparst werden können.
Dies kann über die interne Methode `self.registerWildcard(newWildcard, bwPacketField)` gemacht werden.
Der erste Parameter `newWildcard` muss im folgenden Format angegeben werden: `{WILDCARD}`
Der zweite Parameter `bwPacketField` entspricht dem Namen des Feldes welches dem bwPacket per `bwPacket.set(FIELDNAME, VALUE)` hinzugefügt wurde.
- `newWildcard` muss im folgenden Format angegeben werden: `{WILDCARD}`
- `bwPacketField` ist der Name des Feldes im bwPacket - gestezt per `bwPacket.set(FIELDNAME, VALUE)`
**Bitte beachten:**
- Selbst vom Modul registrierte Wildcards **müssen** in der Modul Dokumentation unter `Zusätzliche Wildcards` aufgeführt werden.
### Wildcards parsen [Plugins]
Das parsen der Wildcars funktioniert komfortabel über die interne Methode `TEXT = self.parseWildcards(TEXT)`.
Das parsen der Wildcars funktioniert komfortabel über die interne Methode `msg = self.parseWildcards(msg)`.
- `msg` enstrpicht dabei dem String in welchem die Wildcards ersetzt werden sollen
Die Platzhalter der Wildcards findet man in der [BOSWatch Paket](packet.md) Dokumentation.
Sollten Module zusätzliche Wildcards registrieren, findet man Informationen dazu in der jeweiligen Plugin Dokumentation

9
docu/docs/develop/packet.md
View file

@ -1,4 +1,4 @@
# <center>BOSWatch Packet Format</center>
# <center>BOSWatch Paket Format</center>
Ein BOSWatch Datenpaket wird in einem Python Dict abgebildet. In der nachfolgenden Tabelle sind die genutzten Felder abgebildet.
@ -51,10 +51,3 @@ Ein BOSWatch Datenpaket wird in einem Python Dict abgebildet. In der nachfolgend
|vehicle|X||||`{VEC}`||
|vehicle|X||||`{VEC}`||
|tacticalInfo|X||||`{TACI}`|(I, II, III, IV)|
---
## Weitere Wildcards
- `{BR}` - Zeilenumbruch `\r\n`
- `{LPAR}` - öffnende Klammer `(`
- `{RPAR}` - schließende Klammer `)`
- `{TIME}` - Aktueller zeitstempel