common: replaced AdditionalPlayerInformation with CCSPlayerResource entity

Author: markus-wa

pkg/demoinfocs/common/common.go

@@ -183,7 +183,7 @@ func (ts TeamState) FreezeTimeEndEquipmentValue() (value int) {
 // MoneySpentThisRound returns the total amount of cash spent by the whole team in the current round.
 func (ts TeamState) MoneySpentThisRound() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.AdditionalInformation.MoneySpentThisRound
+		value += pl.MoneySpentThisRound()
 	}
 
 	return
@@ -192,7 +192,7 @@ func (ts TeamState) MoneySpentThisRound() (value int) {
 // MoneySpentThisRound returns the total amount of cash spent by the whole team during the whole game up to the current point.
 func (ts TeamState) MoneySpentTotal() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.AdditionalInformation.MoneySpentTotal
+		value += pl.MoneySpentTotal()
 	}
 
 	return

pkg/demoinfocs/common/common_test.go

@@ -95,8 +95,8 @@ func TestTeamState_EquipmentValueFreezeTimeEnd(t *testing.T) {
 
 func TestTeamState_MoneySpentThisRound(t *testing.T) {
 	members := []*Player{
-		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentThisRound: 100}},
-		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentThisRound: 200}},
+		NewPlayer(demoInfoProviderMock{playerResourceEntity: entityWithProperty("m_iCashSpentThisRound.000", st.PropertyValue{IntVal: 100})}),
+		NewPlayer(demoInfoProviderMock{playerResourceEntity: entityWithProperty("m_iCashSpentThisRound.000", st.PropertyValue{IntVal: 200})}),
 	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
