add Player bot utility functions (#164)

- Player.IsControllingBot()
- Player.ControlledBot()

Author: markus-wa

common/player.go

@@ -43,7 +43,7 @@ type Player struct {
 	FlashTick                   int        // In-game tick at which the player was last flashed
 	TeamState                   *TeamState // When keeping the reference make sure you notice when the player changes teams
 	Team                        Team
-	IsBot                       bool
+	IsBot                       bool // True if this is a bot-entity. See also IsControllingBot and ControlledBot().
 	IsConnected                 bool
 	IsDucking                   bool
 	IsDefusing                  bool
@@ -204,6 +204,28 @@ func (p *Player) CashSpentTotal() int {
 	return p.AdditionalPlayerInformation.TotalCashSpent
 }
 
+// IsControllingBot returns true if the player is currently controlling a bot.
+// See also ControlledBot().
+func (p *Player) IsControllingBot() bool {
+	if p.Entity == nil {
+		return false
+	}
+
+	return p.Entity.FindPropertyI("m_bIsControllingBot").Value().IntVal != 0
+}
+
+// ControlledBot returns the player instance of the bot that the player is controlling, if any.
+// Returns nil if the player is not controlling a bot.
+func (p *Player) ControlledBot() *Player {
+	if p.Entity == nil {
+		return nil
+	}
+
+	botHandle := p.Entity.FindPropertyI("m_iControlledBotEntIndex").Value().IntVal
+
+	return p.demoInfoProvider.FindPlayerByHandle(botHandle)
+}
+
 // AdditionalPlayerInformation contains mostly scoreboard information.
 type AdditionalPlayerInformation struct {
 	Kills              int

common/player_test.go

@@ -206,6 +206,50 @@ func TestPlayer_IsAirborne(t *testing.T) {
 	assert.True(t, pl.IsAirborne())
 }
 
+func TestPlayer_IsControllingBot_NilEntity(t *testing.T) {
+	pl := new(Player)
+
+	assert.False(t, pl.IsControllingBot())
+}
+
+func TestPlayer_IsControllingBot(t *testing.T) {
+	pl := playerWithProperty("m_bIsControllingBot", st.PropertyValue{IntVal: 0})
+
+	assert.False(t, pl.IsControllingBot())
+
+	pl = playerWithProperty("m_bIsControllingBot", st.PropertyValue{IntVal: 1})
+
+	assert.True(t, pl.IsControllingBot())
+}
+
+func TestPlayer_ControlledBot_NilEntity(t *testing.T) {
+	pl := new(Player)
+
+	assert.Nil(t, pl.ControlledBot())
+}
+
+func TestPlayer_ControlledBot(t *testing.T) {
+	dave := &Player{
+		Name:  "Dave",
+		IsBot: true,
+	}
+	demoInfoProvider := &demoInfoProviderMock{
+		playersByHandle: map[int]*Player{
+			12: dave,
+		},
+	}
+
+	pl := playerWithProperty("m_iControlledBotEntIndex", st.PropertyValue{IntVal: 0})
+	pl.demoInfoProvider = demoInfoProvider
+
+	assert.Nil(t, pl.ControlledBot())
+
+	pl = playerWithProperty("m_iControlledBotEntIndex", st.PropertyValue{IntVal: 12})
+	pl.demoInfoProvider = demoInfoProvider
+
+	assert.Same(t, dave, pl.ControlledBot())
+}
+
 func newPlayer(tick int) *Player {
 	return NewPlayer(mockDemoInfoProvider(128, tick))
 }