[feature] Add a hint to the game event table, if no auto placement

Author: g3force

internal/app/controller/engine.go

@@ -770,6 +770,7 @@ func (e *Engine) placeBall(event *GameEvent) {
 	if e.State.PlacementPos == nil || e.State.noTeamCanPlaceBall() {
 		// placement not possible, human ref must help out
 		e.SendCommand(CommandHalt, "")
+		e.LogHint("manualPlacement", "placement pos unknown", TeamUnknown)
 		return
 	}
 
@@ -792,6 +793,7 @@ func (e *Engine) placeBall(event *GameEvent) {
 	} else {
 		// If team can not place ball, human ref has to help out
 		e.SendCommand(CommandHalt, "")
+		e.LogHint("manualPlacement", "team can not place ball", teamInFavor)
 		return
 	}
 }

internal/app/controller/uiProtocol.go

@@ -25,6 +25,8 @@ const (
 	UiProtocolModify UiProtocolType = "modify"
 	// UiProtocolTeamAction represents an action from a team
 	UiProtocolTeamAction UiProtocolType = "teamAction"
+	// UiProtocolHint represents a hint to the human game-controller operator
+	UiProtocolHint UiProtocolType = "hint"
 )
 
 // UiProtocolEntry represents a single protocol entry as should be displayed in the UI table
@@ -155,3 +157,16 @@ func (e *Engine) LogTeamBotSubstitutionChange(forTeam Team, substituteBot bool)
 	}
 	e.UiProtocol = append(e.UiProtocol, entry)
 }
+
+// LogHint adds a hint for the game-controller operator to the protocol
+func (e *Engine) LogHint(hint string, description string, team Team) {
+	entry := UiProtocolEntry{
+		Timestamp:   e.TimeProvider().UnixNano(),
+		StageTime:   e.State.StageTimeElapsed,
+		Type:        UiProtocolHint,
+		Team:        team,
+		Name:        hint,
+		Description: description,
+	}
+	e.UiProtocol = append(e.UiProtocol, entry)
+}