Browse Source

Documentation for extra input signals

Sebastian Lohff 6 years ago
parent
commit
8313b81529
1 changed files with 11 additions and 0 deletions
  1. 11
    0
      Readme.md

+ 11
- 0
Readme.md View File

@@ -76,6 +76,17 @@ expected. All other characters are ignored.
76 76
 Writing an own class for player input should be fairly easy. Within its own
77 77
 thread the class can do whatever it wants (including blocking I/O). When it
78 78
 wants to signal a button was pressed it just needs to emit a ButtonEvent.
79
+An input class has two functions which are called while a question is on
80
+display:
81
+
82
+ - `buzzersOpen(isOpen)` is called, when the question is first displayed,
83
+    when the question is reopened after a false answer and when the question is
84
+	closed after either a correct answer or no answer at all.
85
+
86
+ - `playerGotQuestion(playerNo)` is called, whenever a player pressed
87
+    their button *and* got the turn to answer. Note that no extra
88
+	buzzers-are-closed (`buzzersOpen(False)`) event is sent, when a button
89
+	is pressed.
79 90
 
80 91
 
81 92
 Known Bugs

Loading…
Cancel
Save