From c1a6eec6f5d230c6dc87eaae87a3c369ecd6ac3e Mon Sep 17 00:00:00 2001
From: Pascal Engeler <engelerp@phys.ethz.ch>
Date: Wed, 8 Sep 2021 11:45:38 +0200
Subject: [PATCH] changed misleading phrasing
---
README.md | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 28f5775..56953ab 100644
--- a/README.md
+++ b/README.md
@@ -170,19 +170,18 @@ The application is split into different modules, each module handles a subset of
- Handle all predefined structure placements
- Draw structures to damping textures
- **`TimeoutHandler`**
- - Handle the Timeout functionality (if no user input for N seconds, send reset requests to everyone)
- - Send reset requests to other modules
+ - Handle the Timeout functionality (if no user input for N seconds, post reset requests for everyone)
- **`Toolbox`**
- Store information needed by several other modules ("global state")
- Implement an event chain where current events are stored
- - Implement a mailbox to facilitate the passing of messages
+ - Implement a mailbox to enable the passing of messages
Much like the name suggests, the `Toolbox` is passed around from one module to the next, and each can then access everything stored within it.
Each module can see all information and decide how it reacts to the current combination of state, messages and events (user input).
The logical flow of the application game loop goes as follows:
1. `InputHandler` fetches and writes new user input into the `Toolbox` event chain
2. `TimeoutHandler` checks if there is any user input, and if timeout occurs posts reset requests to the `Toolbox` mailbox targeting all other modules
-3. `GuiHandler` checks if user input targets the GUI, updates the global state (e.g. change source frequency, change game mode to "Zeichnen") and sends appropriate messages to other modules (e.g. place structure)
+3. `GuiHandler` checks if user input targets the GUI, updates the global state (e.g. change source frequency, change game mode to "Zeichnen") and posts appropriate messages for other modules (e.g. place structure)
4. `WaveHandler` checks if any messages that target it have been posted
5. `SlimBlockchainHandler` reacts to its messages and user input
6. `DrawingHandler` reacts to its messages and user input
--
GitLab