Delete nade projectiles & infernos at end of round (#43)

Sometimes grenade projectiles and infernos wouldn't be deleted at the
end of the round.

Now we just clean up when we get the game-event round_officially_ended

fixes #42

Author: markus-wa

datatables.go

@@ -319,11 +319,7 @@ func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
 	})
 
 	entity.OnDestroy(func() {
-		p.eventDispatcher.Dispatch(events.NadeProjectileDestroyedEvent{
-			Projectile: proj,
-		})
-
-		delete(p.gameState.grenadeProjectiles, entityID)
+		p.nadeProjectileDestroyed(proj)
 	})
 
 	entity.FindProperty("m_nModelIndex").OnUpdate(func(val st.PropertyValue) {
@@ -365,6 +361,21 @@ func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
 	}
 }
 
+// Seperate function because we also use it in round_officially_ended (issue #42)
+func (p *Parser) nadeProjectileDestroyed(proj *common.GrenadeProjectile) {
+	// If the grenade projectile entity is destroyed AFTER round_officially_ended
+	// we already executed this code when we received that event.
+	if _, exists := p.gameState.grenadeProjectiles[proj.EntityID]; !exists {
+		return
+	}
+
+	p.eventDispatcher.Dispatch(events.NadeProjectileDestroyedEvent{
+		Projectile: proj,
+	})
+
+	delete(p.gameState.grenadeProjectiles, proj.EntityID)
+}
+
 func (p *Parser) bindWeapon(entity *st.Entity, wepType common.EquipmentElement) {
 	entityID := entity.ID()
 	p.weapons[entityID] = common.NewEquipment("")
@@ -417,10 +428,7 @@ func (p *Parser) bindNewInferno(entity *st.Entity) {
 	})
 
 	entity.OnDestroy(func() {
-		p.eventDispatcher.Dispatch(events.InfernoExpiredEvent{
-			Inferno: inf,
-		})
-		delete(p.gameState.infernos, entityID)
+		p.infernoExpired(inf)
 	})
 
 	origin := entity.Position()
@@ -442,3 +450,18 @@ func (p *Parser) bindNewInferno(entity *st.Entity) {
 		nFires = val.IntVal
 	})
 }
+
+// Seperate function because we also use it in round_officially_ended (issue #42)
+func (p *Parser) infernoExpired(inf *common.Inferno) {
+	// If the inferno entity is destroyed AFTER round_officially_ended
+	// we already executed this code when we received that event.
+	if _, exists := p.gameState.infernos[inf.EntityID]; !exists {
+		return
+	}
+
+	p.eventDispatcher.Dispatch(events.InfernoExpiredEvent{
+		Inferno: inf,
+	})
+
+	delete(p.gameState.infernos, inf.EntityID)
+}

demoinfocs_test.go

@@ -98,6 +98,7 @@ func TestDemoInfoCs(t *testing.T) {
 			t.Error("Unexprected default value, check output of last round")
 		}
 	})
+
 	// Check some things at match start
 	p.RegisterEventHandler(func(events.MatchStartedEvent) {
 		participants := gs.Participants()
@@ -121,6 +122,17 @@ func TestDemoInfoCs(t *testing.T) {
 		}
 	})
 
+	// Regression test for grenade projectiles not being deleted at the end of the round (issue #42)
+	p.RegisterEventHandler(func(events.RoundStartedEvent) {
+		if nProjectiles := len(p.GameState().GrenadeProjectiles()); nProjectiles > 0 {
+			t.Error("Expected 0 GrenadeProjectiles at the start of the round, got", nProjectiles)
+		}
+
+		if nInfernos := len(p.GameState().Infernos()); nInfernos > 0 {
+			t.Error("Expected 0 Infernos at the start of the round, got", nInfernos)
+		}
+	})
+
 	// Net-message stuff
 	var netTickHandlerID dispatch.HandlerIdentifier
 	netTickHandlerID = p.RegisterNetMessageHandler(func(tick *msg.CNETMsg_Tick) {

game_events.go

@@ -79,7 +79,22 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 			Winner:  t,
 		})
 
-	case "round_officially_ended": // Round ended. . . probably the event where you get teleported to the spawn (=> You can still walk around between round_end and this?)
+	case "round_officially_ended": // The event after which you get teleported to the spawn (=> You can still walk around between round_end and this event)
+		// Issue #42
+		// Sometimes grenades & infernos aren't deleted / destroyed via entity-updates at the end of the round,
+		// so we need to do it here for those that weren't.
+		//
+		// We're not deleting them from entitites though as that's supposed to be as close to the actual demo data as possible.
+		// We're also not using Entity.Destroy() because it would - in some cases - be called twice on the same entity
+		// and it's supposed to be called when the demo actually says so (same case as with GameState.entities).
+		for _, proj := range p.gameState.grenadeProjectiles {
+			p.nadeProjectileDestroyed(proj)
+		}
+
+		for _, inf := range p.gameState.infernos {
+			p.infernoExpired(inf)
+		}
+
 		p.eventDispatcher.Dispatch(events.RoundOfficiallyEndedEvent{})
 
 	case "round_mvp": // Round MVP was announced