common: fix Player.CashSpentThisRound() & CashSpentTotal()

fixes #126

Author: markus-wa

common/common.go

@@ -165,15 +165,15 @@ func (ts TeamState) FreezeTimeEndEquipmentValue() (value int) {
 // CashSpentThisRound returns the total amount of cash spent by the whole team in the current round.
 func (ts TeamState) CashSpentThisRound() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.CashSpentThisRound()
+		value += pl.AdditionalPlayerInformation.CashSpentThisRound
 	}
 	return
 }
 
 // CashSpentThisRound returns the total amount of cash spent by the whole team during the whole game up to the current point.
 func (ts TeamState) CashSpentTotal() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.CashSpentTotal()
+		value += pl.AdditionalPlayerInformation.TotalCashSpent
 	}
 	return
 }

common/common_test.go

@@ -6,8 +6,6 @@ import (
 
 	"github.com/golang/geo/r3"
 	"github.com/stretchr/testify/assert"
-
-	"github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
 func TestBombPosition(t *testing.T) {
@@ -77,23 +75,3 @@ func TestTeamState_FreezeTimeEndEquipmentValue(t *testing.T) {
 
 	assert.Equal(t, 300, state.FreezeTimeEndEquipmentValue())
 }
-
-func TestTeamState_CashSpentThisRound(t *testing.T) {
-	members := []*Player{
-		playerWithProperty("m_iCashSpentThisRound", sendtables.PropertyValue{IntVal: 100}),
-		playerWithProperty("m_iCashSpentThisRound", sendtables.PropertyValue{IntVal: 200}),
-	}
-	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
-
-	assert.Equal(t, 300, state.CashSpentThisRound())
-}
-
-func TestTeamState_CashSpentTotal(t *testing.T) {
-	members := []*Player{
-		playerWithProperty("m_iTotalCashSpent", sendtables.PropertyValue{IntVal: 100}),
-		playerWithProperty("m_iTotalCashSpent", sendtables.PropertyValue{IntVal: 200}),
-	}
-	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
-
-	assert.Equal(t, 300, state.CashSpentTotal())
-}

common/player.go

@@ -9,8 +9,7 @@ import (
 
 // Player contains mostly game-relevant player information.
 type Player struct {
-	tickRate           float64            // the in-game tick rate, used for IsBlinded()
-	ingameTickProvider ingameTickProvider // provider for the current in-game tick, used for IsBlinded()
+	demoInfoProvider demoInfoProvider // provider for demo info such as tick-rate or current tick
 
 	SteamID                     int64     // int64 representation of the User's Steam ID
 	Position                    r3.Vector // In-game coordinates. Like the one you get from cl_showpos 1
@@ -73,11 +72,12 @@ func (p *Player) flashDurationTimeFull() time.Duration {
 func (p *Player) FlashDurationTimeRemaining() time.Duration {
 	// In case the demo header is broken
 	// TODO: read tickRate from CVARs as fallback
-	if p.tickRate == 0 {
+	tickRate := p.demoInfoProvider.TickRate()
+	if tickRate == 0 {
 		return time.Duration(p.FlashDuration) * time.Second
 	}
 
-	timeSinceFlash := time.Duration(float64(p.ingameTickProvider()-p.FlashTick) / p.tickRate * float64(time.Second))
+	timeSinceFlash := time.Duration(float64(p.demoInfoProvider.IngameTick()-p.FlashTick) / tickRate * float64(time.Second))
 	remaining := p.flashDurationTimeFull() - timeSinceFlash
 	if remaining < 0 {
 		return 0
@@ -159,37 +159,43 @@ func (p *Player) IsScoped() bool {
 }
 
 // CashSpentThisRound returns the amount of cash the player spent in the current round.
+//
+// Deprecated, use Player.AdditionalPlayerInformation.CashSpentThisRound instead.
 func (p *Player) CashSpentThisRound() int {
-	return p.Entity.FindPropertyI("m_iCashSpentThisRound").Value().IntVal
+	return p.AdditionalPlayerInformation.CashSpentThisRound
 }
 
 // CashSpentTotal returns the amount of cash the player spent during the whole game up to the current point.
+//
+// Deprecated, use Player.AdditionalPlayerInformation.TotalCashSpent instead.
 func (p *Player) CashSpentTotal() int {
-	return p.Entity.FindPropertyI("m_iTotalCashSpent").Value().IntVal
+	return p.AdditionalPlayerInformation.TotalCashSpent
 }
 
 // AdditionalPlayerInformation contains mostly scoreboard information.
 type AdditionalPlayerInformation struct {
-	Kills          int
-	Deaths         int
-	Assists        int
-	Score          int
-	MVPs           int
-	Ping           int
-	ClanTag        string
-	TotalCashSpent int
+	Kills              int
+	Deaths             int
+	Assists            int
+	Score              int
+	MVPs               int
+	Ping               int
+	ClanTag            string
+	TotalCashSpent     int
+	CashSpentThisRound int
 }
 
-// ingameTickProvider is a function that returns the current ingame tick of the demo related to a player.
-type ingameTickProvider func() int
+type demoInfoProvider interface {
+	IngameTick() int   // current in-game tick, used for IsBlinded()
+	TickRate() float64 // in-game tick rate, used for Player.IsBlinded()
+}
 
 // NewPlayer creates a *Player with an initialized equipment map.
 //
 // Intended for internal use only.
-func NewPlayer(tickRate float64, ingameTickProvider ingameTickProvider) *Player {
+func NewPlayer(demoInfoProvider demoInfoProvider) *Player {
 	return &Player{
-		RawWeapons:         make(map[int]*Equipment),
-		tickRate:           tickRate,
-		ingameTickProvider: ingameTickProvider,
+		RawWeapons:       make(map[int]*Equipment),
+		demoInfoProvider: demoInfoProvider,
 	}
 }

common/player_test.go

@@ -87,7 +87,7 @@ func TestPlayer_FlashDurationTime(t *testing.T) {
 }
 
 func TestPlayer_FlashDurationTimeRemaining_Default(t *testing.T) {
-	pl := NewPlayer(0, tickProvider(128))
+	pl := NewPlayer(mockDemoInfoProvider(0, 128))
 
 	assert.Equal(t, time.Duration(0), pl.FlashDurationTimeRemaining())
 }
@@ -117,7 +117,7 @@ func TestPlayer_FlashDurationTimeRemaining_FlashDuration_Over(t *testing.T) {
 }
 
 func TestPlayer_FlashDurationTimeRemaining_Fallback(t *testing.T) {
-	pl := NewPlayer(0, tickProvider(128))
+	pl := NewPlayer(mockDemoInfoProvider(0, 128))
 
 	pl.FlashDuration = 2
 	pl.FlashTick = 128 * 2
@@ -191,24 +191,28 @@ func TestPlayer_IsScoped(t *testing.T) {
 	assert.True(t, pl.IsScoped())
 }
 
-func TestPlayer_CashSpentThisRound(t *testing.T) {
-	pl := playerWithProperty("m_iCashSpentThisRound", sendtables.PropertyValue{IntVal: 500})
-
-	assert.Equal(t, 500, pl.CashSpentThisRound())
+func newPlayer(tick int) *Player {
+	return NewPlayer(mockDemoInfoProvider(128, tick))
 }
 
-func TestPlayer_CashSpentTotal(t *testing.T) {
-	pl := playerWithProperty("m_iTotalCashSpent", sendtables.PropertyValue{IntVal: 500})
+type demoInfoProviderMock struct {
+	tickRate   float64
+	ingameTick int
+}
 
-	assert.Equal(t, 500, pl.CashSpentTotal())
+func (p demoInfoProviderMock) TickRate() float64 {
+	return p.tickRate
 }
 
-func newPlayer(tick int) *Player {
-	return NewPlayer(128, tickProvider(tick))
+func (p demoInfoProviderMock) IngameTick() int {
+	return p.ingameTick
 }
 
-func tickProvider(tick int) ingameTickProvider {
-	return func() int { return tick }
+func mockDemoInfoProvider(tickRate float64, tick int) demoInfoProvider {
+	return demoInfoProviderMock{
+		tickRate:   tickRate,
+		ingameTick: tick,
+	}
 }
 
 func playerWithProperty(propName string, value sendtables.PropertyValue) *Player {

datatables.go

@@ -174,6 +174,9 @@ func (p *Parser) bindPlayers() {
 			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].TotalCashSpent, st.ValTypeInt)
+			if prop := plInfo.FindProperty("m_iCashSpentThisRound." + iStr); prop != nil {
+				prop.Bind(&p.additionalPlayerInfo[i2].CashSpentThisRound, st.ValTypeInt)
+			}
 		}
 	})
 }
@@ -191,7 +194,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 			isNew = true
 
 			// TODO: read tickRate from CVARs as fallback
-			pl = common.NewPlayer(p.header.TickRate(), p.gameState.IngameTick)
+			pl = common.NewPlayer(p.demoInfoProvider)
 			pl.Name = rp.name
 			pl.SteamID = rp.xuid
 			pl.IsBot = rp.isFakePlayer || rp.guid == "BOT"

events/events_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func TestPlayerFlashed_FlashDuration(t *testing.T) {
-	p := common.NewPlayer(128, func() int { return 0 })
+	p := common.NewPlayer(demoInfoProvider{})
 	e := PlayerFlashed{Player: p}
 
 	assert.Equal(t, time.Duration(0), e.FlashDuration())
@@ -41,3 +41,14 @@ func TestBombEvents(t *testing.T) {
 		e.implementsBombEventIf()
 	}
 }
+
+type demoInfoProvider struct {
+}
+
+func (p demoInfoProvider) IngameTick() int {
+	return 0
+}
+
+func (p demoInfoProvider) TickRate() float64 {
+	return 128
+}

game_state_test.go

@@ -149,7 +149,7 @@ func TestParticipants_FindByHandle_InvalidEntityHandle(t *testing.T) {
 
 func TestParticipants_Connected_SuppressNoEntity(t *testing.T) {
 	pl := newPlayer()
-	pl2 := common.NewPlayer(0, func() int { return 0 })
+	pl2 := common.NewPlayer(nil)
 	pl2.IsConnected = true
 
 	ptcps := Participants{
@@ -254,7 +254,7 @@ func TestParticipants_SpottedBy(t *testing.T) {
 }
 
 func newPlayer() *common.Player {
-	pl := common.NewPlayer(0, func() int { return 0 })
+	pl := common.NewPlayer(nil)
 	pl.Entity = new(st.Entity)
 	pl.IsConnected = true
 	return pl

parser.go

@@ -54,9 +54,10 @@ type Parser struct {
 	currentFrame                 int                // Demo-frame, not ingame-tick
 	header                       *common.DemoHeader // Pointer so we can check for nil
 	gameState                    *GameState
-	cancelChan                   chan struct{} // Non-anime-related, used for aborting the parsing
-	err                          error         // Contains a error that occurred during parsing if any
-	errLock                      sync.Mutex    // Used to sync up error mutations between parsing & handling go-routines
+	demoInfoProvider             demoInfoProvider // Provides demo infos to other packages that the core package depends on
+	cancelChan                   chan struct{}    // Non-anime-related, used for aborting the parsing
+	err                          error            // Contains a error that occurred during parsing if any
+	errLock                      sync.Mutex       // Used to sync up error mutations between parsing & handling go-routines
 
 	// Additional fields, mainly caching & tracking things
 
@@ -243,6 +244,7 @@ func NewParserWithConfig(demostream io.Reader, config ParserConfig) *Parser {
 	p.grenadeModelIndices = make(map[int]common.EquipmentElement)
 	p.gameEventHandler = newGameEventHandler(&p)
 	p.userMessageHandler = newUserMessageHandler(&p)
+	p.demoInfoProvider = demoInfoProvider{parser: &p}
 
 	// Attach proto msg handlers
 	p.msgDispatcher.RegisterHandler(p.handlePacketEntities)
@@ -267,3 +269,15 @@ func (p *Parser) initMsgQueue(buf int) {
 	p.msgQueue = make(chan interface{}, buf)
 	p.msgDispatcher.AddQueues(p.msgQueue)
 }
+
+type demoInfoProvider struct {
+	parser *Parser
+}
+
+func (p demoInfoProvider) IngameTick() int {
+	return p.parser.gameState.IngameTick()
+}
+
+func (p demoInfoProvider) TickRate() float64 {
+	return p.parser.header.TickRate()
+}