@@ -105,18 +105,19 @@ func TestTeamState_MoneySpentThisRound(t *testing.T) {
 
 func TestTeamState_MoneySpentTotal(t *testing.T) {
 	members := []*Player{
-		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentTotal: 100}},
-		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentTotal: 200}},
+		NewPlayer(demoInfoProviderMock{playerResourceEntity: entityWithProperty("m_iTotalCashSpent.000", st.PropertyValue{IntVal: 100})}),
+		NewPlayer(demoInfoProviderMock{playerResourceEntity: entityWithProperty("m_iTotalCashSpent.000", st.PropertyValue{IntVal: 200})}),
 	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
 	assert.Equal(t, 300, state.MoneySpentTotal())
 }
 
 type demoInfoProviderMock struct {
-	tickRate        float64
-	ingameTick      int
-	playersByHandle map[int]*Player
+	tickRate             float64
+	ingameTick           int
+	playersByHandle      map[int]*Player
+	playerResourceEntity st.IEntity
 }
 
 func (p demoInfoProviderMock) TickRate() float64 {
@@ -131,6 +132,10 @@ func (p demoInfoProviderMock) FindPlayerByHandle(handle int) *Player {
 	return p.playersByHandle[handle]
 }
 
+func (p demoInfoProviderMock) PlayerResourceEntity() st.IEntity {
+	return p.playerResourceEntity
+}
+
 func mockDemoInfoProvider(tickRate float64, tick int) demoInfoProvider {
 	return demoInfoProviderMock{
 		tickRate:   tickRate,

pkg/demoinfocs/common/player.go

@@ -1,6 +1,7 @@
 package common
 
 import (
+	"fmt"
 	"time"
 
 	"github.com/golang/geo/r3"
@@ -20,25 +21,24 @@ const (
 type Player struct {
 	demoInfoProvider demoInfoProvider // provider for demo info such as tick-rate or current tick
 
-	SteamID               int64                        // int64 representation of the User's Steam ID
-	LastAlivePosition     r3.Vector                    // The location where the player was last alive. Should be equal to Position if the player is still alive.
-	UserID                int                          // Mostly used in game-events to address this player
-	Name                  string                       // Steam / in-game user name
-	Inventory             map[int]*Equipment           // All weapons / equipment the player is currently carrying
-	AmmoLeft              [32]int                      // Ammo left for special weapons (e.g. grenades), index corresponds Equipment.AmmoType
-	EntityID              int                          // Usually the same as Entity.ID() but may be different between player death and re-spawn.
-	Entity                st.IEntity                   // May be nil between player-death and re-spawn
-	AdditionalInformation *AdditionalPlayerInformation // Mostly scoreboard information such as kills, deaths, etc.
-	FlashDuration         float32                      // Blindness duration from the flashbang currently affecting the player (seconds)
-	FlashTick             int                          // In-game tick at which the player was last flashed
-	TeamState             *TeamState                   // When keeping the reference make sure you notice when the player changes teams
-	Team                  Team                         // Team identifier for the player (e.g. TeamTerrorists or TeamCounterTerrorists).
-	IsBot                 bool                         // True if this is a bot-entity. See also IsControllingBot and ControlledBot().
-	IsConnected           bool
-	IsDefusing            bool
-	IsPlanting            bool
-	IsReloading           bool
-	IsUnknown             bool // Used to identify unknown/broken players. see https://github.com/markus-wa/demoinfocs-golang/issues/162
+	SteamID           int64              // int64 representation of the User's Steam ID
+	LastAlivePosition r3.Vector          // The location where the player was last alive. Should be equal to Position if the player is still alive.
+	UserID            int                // Mostly used in game-events to address this player
+	Name              string             // Steam / in-game user name
+	Inventory         map[int]*Equipment // All weapons / equipment the player is currently carrying
+	AmmoLeft          [32]int            // Ammo left for special weapons (e.g. grenades), index corresponds Equipment.AmmoType
+	EntityID          int                // Usually the same as Entity.ID() but may be different between player death and re-spawn.
+	Entity            st.IEntity         // May be nil between player-death and re-spawn
+	FlashDuration     float32            // Blindness duration from the flashbang currently affecting the player (seconds)
+	FlashTick         int                // In-game tick at which the player was last flashed
+	TeamState         *TeamState         // When keeping the reference make sure you notice when the player changes teams
+	Team              Team               // Team identifier for the player (e.g. TeamTerrorists or TeamCounterTerrorists).
+	IsBot             bool               // True if this is a bot-entity. See also IsControllingBot and ControlledBot().
+	IsConnected       bool
+	IsDefusing        bool
+	IsPlanting        bool
+	IsReloading       bool
+	IsUnknown         bool // Used to identify unknown/broken players. see https://github.com/markus-wa/demoinfocs-golang/issues/162
 }
 
 // String returns the player's name.
@@ -121,6 +121,11 @@ Going by the last two lines, the player should not have been blinded at ~49m57.0
 This isn't very conclusive but it looks like IsFlashed isn't super reliable currently.
 */
 
+// Used internally to set the active weapon, see ActiveWeapon()
+func (p *Player) activeWeaponID() int {
+	return getInt(p.Entity, "m_hActiveWeapon") & entityHandleIndexMask
+}
+
 // ActiveWeapon returns the currently active / equipped weapon of the player.
 func (p *Player) ActiveWeapon() *Equipment {
 	return p.Inventory[p.activeWeaponID()]
@@ -280,28 +285,64 @@ func (p *Player) Velocity() r3.Vector {
 	}
 }
 
-// Used internally to set the active weapon, see ActiveWeapon()
-func (p *Player) activeWeaponID() int {
-	return getInt(p.Entity, "m_hActiveWeapon") & entityHandleIndexMask
+/////////////////////////////
+// CCSPlayerResource stuff //
+/////////////////////////////
+
+func (p *Player) entityIDStr() string {
+	return fmt.Sprintf("%03d", p.EntityID)
+}
+
+// ClanTag returns the player's individual clan tag (Steam Groups etc.).
+func (p *Player) ClanTag() string {
+	return getString(p.demoInfoProvider.PlayerResourceEntity(), "m_szClan."+p.entityIDStr())
+}
+
+// Ping returns the players latency to the game server.
+func (p *Player) Ping() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iPing."+p.entityIDStr())
+}
+
+// Score returns the players score as shown on the scoreboard.
+func (p *Player) Score() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iScore."+p.entityIDStr())
+}
+
+// Kills returns the amount of kills the player has as shown on the scoreboard.
+func (p *Player) Kills() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iKills."+p.entityIDStr())
+}
+
+// Deaths returns the amount of deaths the player has as shown on the scoreboard.
+func (p *Player) Deaths() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iDeaths."+p.entityIDStr())
+}
+
+// Assists returns the amount of assists the player has as shown on the scoreboard.
+func (p *Player) Assists() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iAssists."+p.entityIDStr())
+}
+
+// MVPs returns the amount of Most-Valuable-Player awards the player has as shown on the scoreboard.
+func (p *Player) MVPs() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iMVPs."+p.entityIDStr())
+}
+
+// MoneySpentTotal returns the total amount of money the player has spent in the current match.
+func (p *Player) MoneySpentTotal() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iTotalCashSpent."+p.entityIDStr())
 }
 
-// AdditionalPlayerInformation contains mostly scoreboard information.
-type AdditionalPlayerInformation struct {
-	Kills               int
-	Deaths              int
-	Assists             int
-	Score               int
-	MVPs                int
-	Ping                int
-	ClanTag             string
-	MoneySpentTotal     int
-	MoneySpentThisRound int
+// MoneySpentThisRound returns the amount of money the player has spent in the current round.
+func (p *Player) MoneySpentThisRound() int {
+	return getInt(p.demoInfoProvider.PlayerResourceEntity(), "m_iCashSpentThisRound."+p.entityIDStr())
 }
 
 type demoInfoProvider interface {
 	IngameTick() int   // current in-game tick, used for IsBlinded()
 	TickRate() float64 // in-game tick rate, used for Player.IsBlinded()
 	FindPlayerByHandle(handle int) *Player
+	PlayerResourceEntity() st.IEntity
 }
 
 // NewPlayer creates a *Player with an initialized equipment map.

pkg/demoinfocs/datatables.go

@@ -174,23 +174,8 @@ func (p *Parser) bindPlayers() {
 		p.bindNewPlayer(player)
 	})
 
