make PlayerInfo public (#343)

Author: markus-wa

pkg/demoinfocs/common/player.go

@@ -208,7 +208,7 @@ func (p *Player) IsUnDuckingInProgress() bool {
 	return p.Flags().Ducking() && !p.Flags().DuckingKeyPressed()
 }
 
-// IsStaning returns true if the player is currently fully standing upright.
+// IsStanding returns true if the player is currently fully standing upright.
 // See also: Flags().Ducking() & Flags().DuckingKeyPressed()
 func (p *Player) IsStanding() bool {
 	return !p.Flags().Ducking() && !p.Flags().DuckingKeyPressed()
@@ -469,3 +469,26 @@ func NewPlayer(demoInfoProvider demoInfoProvider) *Player {
 		demoInfoProvider: demoInfoProvider,
 	}
 }
+
+// PlayerInfo contains information about a player such as their name and SteamID.
+// Primarily intended for internal use.
+type PlayerInfo struct {
+	Version     int64
+	XUID        uint64 // SteamID64
+	Name        string
+	UserID      int
+	GUID        string
+	FriendsID   int
+	FriendsName string
+	// Custom files stuff (CRC)
+	CustomFiles0 int
+	CustomFiles1 int
+	CustomFiles2 int
+	CustomFiles3 int
+	// Amount of downloaded files from the server
+	FilesDownloaded byte
+	// Bots
+	IsFakePlayer bool
+	// HLTV Proxy
+	IsHltv bool
+}

pkg/demoinfocs/datatables.go

@@ -170,21 +170,21 @@ func (p *parser) bindPlayers() {
 	})
 }
 
