common: replaced more bindings with getters

Author: markus-wa

examples/heatmap/heatmap.go

@@ -46,7 +46,7 @@ func main() {
 	var points []r2.Point
 	p.RegisterEventHandler(func(e events.WeaponFire) {
 		// Translate positions from in-game coordinates to radar overview image pixels
-		x, y := mapMetadata.TranslateScale(e.Shooter.Position.X, e.Shooter.Position.Y)
+		x, y := mapMetadata.TranslateScale(e.Shooter.Position().X, e.Shooter.Position().Y)
 
 		points = append(points, r2.Point{X: x, Y: y})
 	})

examples/print-events/print_events.go

@@ -13,9 +13,10 @@ import (
 // Run like this: go run print_events.go -demo /path/to/demo.dem
 func main() {
 	f, err := os.Open(ex.DemoPathFromArgs())
-	defer f.Close()
 	checkError(err)
 
+	defer f.Close()
+
 	p := demoinfocs.NewParser(f)
 
 	// Parse header
@@ -42,9 +43,9 @@ func main() {
 		switch e.Winner {
 		case common.TeamTerrorists:
 			// Winner's score + 1 because it hasn't actually been updated yet
-			fmt.Printf("Round finished: winnerSide=T  ; score=%d:%d\n", gs.TeamTerrorists().Score+1, gs.TeamCounterTerrorists().Score)
+			fmt.Printf("Round finished: winnerSide=T  ; score=%d:%d\n", gs.TeamTerrorists().Score()+1, gs.TeamCounterTerrorists().Score())
 		case common.TeamCounterTerrorists:
-			fmt.Printf("Round finished: winnerSide=CT ; score=%d:%d\n", gs.TeamCounterTerrorists().Score+1, gs.TeamTerrorists().Score)
+			fmt.Printf("Round finished: winnerSide=CT ; score=%d:%d\n", gs.TeamCounterTerrorists().Score()+1, gs.TeamTerrorists().Score())
 		default:
 			// Probably match medic or something similar
 			fmt.Println("Round finished: No winner (tie)")

pkg/demoinfocs/common/common.go

@@ -104,7 +104,7 @@ type Bomb struct {
 // or LastOnGroundPosition if it's dropped or planted.
 func (b Bomb) Position() r3.Vector {
 	if b.Carrier != nil {
-		return b.Carrier.Position
+		return b.Carrier.Position()
 	}
 
 	return b.LastOnGroundPosition
@@ -115,16 +115,7 @@ type TeamState struct {
 	team            Team
 	membersCallback func(Team) []*Player
 
-	// ID stays the same even after switching sides.
-	ID int
-
-	Score    int
-	ClanName string
-
-	// Flag, e.g. DE, FR, etc.
-	//
-	// Watch out, in some demos this is upper-case and in some lower-case.
-	Flag string
+	Entity st.IEntity
 
 	// Terrorist TeamState for CTs, CT TeamState for Terrorists
 	Opponent *TeamState
@@ -135,15 +126,37 @@ func (ts TeamState) Team() Team {
 	return ts.team
 }
 
-// Members returns the members of the team.
+// ID returns the team ID, this stays the same even after switching sides.
+func (ts TeamState) ID() int {
+	return getInt(ts.Entity, "m_iTeamNum")
+}
+
+// Score returns the current score of the team (usually 0-16 without overtime).
+func (ts TeamState) Score() int {
+	return getInt(ts.Entity, "m_scoreTotal")
+}
+
+// ClanName returns the team name (e.g. Fnatic).
+func (ts TeamState) ClanName() string {
+	return getString(ts.Entity, "m_szClanTeamname")
+}
+
+// Flag returns the flag code (e.g. DE, FR, etc.).
+//
+// Watch out, in some demos this is upper-case and in some lower-case.
+func (ts TeamState) Flag() string {
+	return getString(ts.Entity, "m_szTeamFlagImage")
+}
+
+// Members returns the players that are members of the team.
 func (ts TeamState) Members() []*Player {
 	return ts.membersCallback(ts.team)
 }
 
 // CurrentEquipmentValue returns the cumulative value of all equipment currently owned by the members of the team.
 func (ts TeamState) CurrentEquipmentValue() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.CurrentEquipmentValue
+		value += pl.EquipmentValueCurrent()
 	}
 
 	return
@@ -152,7 +165,7 @@ func (ts TeamState) CurrentEquipmentValue() (value int) {
 // RoundStartEquipmentValue returns the cumulative value of all equipment owned by the members of the team at the start of the current round.
 func (ts TeamState) RoundStartEquipmentValue() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.RoundStartEquipmentValue
+		value += pl.EquipmentValueRoundStart()
 	}
 
 	return
@@ -161,25 +174,25 @@ func (ts TeamState) RoundStartEquipmentValue() (value int) {
 // FreezeTimeEndEquipmentValue returns the cumulative value of all equipment owned by the members of the team at the end of the freeze-time of the current round.
 func (ts TeamState) FreezeTimeEndEquipmentValue() (value int) {
 	for _, pl := range ts.Members() {
-		value += pl.FreezetimeEndEquipmentValue
+		value += pl.EquipmentValueFreezeTimeEnd()
 	}
 
 	return
 }
 
-// CashSpentThisRound returns the total amount of cash spent by the whole team in the current round.
-func (ts TeamState) CashSpentThisRound() (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.CashSpentThisRound
+		value += pl.AdditionalInformation.MoneySpentThisRound
 	}
 
 	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) {
+// 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.CashSpentTotal
+		value += pl.AdditionalInformation.MoneySpentTotal
 	}
 
 	return

pkg/demoinfocs/common/common_test.go

@@ -20,7 +20,11 @@ func TestBombPosition(t *testing.T) {
 	assert.Equal(t, groundPos, bomb.Position(), "Bomb position should be LastOnGroundPosition")
 
 	playerPos := r3.Vector{X: 4, Y: 5, Z: 6}
-	bomb.Carrier = &Player{Position: playerPos}
+
+	plEntity := entityWithID(1)
+	plEntity.On("Position").Return(playerPos)
+
+	bomb.Carrier = &Player{Entity: plEntity}
 	assert.Equal(t, playerPos, bomb.Position(), "Bomb position should be Player.Position")
 }
 
@@ -59,45 +63,54 @@ func TestTeamState_Members(t *testing.T) {
 	assert.Equal(t, members, state.Members())
 }
 
-func TestTeamState_CurrentEquipmentValue(t *testing.T) {
-	members := []*Player{{CurrentEquipmentValue: 100}, {CurrentEquipmentValue: 200}}
+func TestTeamState_EquipmentValueCurrent(t *testing.T) {
+	members := []*Player{
+		playerWithProperty("m_unCurrentEquipmentValue", st.PropertyValue{IntVal: 100}),
+		playerWithProperty("m_unCurrentEquipmentValue", st.PropertyValue{IntVal: 200}),
+	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
 	assert.Equal(t, 300, state.CurrentEquipmentValue())
 }
 
-func TestTeamState_RoundStartEquipmentValue(t *testing.T) {
-	members := []*Player{{RoundStartEquipmentValue: 100}, {RoundStartEquipmentValue: 200}}
+func TestTeamState_EquipmentValueRoundStart(t *testing.T) {
+	members := []*Player{
+		playerWithProperty("m_unRoundStartEquipmentValue", st.PropertyValue{IntVal: 100}),
+		playerWithProperty("m_unRoundStartEquipmentValue", st.PropertyValue{IntVal: 200}),
+	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
 	assert.Equal(t, 300, state.RoundStartEquipmentValue())
 }
 
-func TestTeamState_FreezeTimeEndEquipmentValue(t *testing.T) {
-	members := []*Player{{FreezetimeEndEquipmentValue: 100}, {FreezetimeEndEquipmentValue: 200}}
+func TestTeamState_EquipmentValueFreezeTimeEnd(t *testing.T) {
+	members := []*Player{
+		playerWithProperty("m_unFreezetimeEndEquipmentValue", st.PropertyValue{IntVal: 100}),
+		playerWithProperty("m_unFreezetimeEndEquipmentValue", st.PropertyValue{IntVal: 200}),
+	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
 	assert.Equal(t, 300, state.FreezeTimeEndEquipmentValue())
 }
 
-func TestTeamState_CashSpentThisRound(t *testing.T) {
+func TestTeamState_MoneySpentThisRound(t *testing.T) {
 	members := []*Player{
-		{AdditionalInformation: &AdditionalPlayerInformation{CashSpentThisRound: 100}},
-		{AdditionalInformation: &AdditionalPlayerInformation{CashSpentThisRound: 200}},
+		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentThisRound: 100}},
+		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentThisRound: 200}},
 	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
-	assert.Equal(t, 300, state.CashSpentThisRound())
+	assert.Equal(t, 300, state.MoneySpentThisRound())
 }
 
-func TestTeamState_CashSpentTotal(t *testing.T) {
+func TestTeamState_MoneySpentTotal(t *testing.T) {
 	members := []*Player{
-		{AdditionalInformation: &AdditionalPlayerInformation{CashSpentTotal: 100}},
-		{AdditionalInformation: &AdditionalPlayerInformation{CashSpentTotal: 200}},
+		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentTotal: 100}},
+		{AdditionalInformation: &AdditionalPlayerInformation{MoneySpentTotal: 200}},
 	}
 	state := NewTeamState(TeamTerrorists, func(Team) []*Player { return members })
 
-	assert.Equal(t, 300, state.CashSpentTotal())
+	assert.Equal(t, 300, state.MoneySpentTotal())
 }
 
 type demoInfoProviderMock struct {
@@ -125,9 +138,15 @@ func mockDemoInfoProvider(tickRate float64, tick int) demoInfoProvider {
 	}
 }
 
-func entityWithProperty(propName string, value st.PropertyValue) st.IEntity {
+func entityWithID(id int) *stfake.Entity {
 	entity := new(stfake.Entity)
-	entity.On("ID").Return(1)
+	entity.On("ID").Return(id)
+
+	return entity
+}
+
+func entityWithProperty(propName string, value st.PropertyValue) *stfake.Entity {
+	entity := entityWithID(1)
 
 	prop := new(stfake.Property)
 	prop.On("Value").Return(value)

pkg/demoinfocs/common/entity_util.go

@@ -0,0 +1,35 @@
+package common
+
+import st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
+
+func getInt(entity st.IEntity, propName string) int {
+	if entity == nil {
+		return 0
+	}
+
+	return entity.PropertyValueMust(propName).IntVal
+}
+
+func getFloat(entity st.IEntity, propName string) float32 {
+	if entity == nil {
+		return 0
+	}
+
+	return entity.PropertyValueMust(propName).FloatVal
+}
+
+func getString(entity st.IEntity, propName string) string {
+	if entity == nil {
+		return ""
+	}
+
+	return entity.PropertyValueMust(propName).StringVal
+}
+
+func getBool(entity st.IEntity, propName string) bool {
+	if entity == nil {
+		return false
+	}
+
+	return entity.PropertyValueMust(propName).BoolVal()
+}

pkg/demoinfocs/common/equipment.go

@@ -328,13 +328,17 @@ func (e Equipment) AmmoInMagazine() int {
 
 // AmmoType returns the weapon's ammo type, mostly (only?) relevant for grenades.
 func (e Equipment) AmmoType() int {
-	return e.Entity.PropertyValueMust("LocalWeaponData.m_iPrimaryAmmoType").IntVal
+	return getInt(e.Entity, "LocalWeaponData.m_iPrimaryAmmoType")
 }
 
 // ZoomLevel returns how far the player has zoomed in on the weapon.
 // Only weapons with scopes have a valid zoom level.
 func (e Equipment) ZoomLevel() ZoomLevel {
-	val, _ := e.Entity.PropertyValue("LocalWeaponData.m_iPrimaryAmmoType")
+	if e.Entity == nil {
+		return 0
+	}
+
+	val, _ := e.Entity.PropertyValue("m_zoomLevel")
 	return ZoomLevel(val.IntVal)
 }