GameState refactoring

Moved game-state related information into GameState struct (#16)

Author: markus-wa

README.md

@@ -56,9 +56,9 @@ func main() {
 	p.RegisterEventHandler(func(e events.RoundEndedEvent) {
 		switch e.Winner {
 		case common.TeamTerrorists:
-			fmt.Println("T-side won the round - score:", p.TState().Score()+1) // Score + 1 because it hasn't actually been updated yet
+			fmt.Println("T-side won the round - score:", p.GameState().TState().Score()+1) // Score + 1 because it hasn't actually been updated yet
 		case common.TeamCounterTerrorists:
-			fmt.Println("CT-side won the round - score:", p.CTState().Score()+1)
+			fmt.Println("CT-side won the round - score:", p.GameState().CTState().Score()+1)
 		default:
 			fmt.Println("Apparently neither the Ts nor CTs won the round, interesting")
 		}

common/structs.go

@@ -1,12 +1,8 @@
 package common
 
 import (
-	"encoding/binary"
-	"io"
-
 	r3 "github.com/golang/geo/r3"
 
-	bit "github.com/markus-wa/demoinfocs-golang/bitread"
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
@@ -25,26 +21,16 @@ type DemoHeader struct {
 	SignonLength    int
 }
 
-// PlayerInfo contains general player information
-type PlayerInfo struct {
-	Version     int64
-	XUID        int64
-	Name        string
-	UserID      int
-	GUID        string
-	FriendsID   int
-	FriendsName string
-	// Custom files stuff (CRC)
-	CustomFiles0 int
-	CustomFiles1 int
-	CustomFiles2 int
-	CustomFiles3 int
-	// Amount of downloaded files from the server
-	FilesDownloaded byte
-	// Bots
-	IsFakePlayer bool
-	// HLTV Proxy
-	IsHltv bool
+// FrameRate returns the frame rate of the demo (frames / demo-ticks per second).
+// Not necessarily the tick-rate the server ran on during the game.
+// VolvoPlx128TixKTnxBye
+func (h DemoHeader) FrameRate() float32 {
+	return float32(h.PlaybackFrames) / h.PlaybackTime
+}
+
+// FrameTime returns the time a frame / demo-tick takes in seconds.
+func (h DemoHeader) FrameTime() float32 {
+	return h.PlaybackTime / float32(h.PlaybackFrames)
 }
 
 // Player contains mostly game-relevant player information.
@@ -77,6 +63,7 @@ type Player struct {
 	IsDisconnected              bool
 	HasDefuseKit                bool
 	HasHelmet                   bool
+	Connected                   bool
 }
 
 // IsAlive returns true if the Hp of the player are > 0.
@@ -136,32 +123,6 @@ func NewSkinEquipment(eqName string, skinID string) Equipment {
 	return Equipment{Weapon: wep, SkinID: skinID}
 }
 
-// ParsePlayerInfo parses player information from a byte stream.
-func ParsePlayerInfo(reader io.Reader) *PlayerInfo {
-	br := bit.NewSmallBitReader(reader)
-	res := &PlayerInfo{
-		Version:     int64(binary.BigEndian.Uint64(br.ReadBytes(8))),
-		XUID:        int64(binary.BigEndian.Uint64(br.ReadBytes(8))),
-		Name:        br.ReadCString(128),
-		UserID:      int(int32(binary.BigEndian.Uint32(br.ReadBytes(4)))),
-		GUID:        br.ReadCString(33),
-		FriendsID:   int(int32(binary.BigEndian.Uint32(br.ReadBytes(4)))),
-		FriendsName: br.ReadCString(128),
-
-		IsFakePlayer: br.ReadSingleByte()&0xff != 0,
-		IsHltv:       br.ReadSingleByte()&0xff != 0,
-
-		CustomFiles0: int(br.ReadInt(32)),
-		CustomFiles1: int(br.ReadInt(32)),
-		CustomFiles2: int(br.ReadInt(32)),
-		CustomFiles3: int(br.ReadInt(32)),
-
-		FilesDownloaded: br.ReadSingleByte(),
-	}
-	br.Pool()
-	return res
-}
-
 // NewPlayer creates a *Player with an initialized equipment map.
 func NewPlayer() *Player {
 	return &Player{RawWeapons: make(map[int]*Equipment)}

constants.go

@@ -8,6 +8,14 @@ import (
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
+const (
+	maxEditctBits = 11
+	indexMask     = ((1 << maxEditctBits) - 1)
+	maxEntities   = (1 << maxEditctBits)
+	maxPlayers    = 64
+	maxWeapons    = 64
+)
+
 // Everything here feels kinda fucked
 
 func (p *Parser) mapEquipment() {
@@ -77,11 +85,11 @@ func (p *Parser) bindTeamScores() {
 
 			switch team {
 			case "CT":
-				s = &p.ctState
+				s = &p.gameState.ctState
 				t = common.TeamCounterTerrorists
 
 			case "TERRORIST":
-				s = &p.tState
+				s = &p.gameState.tState
 				t = common.TeamTerrorists
 
 			case "Unassigned": // Ignore
@@ -113,7 +121,7 @@ func (p *Parser) bindTeamScores() {
 				// FIXME: This only sets the team at the start. . . We also have a player-specific update handler that changes the team so maybe this is unnecessary?
 				if teamID != -1 {
 					s.id = teamID
-					for _, pl := range p.players {
+					for _, pl := range p.entityIDToPlayers {
 						if pl != nil && pl.TeamID == teamID {
 							pl.Team = t
 						}
@@ -180,11 +188,12 @@ func (p *Parser) bindPlayers() {
 
 func (p *Parser) bindNewPlayer(playerEntity *st.Entity) {
 	var pl *common.Player
-	if p.players[playerEntity.ID-1] != nil {
-		pl = p.players[playerEntity.ID-1]
+	playerIndex := playerEntity.ID - 1
+	if p.entityIDToPlayers[playerIndex] != nil {
+		pl = p.entityIDToPlayers[playerIndex]
 	} else {
 		pl = common.NewPlayer()
-		p.players[playerEntity.ID-1] = pl
+		p.entityIDToPlayers[playerIndex] = pl
 		pl.SteamID = -1
 		pl.Name = "unconnected"
 	}
@@ -206,9 +215,9 @@ func (p *Parser) bindNewPlayer(playerEntity *st.Entity) {
 
 		// FIXME: We could probably just cast TeamID to common.Team or not even set it because the teamIDs should be the same. . . needs testing
 		switch pl.TeamID {
-		case p.ctState.id:
+		case p.gameState.ctState.id:
 			pl.Team = common.TeamCounterTerrorists
-		case p.tState.id:
+		case p.gameState.tState.id:
 			pl.Team = common.TeamTerrorists
 		default:
 			pl.Team = common.TeamSpectators

datatables.go

@@ -36,27 +36,27 @@ func TestDemoInfoCs(t *testing.T) {
 	p := dem.NewParser(f, dem.WarnToStdErr)
 
 	fmt.Println("Parsing header")
-	p.RegisterEventHandler(func(e events.HeaderParsedEvent) {
-		fmt.Printf("Header: %v\n", e)
-	})
-	p.ParseHeader()
+	h, err := p.ParseHeader()
+	if err != nil {
+		t.Fatal(err)
+	}
+	fmt.Printf("Header: %v\n", h)
 
 	fmt.Println("Registering handlers")
-	var tState *dem.TeamState
-	var ctState *dem.TeamState
-	var oldTScore int
-	var oldCtScore int
+	tState := p.GameState().TState()
+	ctState := p.GameState().CTState()
+	var oldTScore, oldCtScore int
 	p.RegisterEventHandler(func(events.TickDoneEvent) {
-		if tState != nil && oldTScore != tState.Score() {
-			fmt.Println("T-side score:", tState.Score())
-			oldTScore = tState.Score()
-		} else if ctState != nil && oldCtScore != ctState.Score() {
-			fmt.Println("CT-side score:", ctState.Score())
-			oldCtScore = ctState.Score()
+		newTScore := tState.Score()
+		newCtScore := ctState.Score()
+		if oldTScore != newTScore {
+			fmt.Println("T-side score:", newTScore)
+			oldTScore = newTScore
+		} else if ctState != nil && oldCtScore != newCtScore {
+			fmt.Println("CT-side score:", newCtScore)
+			oldCtScore = newCtScore
 		}
 	})
-	tState = p.TState()
-	ctState = p.CTState()
 
 	ts := time.Now()
 	var done int64

demoinfocs_test.go

@@ -0,0 +1,78 @@
+package demoinfocs
+
+import (
+	"bytes"
+
+	bit "github.com/markus-wa/demoinfocs-golang/bitread"
+	msg "github.com/markus-wa/demoinfocs-golang/msg"
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
+)
+
+const entitySentinel = 9999
+
+func (p *Parser) handlePacketEntities(pe *msg.CSVCMsg_PacketEntities) {
+	defer func() {
+		p.setError(recoverFromUnexpectedEOF(recover()))
+	}()
+
+	r := bit.NewSmallBitReader(bytes.NewReader(pe.EntityData))
+
+	currentEntity := -1
+	for i := 0; i < int(pe.UpdatedEntries); i++ {
+		currentEntity += 1 + int(r.ReadUBitInt())
+
+		if currentEntity > entitySentinel {
+			break
+		}
+
+		if r.ReadBit() {
+			// Leave PVS
+
+			// FIXME: Might have to destroy the entities contents first, not sure yet
+			// Could do weird stuff with event handlers otherwise
+			p.entities[currentEntity] = nil
+
+			if r.ReadBit() {
+				// TODO: Force Delete??
+			}
+		} else {
+			if r.ReadBit() {
+				// Enter PVS
+				e := p.readEnterPVS(r, currentEntity)
+				p.entities[currentEntity] = e
+				e.ApplyUpdate(r)
+			} else {
+				// Delta Update
+				p.entities[currentEntity].ApplyUpdate(r)
+			}
+		}
+	}
+	r.Pool()
+}
+
+func (p *Parser) readEnterPVS(reader *bit.BitReader, entityID int) *st.Entity {
+	scID := int(reader.ReadInt(p.stParser.ClassBits()))
+	reader.Skip(10) // Serial Number
+
+	newEntity := st.NewEntity(entityID, p.stParser.ServerClasses()[scID])
+	newEntity.ServerClass.FireEntityCreatedEvent(newEntity)
+
+	if p.preprocessedBaselines[scID] != nil {
+		for idx, val := range p.preprocessedBaselines[scID] {
+			newEntity.Props()[idx].FirePropertyUpdate(val)
+		}
+	} else {
+		ppBase := make(map[int]st.PropValue, 0)
+		if p.instanceBaselines[scID] != nil {
+			newEntity.CollectProperties(&ppBase)
+			r := bit.NewSmallBitReader(bytes.NewReader(p.instanceBaselines[scID]))
+			newEntity.ApplyUpdate(r)
+			r.Pool()
+			// TODO: Unregister PropertyUpdateHandlers from CollectProperties()
+			// PropertyUpdateHandlers would have to be registered as pointers for that to work
+		}
+		p.preprocessedBaselines[scID] = ppBase
+	}
+
+	return newEntity
+}

entities.go

@@ -31,9 +31,9 @@ func TestExample(t *testing.T) {
 	p.RegisterEventHandler(func(e events.RoundEndedEvent) {
 		switch e.Winner {
 		case common.TeamTerrorists:
-			fmt.Println("T-side won the round - score:", p.TState().Score()+1) // Score + 1 because it hasn't actually been updated yet
+			fmt.Println("T-side won the round - score:", p.GameState().TState().Score()+1) // Score + 1 because it hasn't actually been updated yet
 		case common.TeamCounterTerrorists:
-			fmt.Println("CT-side won the round - score:", p.CTState().Score()+1)
+			fmt.Println("CT-side won the round - score:", p.GameState().CTState().Score()+1)
 		default:
 			fmt.Println("Apparently neither the Ts nor CTs won the round, interesting")
 		}