-func (p *parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, player *common.Player) {
+func (p *parser) getOrCreatePlayer(entityID int, rp *common.PlayerInfo) (isNew bool, player *common.Player) {
 	player = p.gameState.playersByEntityID[entityID]
 
 	if player == nil {
 		if rp != nil {
-			player = p.gameState.playersByUserID[rp.userID]
+			player = p.gameState.playersByUserID[rp.UserID]
 
 			if player == nil {
 				isNew = true
 
 				player = common.NewPlayer(p.demoInfoProvider)
-				player.Name = rp.name
-				player.SteamID64 = rp.xuid
-				player.IsBot = rp.isFakePlayer || rp.guid == "BOT"
-				player.UserID = rp.userID
+				player.Name = rp.Name
+				player.SteamID64 = rp.XUID
+				player.IsBot = rp.IsFakePlayer || rp.GUID == "BOT"
+				player.UserID = rp.UserID
 
 				p.gameState.indexPlayerBySteamID(player)
 			}
@@ -202,7 +202,7 @@ func (p *parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, pl
 	p.gameState.playersByEntityID[entityID] = player
 
 	if rp != nil {
-		p.gameState.playersByUserID[rp.userID] = player
+		p.gameState.playersByUserID[rp.UserID] = player
 	}
 
 	return isNew, player

pkg/demoinfocs/datatables_test.go

@@ -22,16 +22,16 @@ func (DevNullReader) Read(p []byte) (n int, err error) {
 func TestParser_BindNewPlayer_Issue98(t *testing.T) {
 	p := newParser()
 
-	p.rawPlayers = map[int]*playerInfo{
+	p.rawPlayers = map[int]*common.PlayerInfo{
 		0: {
-			userID: 1,
-			name:   "Zim",
-			guid:   "BOT",
+			UserID: 1,
+			Name:   "Zim",
+			GUID:   "BOT",
 		},
 		1: {
-			userID: 2,
-			name:   "The Suspect",
-			guid:   "123",
+			UserID: 2,
+			Name:   "The Suspect",
+			GUID:   "123",
 		},
 	}
 
@@ -48,12 +48,12 @@ func TestParser_BindNewPlayer_Issue98(t *testing.T) {
 func TestParser_BindNewPlayer_Issue98_Reconnect(t *testing.T) {
 	p := newParser()
 
-	p.rawPlayers = map[int]*playerInfo{
+	p.rawPlayers = map[int]*common.PlayerInfo{
 		0: {
-			userID: 2,
-			name:   "The Suspect",
-			guid:   "123",
-			xuid:   1,
+			UserID: 2,
+			Name:   "The Suspect",
+			GUID:   "123",
+			XUID:   1,
 		},
 	}
 
@@ -80,12 +80,12 @@ func TestParser_BindNewPlayer_PlayerSpotted_Over32(t *testing.T) {
 func testPlayerSpotted(t *testing.T, propName string) {
 	p := newParser()
 
-	p.rawPlayers = map[int]*playerInfo{
+	p.rawPlayers = map[int]*common.PlayerInfo{
 		0: {
-			userID: 2,
-			name:   "Spotter",
-			guid:   "123",
-			xuid:   1,
+			UserID: 2,
+			Name:   "Spotter",
+			GUID:   "123",
+			XUID:   1,
 		},
 	}
 

pkg/demoinfocs/debug_on.go

@@ -1,4 +1,5 @@
-//+build debugdemoinfocs
+//go:build debugdemoinfocs
+// +build debugdemoinfocs
 
 // Functions to print out debug information if the build tag is enabled
 

pkg/demoinfocs/events/events.go

@@ -418,13 +418,18 @@ type PlayerDisconnected struct {
 	Player *common.Player
 }
 
-// PlayerNameChange signals that a player's name has changed
+// PlayerNameChange signals that a player's name has changed.
 type PlayerNameChange struct {
 	Player  *common.Player
 	OldName string
 	NewName string
 }
 
+// StringTablePlayerUpdateApplied signals that a player has been updated via stringtables.
+type StringTablePlayerUpdateApplied struct {
+	Player *common.Player
+}
+
 // SayText signals a chat message. It contains the raw
 // network message data for admin / console messages.
 // EntIdx will probably always be 0
@@ -616,3 +621,9 @@ type ConVarsUpdated struct {
 type RoundImpactScoreData struct {
 	RawMessage *msg.CCSUsrMsg_RoundImpactScoreData
 }
+
+// PlayerInfo signals that basic player information was read via stringtables.
+type PlayerInfo struct {
+	Index int
+	Info  common.PlayerInfo
+}

pkg/demoinfocs/game_events.go

@@ -517,29 +517,29 @@ func (geh gameEventHandler) HostageRescuedAll(map[string]*msg.CSVCMsg_GameEventK
 }
 
 func (geh gameEventHandler) playerConnect(data map[string]*msg.CSVCMsg_GameEventKeyT) {
-	pl := &playerInfo{
-		userID: int(data["userid"].GetValShort()),
-		name:   data["name"].GetValString(),
-		guid:   data["networkid"].GetValString(),
+	pl := common.PlayerInfo{
+		UserID: int(data["userid"].GetValShort()),
+		Name:   data["name"].GetValString(),
+		GUID:   data["networkid"].GetValString(),
 	}
 
-	if pl.guid != "" {
+	if pl.GUID != "" {
 		var err error
-		pl.xuid, err = guidToSteamID64(pl.guid)
+		pl.XUID, err = guidToSteamID64(pl.GUID)
 
 		if err != nil {
 			geh.parser.setError(fmt.Errorf("failed to parse player XUID: %v", err.Error()))
 		}
 	}
 
-	geh.parser.rawPlayers[int(data["index"].GetValByte())] = pl
+	geh.parser.setRawPlayer(int(data["index"].GetValByte()), pl)
 }
 
 func (geh gameEventHandler) playerDisconnect(data map[string]*msg.CSVCMsg_GameEventKeyT) {
 	uid := int(data["userid"].GetValShort())
 
 	for k, v := range geh.parser.rawPlayers {
-		if v.userID == uid {
+		if v.UserID == uid {
 			delete(geh.parser.rawPlayers, k)
 		}
 	}

pkg/demoinfocs/msg/cstrike15_usermessages.pb.go

@@ -70,7 +70,7 @@ type parser struct {
 	bombsiteA            bombsite
 	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
+	rawPlayers           map[int]*common.PlayerInfo                      // Maps entity IDs to 'raw' player 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
@@ -338,7 +338,7 @@ func NewParserWithConfig(demostream io.Reader, config ParserConfig) Parser {
 	p.bitReader = bit.NewLargeBitReader(demostream)
 	p.stParser = st.NewSendTableParser()
 	p.equipmentMapping = make(map[*st.ServerClass]common.EquipmentType)
-	p.rawPlayers = make(map[int]*playerInfo)
+	p.rawPlayers = make(map[int]*common.PlayerInfo)
 	p.triggers = make(map[int]*boundingBoxInformation)
 	p.demoInfoProvider = demoInfoProvider{parser: &p}
 	p.gameState = newGameState(p.demoInfoProvider)

pkg/demoinfocs/parser.go

@@ -324,6 +324,11 @@ func (pe *property) Type() PropertyType {
 	return PropertyType(pe.entry.prop.rawType)
 }
 
+// ArrayElementType returns the data type of array entries, if Property.Type() is PropTypeArray.
+func (pe *property) ArrayElementType() PropertyType {
+	return PropertyType(pe.entry.arrayElementProp.rawType)
+}
+
 // PropertyValueType specifies the type of a PropertyValue
 type PropertyValueType int
 

pkg/demoinfocs/sendtables/entity.go

@@ -37,3 +37,8 @@ func (p *Property) OnUpdate(handler st.PropertyUpdateHandler) {
 func (p *Property) Bind(variable interface{}, valueType st.PropertyValueType) {
 	p.Called(variable, valueType)
 }
+
+// ArrayElementType is a mock-implementation of Property.ArrayElementType().
+func (p *Property) ArrayElementType() st.PropertyType {
+	return p.Called().Get(0).(st.PropertyType)
+}