BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-01-20 15:40:24 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix docs

Browse source
This commit is contained in:
Bastian Schroll 2019-10-26 08:22:36 +02:00
parent 2e188e6f7a
commit 2939bb9389
No known key found for this signature in database
GPG key ID: 0AE96912A20E9F5F
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -81,7 +81,7 @@ Eine Auflistung der bereitgestellten Informationen findet sich im entsprechenden
- Selbst vom Modul hinzugefügte Felder **müssen** in der Modul Dokumentation unter `Paket Modifikation` aufgeführt werden.
- Sollte ein Modul oder Plugin Felder benutzen, welche in einem anderen Modul erstellt werden, **muss** dies im Punkt `Abhänigkeiten` des jeweiligen Moduls oder Plugins dokumentiert werden.
### Zu beachten bei Module
### Rückgabewert bei Modulen
Module können Pakete beliebig verändern. Diese Änderungen werden im Router entsprechend weitergeleitet.
Mögliche Rückgabewerte eines Moduls:
@ -90,7 +90,7 @@ Mögliche Rückgabewerte eines Moduls:
- `return None` Der Router fährt mit dem unveränderten bwPacket fort (Input = Output)
- `return False` Der Router stopt sofort die Ausführung (zB. in Filtern verwendet)
### Zu beachten bei Plugins
### Rückgabewert bei Plugins
Plugins geben keine Pakete mehr zurück. Sie fungieren ausschließlich als Endpunkt.
Die Plugin Basisklasse liefert intern immer ein `None` an den Router zurück,
was zur weiteren Ausführung des Routers mit dem original Paket führt. Daher macht es in Plugins keinen Sinn ein Paket zu modifizieren.