move Player.ResourceEntity() to GameState.PlayerResourceEntity() (#266)

Author: markus-wa

pkg/demoinfocs/common/player.go

@@ -352,67 +352,72 @@ func (p *Player) Flags() PlayerFlags {
 	return PlayerFlags(getInt(p.Entity, "m_fFlags"))
 }
 
-/////////////////////////////
+// //////////////////////////
 // CCSPlayerResource stuff //
-/////////////////////////////
+// //////////////////////////
 
 func (p *Player) entityIDStr() string {
 	return fmt.Sprintf("%03d", p.EntityID)
 }
 
-// ResourceEntity returns the player's CCSPlayerResource entity.
+// ResourceEntity returns the game's CCSPlayerResource entity.
+// Deprecated: use GameState.PlayerResourceEntity() instead.
 func (p *Player) ResourceEntity() st.Entity {
+	return p.resourceEntity()
+}
+
+func (p *Player) resourceEntity() st.Entity {
 	return p.demoInfoProvider.PlayerResourceEntity()
 }
 
 // ClanTag returns the player's individual clan tag (Steam Groups etc.).
 func (p *Player) ClanTag() string {
-	return getString(p.ResourceEntity(), "m_szClan."+p.entityIDStr())
+	return getString(p.resourceEntity(), "m_szClan."+p.entityIDStr())
 }
 
 // Ping returns the players latency to the game server.
 func (p *Player) Ping() int {
-	return getInt(p.ResourceEntity(), "m_iPing."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "m_iPing."+p.entityIDStr())
 }
 
 // Score returns the players score as shown on the scoreboard.
 func (p *Player) Score() int {
-	return getInt(p.ResourceEntity(), "m_iScore."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "m_iScore."+p.entityIDStr())
 }
 
 // Color returns the players color as shown on the match.
 func (p *Player) Color() Color {
-	return Color(getInt(p.ResourceEntity(), "m_iCompTeammateColor."+p.entityIDStr()))
+	return Color(getInt(p.resourceEntity(), "m_iCompTeammateColor."+p.entityIDStr()))
 }
 
 // Kills returns the amount of kills the player has as shown on the scoreboard.
 func (p *Player) Kills() int {
-	return getInt(p.ResourceEntity(), "m_iKills."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "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.ResourceEntity(), "m_iDeaths."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "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.ResourceEntity(), "m_iAssists."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "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.ResourceEntity(), "m_iMVPs."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "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.ResourceEntity(), "m_iTotalCashSpent."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "m_iTotalCashSpent."+p.entityIDStr())
 }
 
 // MoneySpentThisRound returns the amount of money the player has spent in the current round.
 func (p *Player) MoneySpentThisRound() int {
-	return getInt(p.ResourceEntity(), "m_iCashSpentThisRound."+p.entityIDStr())
+	return getInt(p.resourceEntity(), "m_iCashSpentThisRound."+p.entityIDStr())
 }
 
 type demoInfoProvider interface {

pkg/demoinfocs/datatables.go

@@ -165,7 +165,7 @@ func (p *parser) bindPlayers() {
 	})
 
 	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(entity st.Entity) {
-		p.playerResourceEntity = entity
+		p.gameState.playerResourceEntity = entity
 	})
 }
 

pkg/demoinfocs/fake/game_state.go

