From 52ed062ed9995b63c5ef3c966fb9f9958298c73a Mon Sep 17 00:00:00 2001
From: Martin Michelsen <fuzziqersoftware+g@gmail.com>
Date: Sat, 9 Sep 2023 20:06:01 -0700
Subject: [PATCH] add comment on AssistFlag enum

---
 src/Episode3/PlayerState.hh | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/Episode3/PlayerState.hh b/src/Episode3/PlayerState.hh
index 68efff80..24a335af 100644
--- a/src/Episode3/PlayerState.hh
+++ b/src/Episode3/PlayerState.hh
@@ -14,7 +14,11 @@ namespace Episode3 {
 
 class Server;
 
-enum AssistFlag {
+enum AssistFlag : uint32_t {
+  // Note: This enum is a uint32_t even though only 16 bits are used because
+  // the corresponding field in the protocol is a 32-bit field. There may also
+  // be bits used only by the client which are not documented here.
+
   // clang-format off
   READY_TO_END_PHASE                   = 0x0001,
   DICE_WERE_EXCHANGED                  = 0x0002,