common: changed some receiver types from struct to pointer

Author: markus-wa

pkg/demoinfocs/common/common.go

@@ -42,7 +42,7 @@ type DemoHeader struct {
 // Not necessarily the tick-rate the server ran on during the game.
 //
 // Returns 0 if PlaybackTime or PlaybackFrames are 0 (corrupt demo headers).
-func (h DemoHeader) FrameRate() float64 {
+func (h *DemoHeader) FrameRate() float64 {
 	if h.PlaybackTime == 0 {
 		return 0
 	}
@@ -53,7 +53,7 @@ func (h DemoHeader) FrameRate() float64 {
 // FrameTime returns the time a frame / demo-tick takes in seconds.
 //
 // Returns 0 if PlaybackTime or PlaybackFrames are 0 (corrupt demo headers).
-func (h DemoHeader) FrameTime() time.Duration {
+func (h *DemoHeader) FrameTime() time.Duration {
 	if h.PlaybackFrames == 0 {
 		return 0
 	}
@@ -75,14 +75,14 @@ type GrenadeProjectile struct {
 }
 
 // Position returns the current position of the grenade projectile in world coordinates.
-func (g GrenadeProjectile) Position() r3.Vector {
+func (g *GrenadeProjectile) Position() r3.Vector {
 	return g.Entity.Position()
 }
 
 // UniqueID returns the unique id of the grenade.
 // The unique id is a random int generated internally by this library and can be used to differentiate
 // grenades from each other. This is needed because demo-files reuse entity ids.
-func (g GrenadeProjectile) UniqueID() int64 {
+func (g *GrenadeProjectile) UniqueID() int64 {
 	return g.uniqueID
 }
 
@@ -104,7 +104,7 @@ type Bomb struct {
 // Position returns the current position of the bomb.
 // This is either the position of the player holding it
 // or LastOnGroundPosition if it's dropped or planted.
-func (b Bomb) Position() r3.Vector {
+func (b *Bomb) Position() r3.Vector {
 	if b.Carrier != nil {
 		return b.Carrier.Position()
 	}
@@ -124,39 +124,39 @@ type TeamState struct {
 }
 
 // Team returns the team for which the TeamState contains data.
-func (ts TeamState) Team() Team {
+func (ts *TeamState) Team() Team {
 	return ts.team
 }
 
 // ID returns the team ID, this stays the same even after switching sides.
-func (ts TeamState) ID() int {
+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 {
+func (ts *TeamState) Score() int {
 	return getInt(ts.Entity, "m_scoreTotal")
 }
 
 // ClanName returns the team name (e.g. Fnatic).
-func (ts TeamState) ClanName() string {
+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 {
+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 {
+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) {
+func (ts *TeamState) CurrentEquipmentValue() (value int) {
 	for _, pl := range ts.Members() {
 		value += pl.EquipmentValueCurrent()
 	}
@@ -165,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) {
+func (ts *TeamState) RoundStartEquipmentValue() (value int) {
 	for _, pl := range ts.Members() {
 		value += pl.EquipmentValueRoundStart()
 	}
@@ -174,7 +174,7 @@ 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) {
+func (ts *TeamState) FreezeTimeEndEquipmentValue() (value int) {
 	for _, pl := range ts.Members() {
 		value += pl.EquipmentValueFreezeTimeEnd()
 	}
@@ -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) {
+func (ts *TeamState) MoneySpentThisRound() (value int) {
 	for _, pl := range ts.Members() {
 		value += pl.MoneySpentThisRound()
 	}
@@ -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) {
+func (ts *TeamState) MoneySpentTotal() (value int) {
 	for _, pl := range ts.Members() {
 		value += pl.MoneySpentTotal()
 	}

pkg/demoinfocs/common/common_test.go

@@ -44,16 +44,19 @@ func TestDemoHeader(t *testing.T) {
 }
 
 func TestDemoHeader_FrameRate_PlaybackTime_Zero(t *testing.T) {
-	assert.Zero(t, DemoHeader{}.FrameRate())
+	assert.Zero(t, new(DemoHeader).FrameRate())
 }
 
 func TestDemoHeader_FrameTime_PlaybackFrames_Zero(t *testing.T) {
-	assert.Zero(t, DemoHeader{}.FrameTime())
+	assert.Zero(t, new(DemoHeader).FrameTime())
 }
 
 func TestTeamState_Team(t *testing.T) {
-	assert.Equal(t, TeamTerrorists, NewTeamState(TeamTerrorists, nil).Team())
-	assert.Equal(t, TeamCounterTerrorists, NewTeamState(TeamCounterTerrorists, nil).Team())
+	tState := NewTeamState(TeamTerrorists, nil)
+	ctState := NewTeamState(TeamCounterTerrorists, nil)
+
+	assert.Equal(t, TeamTerrorists, tState.Team())
+	assert.Equal(t, TeamCounterTerrorists, ctState.Team())
 }
 
 func TestTeamState_Members(t *testing.T) {

pkg/demoinfocs/common/equipment.go

@@ -291,26 +291,26 @@ type Equipment struct {
 
 // String returns a human readable name for the equipment.
 // E.g. 'AK-47', 'UMP-45', 'Smoke Grenade' etc.
-func (e Equipment) String() string {
+func (e *Equipment) String() string {
 	return e.Type.String()
 }
 
 // Class returns the class of the equipment.
 // E.g. pistol, smg, heavy etc.
-func (e Equipment) Class() EquipmentClass {
+func (e *Equipment) Class() EquipmentClass {
 	return e.Type.Class()
 }
 
 // UniqueID returns the unique id of the equipment element.
 // The unique id is a random int generated internally by this library and can be used to differentiate
 // equipment from each other. This is needed because demo-files reuse entity ids.
-func (e Equipment) UniqueID() int64 {
+func (e *Equipment) UniqueID() int64 {
 	return e.uniqueID
 }
 
 // AmmoInMagazine returns the ammo left in the magazine.
 // Returns CWeaponCSBase.m_iClip1 for most weapons and 1 for grenades.
-func (e Equipment) AmmoInMagazine() int {
+func (e *Equipment) AmmoInMagazine() int {
 	if e.Class() == EqClassGrenade {
 		return 1
 	}
@@ -329,13 +329,13 @@ func (e Equipment) AmmoInMagazine() int {
 }
 
 // AmmoType returns the weapon's ammo type, mostly (only?) relevant for grenades.
-func (e Equipment) AmmoType() int {
+func (e *Equipment) AmmoType() int {
 	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 {
+func (e *Equipment) ZoomLevel() ZoomLevel {
 	if e.Entity == nil {
 		return 0
 	}
@@ -349,7 +349,7 @@ func (e Equipment) ZoomLevel() ZoomLevel {
 // AmmoReserve returns the ammo left available for reloading.
 // Returns CWeaponCSBase.m_iPrimaryReserveAmmoCount for most weapons and 'Owner.AmmoLeft[AmmoType] - 1' for grenades.
 // Use AmmoInMagazine() + AmmoReserve() to quickly get the amount of grenades a player owns.
-func (e Equipment) AmmoReserve() int {
+func (e *Equipment) AmmoReserve() int {
 	if e.Class() == EqClassGrenade {
 		if e.Owner != nil {
 			// minus one for 'InMagazine'

pkg/demoinfocs/common/inferno.go

@@ -40,13 +40,19 @@ type Fires struct {
 // UniqueID returns the unique id of the inferno.
 // The unique id is a random int generated internally by this library and can be used to differentiate
 // infernos from each other. This is needed because demo-files reuse entity ids.
-func (inf Inferno) UniqueID() int64 {
+func (inf *Inferno) UniqueID() int64 {
 	return inf.uniqueID
 }
 
+// Thrower returns the player who threw the fire grenade.
+// Could be nil if the player disconnected after throwing it.
+func (inf *Inferno) Thrower() *Player {
+	return inf.demoInfoProvider.FindPlayerByHandle(inf.Entity.Property("m_hOwnerEntity").Value().IntVal)
+}
+
 // Fires returns all fires (past + present).
 // Some are currently active and some have extinguished (see Fire.IsBurning).
-func (inf Inferno) Fires() Fires {
+func (inf *Inferno) Fires() Fires {
 	entity := inf.Entity
 	origin := entity.Position()
 	nFires := entity.PropertyValueMust("m_fireCount").IntVal
@@ -173,12 +179,6 @@ func (f Fires) ConvexHull3D() quickhull.ConvexHull {
 	return convexHull(pointCloud)
 }
 
-// Thrower returns the player who threw the fire grenade.
-// Could be nil if the player disconnected after throwing it.
-func (inf Inferno) Thrower() *Player {
-	return inf.demoInfoProvider.FindPlayerByHandle(inf.Entity.Property("m_hOwnerEntity").Value().IntVal)
-}
-
 func convexHull(pointCloud []r3.Vector) quickhull.ConvexHull {
 	return new(quickhull.QuickHull).ConvexHull(pointCloud, false, false, 0)
 }