@@ -94,3 +94,8 @@ func (gs *GameState) ConVars() map[string]string {
 func (gs *GameState) Rules() demoinfocs.GameRules {
 	return gs.Called().Get(0).(demoinfocs.GameRules)
 }
+
+// PlayerResorceEntity is a mock-implementation of GameState.PlayerResorceEntity().
+func (gs *GameState) PlayerResourceEntity() st.Entity {
+	return gs.Called().Get(0).(st.Entity)
+}

pkg/demoinfocs/game_state.go

@@ -16,26 +16,27 @@ import (
 
 // gameState contains all game-state relevant information.
 type gameState struct {
-	ingameTick         int
-	tState             common.TeamState
-	ctState            common.TeamState
-	playersByUserID    map[int]*common.Player            // Maps user-IDs to players
-	playersByEntityID  map[int]*common.Player            // Maps entity-IDs to players
-	grenadeProjectiles map[int]*common.GrenadeProjectile // Maps entity-IDs to active nade-projectiles. That's grenades that have been thrown, but have not yet detonated.
-	infernos           map[int]*common.Inferno           // Maps entity-IDs to active infernos.
-	weapons            map[int]*common.Equipment         // Maps entity IDs to weapons. Used to remember what a weapon is (p250 / cz etc.)
-	entities           map[int]st.Entity                 // Maps entity IDs to entities
-	bomb               common.Bomb
-	totalRoundsPlayed  int
-	gamePhase          common.GamePhase
-	isWarmupPeriod     bool
-	isMatchStarted     bool
-	lastFlash          lastFlash                              // Information about the last flash that exploded, used to find the attacker and projectile for player_blind events
-	currentDefuser     *common.Player                         // Player currently defusing the bomb, if any
-	currentPlanter     *common.Player                         // Player currently planting the bomb, if any
-	thrownGrenades     map[*common.Player][]*common.Equipment // Information about every player's thrown grenades (from the moment they are thrown to the moment their effect is ended)
-	rules              gameRules
-	demoInfo           demoInfoProvider
+	ingameTick           int
+	tState               common.TeamState
+	ctState              common.TeamState
+	playersByUserID      map[int]*common.Player            // Maps user-IDs to players
+	playersByEntityID    map[int]*common.Player            // Maps entity-IDs to players
+	playerResourceEntity st.Entity                         // CCSPlayerResource entity instance, contains scoreboard info and more
+	grenadeProjectiles   map[int]*common.GrenadeProjectile // Maps entity-IDs to active nade-projectiles. That's grenades that have been thrown, but have not yet detonated.
+	infernos             map[int]*common.Inferno           // Maps entity-IDs to active infernos.
+	weapons              map[int]*common.Equipment         // Maps entity IDs to weapons. Used to remember what a weapon is (p250 / cz etc.)
+	entities             map[int]st.Entity                 // Maps entity IDs to entities
+	bomb                 common.Bomb
+	totalRoundsPlayed    int
+	gamePhase            common.GamePhase
+	isWarmupPeriod       bool
+	isMatchStarted       bool
+	lastFlash            lastFlash                              // Information about the last flash that exploded, used to find the attacker and projectile for player_blind events
+	currentDefuser       *common.Player                         // Player currently defusing the bomb, if any
+	currentPlanter       *common.Player                         // Player currently planting the bomb, if any
+	thrownGrenades       map[*common.Player][]*common.Equipment // Information about every player's thrown grenades (from the moment they are thrown to the moment their effect is ended)
+	rules                gameRules
+	demoInfo             demoInfoProvider
 }
 
 type lastFlash struct {
@@ -157,6 +158,12 @@ func (gs *gameState) ConVars() map[string]string {
 	return gs.rules.ConVars()
 }
 
+// PlayerResourceEntity returns the game's CCSPlayerResource entity.
+// Contains scoreboard information and more.
+func (gs *gameState) PlayerResourceEntity() st.Entity {
+	return gs.playerResourceEntity
+}
+
 func newGameState(demoInfo demoInfoProvider) *gameState {
 	gs := &gameState{
 		playersByEntityID:  make(map[int]*common.Player),

pkg/demoinfocs/game_state_interface.go

@@ -60,4 +60,7 @@ type GameState interface {
 	// See also: https://developer.valvesoftware.com/wiki/List_of_CS:GO_Cvars.
 	// Deprecated: see GameRules().ConVars()
 	ConVars() map[string]string
+	// PlayerResourceEntity returns the game's CCSPlayerResource entity.
+	// Contains scoreboard information and more.
+	PlayerResourceEntity() st.Entity
 }

pkg/demoinfocs/parser.go

@@ -75,7 +75,6 @@ type parser struct {
 	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.Entity                                       // CCSPlayerResource entity instance, contains scoreboard info and more
 }
 
 // NetMessageCreator creates additional net-messages to be dispatched to net-message handlers.
@@ -362,5 +361,5 @@ func (p demoInfoProvider) FindPlayerByHandle(handle int) *common.Player {
 }
 
 func (p demoInfoProvider) PlayerResourceEntity() st.Entity {
-	return p.parser.playerResourceEntity
+	return p.parser.gameState.playerResourceEntity
 }