-	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(plInfo *st.Entity) {
-		for i := 0; i < maxPlayers; i++ {
-			i2 := i // Copy so it stays the same (for passing to handlers)
-			iStr := fmt.Sprintf("%03d", i)
-
-			plInfo.BindProperty("m_szClan."+iStr, &p.additionalPlayerInfo[i2].ClanTag, st.ValTypeString)
-			plInfo.BindProperty("m_iPing."+iStr, &p.additionalPlayerInfo[i2].Ping, st.ValTypeInt)
-			plInfo.BindProperty("m_iScore."+iStr, &p.additionalPlayerInfo[i2].Score, st.ValTypeInt)
-			plInfo.BindProperty("m_iKills."+iStr, &p.additionalPlayerInfo[i2].Kills, st.ValTypeInt)
-			plInfo.BindProperty("m_iDeaths."+iStr, &p.additionalPlayerInfo[i2].Deaths, st.ValTypeInt)
-			plInfo.BindProperty("m_iAssists."+iStr, &p.additionalPlayerInfo[i2].Assists, st.ValTypeInt)
-			plInfo.BindProperty("m_iMVPs."+iStr, &p.additionalPlayerInfo[i2].MVPs, st.ValTypeInt)
-			plInfo.BindProperty("m_iTotalCashSpent."+iStr, &p.additionalPlayerInfo[i2].MoneySpentTotal, st.ValTypeInt)
-			if prop := plInfo.Property("m_iCashSpentThisRound." + iStr); prop != nil {
-				prop.Bind(&p.additionalPlayerInfo[i2].MoneySpentThisRound, st.ValTypeInt)
-			}
-		}
+	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(entity *st.Entity) {
+		p.playerResourceEntity = entity
 	})
 }
 
@@ -238,7 +223,6 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 
 	pl.EntityID = entityID
 	pl.Entity = playerEntity
-	pl.AdditionalInformation = &p.additionalPlayerInfo[entityID]
 	pl.IsConnected = true
 
 	playerEntity.OnDestroy(func() {

pkg/demoinfocs/events/events_test.go

@@ -7,7 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	common "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/common"
-	"github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
+	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 	stfake "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables/fake"
 )
 
@@ -68,7 +68,7 @@ func TestItemPickup_WeaponTraceable_WeaponFound(t *testing.T) {
 	assert.Equal(t, wep, e.WeaponTraceable())
 }
 
-func entity() sendtables.IEntity {
+func entity() st.IEntity {
 	entity := new(stfake.Entity)
 	entity.On("ID").Return(1)
 
@@ -104,3 +104,6 @@ func (p demoInfoProviderMock) TickRate() float64 {
 func (p demoInfoProviderMock) FindPlayerByHandle(handle int) *common.Player {
 	return nil
 }
+func (p demoInfoProviderMock) PlayerResourceEntity() st.IEntity {
+	return nil
+}

pkg/demoinfocs/parser.go

@@ -66,13 +66,13 @@ type Parser struct {
 	bombsiteB            bombsite
 	equipmentMapping     map[*st.ServerClass]common.EquipmentType        // Maps server classes to equipment-types
 	rawPlayers           map[int]*playerInfo                             // Maps entity IDs to 'raw' player info
-	additionalPlayerInfo [maxPlayers]common.AdditionalPlayerInformation  // Maps entity IDs to additional player info (scoreboard info)
 	modelPreCache        []string                                        // Used to find out whether a weapon is a p250 or cz for example (same id)
 	triggers             map[int]*boundingBoxInformation                 // Maps entity IDs to triggers (used for bombsites)
 	gameEventDescs       map[int32]*msg.CSVCMsg_GameEventListDescriptorT // Maps game-event IDs to descriptors
 	grenadeModelIndices  map[int]common.EquipmentType                    // Used to map model indices to grenades (used for grenade projectiles)
 	stringTables         []*msg.CSVCMsg_CreateStringTable                // Contains all created sendtables, needed when updating them
 	delayedEventHandlers []func()                                        // Contains event handlers that need to be executed at the end of a tick (e.g. flash events because FlashDuration isn't updated before that)
+	playerResourceEntity st.IEntity                                      // CCSPlayerResource entity instance, contains scoreboard info and more
 }
 
 // NetMessageCreator creates additional net-messages to be dispatched to net-message handlers.
@@ -342,3 +342,7 @@ func (p demoInfoProvider) TickRate() float64 {
 func (p demoInfoProvider) FindPlayerByHandle(handle int) *common.Player {
 	return p.parser.gameState.Participants().FindByHandle(handle)
 }
+
+func (p demoInfoProvider) PlayerResourceEntity() st.IEntity {
+	return p.parser.playerResourceEntity
+}