common: add functions to check if players are spotted (#114)

Author: markus-wa

common/player.go

@@ -3,7 +3,7 @@ package common
 import (
 	"time"
 
-	r3 "github.com/golang/geo/r3"
+	"github.com/golang/geo/r3"
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
@@ -114,6 +114,30 @@ func (p *Player) Weapons() []*Equipment {
 	return res
 }
 
+// IsSpottedBy returns true if the player has been spotted by the other player.
+func (p *Player) IsSpottedBy(other *Player) bool {
+	if p.Entity == nil {
+		return false
+	}
+
+	// TODO extract ClientSlot() function
+	clientSlot := other.EntityID - 1
+	bit := uint(clientSlot)
+	var mask st.IProperty
+	if bit < 32 {
+		mask = p.Entity.FindPropertyI("m_bSpottedByMask.000")
+	} else {
+		bit -= 32
+		mask = p.Entity.FindPropertyI("m_bSpottedByMask.001")
+	}
+	return (mask.Value().IntVal & (1 << bit)) != 0
+}
+
+// HasSpotted returns true if the player has spotted the other player.
+func (p *Player) HasSpotted(other *Player) bool {
+	return other.IsSpottedBy(p)
+}
+
 // AdditionalPlayerInformation contains mostly scoreboard information.
 type AdditionalPlayerInformation struct {
 	Kills          int

common/player_test.go

@@ -4,7 +4,10 @@ import (
 	"testing"
 	"time"
 
-	assert "github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/assert"
+
+	"github.com/markus-wa/demoinfocs-golang/sendtables"
+	"github.com/markus-wa/demoinfocs-golang/sendtables/fake"
 )
 
 func TestPlayerActiveWeapon(t *testing.T) {
@@ -121,6 +124,64 @@ func TestPlayer_FlashDurationTimeRemaining_Fallback(t *testing.T) {
 	assert.Equal(t, 2*time.Second, pl.FlashDurationTimeRemaining())
 }
 
+func TestPlayer_IsSpottedBy_HasSpotted_True(t *testing.T) {
+	pl := newPlayer(0)
+	entity := new(fake.Entity)
+	pl.Entity = entity
+	pl.EntityID = 1
+	prop := new(fake.Property)
+	prop.On("Value").Return(sendtables.PropertyValue{IntVal: 2})
+	entity.On("FindPropertyI", "m_bSpottedByMask.000").Return(prop)
+
+	other := newPlayer(0)
+	other.EntityID = 2
+
+	assert.True(t, pl.IsSpottedBy(other))
+	assert.True(t, other.HasSpotted(pl))
+}
+
+func TestPlayer_IsSpottedBy_HasSpotted_False(t *testing.T) {
+	pl := newPlayer(0)
+	entity := new(fake.Entity)
+	pl.Entity = entity
+	pl.EntityID = 1
+	prop := new(fake.Property)
+	prop.On("Value").Return(sendtables.PropertyValue{IntVal: 0})
+	entity.On("FindPropertyI", "m_bSpottedByMask.000").Return(prop)
+
+	other := newPlayer(0)
+	other.EntityID = 2
+
+	assert.False(t, pl.IsSpottedBy(other))
+	assert.False(t, other.HasSpotted(pl))
+}
+
+func TestPlayer_IsSpottedBy_HasSpotted_BitOver32(t *testing.T) {
+	pl := newPlayer(0)
+	entity := new(fake.Entity)
+	prop := new(fake.Property)
+	prop.On("Value").Return(sendtables.PropertyValue{IntVal: 1})
+	entity.On("FindPropertyI", "m_bSpottedByMask.001").Return(prop)
+	pl.Entity = entity
+	pl.EntityID = 1
+
+	other := newPlayer(0)
+	other.EntityID = 33
+
+	assert.True(t, pl.IsSpottedBy(other))
+	assert.True(t, other.HasSpotted(pl))
+}
+
+func TestPlayer_IsSpottedBy_EntityNull(t *testing.T) {
+	pl := new(Player)
+	pl.EntityID = 1
+	other := new(Player)
+	other.EntityID = 2
+
+	assert.False(t, pl.IsSpottedBy(other))
+	assert.False(t, other.HasSpotted(pl))
+}
+
 func newPlayer(tick int) *Player {
 	return NewPlayer(128, tickProvider(tick))
 }

datatables.go

@@ -4,10 +4,10 @@ import (
 	"fmt"
 	"strings"
 
-	r3 "github.com/golang/geo/r3"
+	"github.com/golang/geo/r3"
 
-	common "github.com/markus-wa/demoinfocs-golang/common"
-	events "github.com/markus-wa/demoinfocs-golang/events"
+	"github.com/markus-wa/demoinfocs-golang/common"
+	"github.com/markus-wa/demoinfocs-golang/events"
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
@@ -220,7 +220,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 	})
 
 	// General info
-	playerEntity.FindProperty("m_iTeamNum").OnUpdate(func(val st.PropertyValue) {
+	playerEntity.FindPropertyI("m_iTeamNum").OnUpdate(func(val st.PropertyValue) {
 		pl.Team = common.Team(val.IntVal) // Need to cast to team so we can't use BindProperty
 		pl.TeamState = p.gameState.Team(pl.Team)
 	})
@@ -233,7 +233,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 
 	playerEntity.BindProperty("m_angEyeAngles[1]", &pl.ViewDirectionX, st.ValTypeFloat32)
 	playerEntity.BindProperty("m_angEyeAngles[0]", &pl.ViewDirectionY, st.ValTypeFloat32)
-	playerEntity.FindProperty("m_flFlashDuration").OnUpdate(func(val st.PropertyValue) {
+	playerEntity.FindPropertyI("m_flFlashDuration").OnUpdate(func(val st.PropertyValue) {
 		if val.FloatVal == 0 {
 			pl.FlashTick = 0
 		} else {
@@ -254,7 +254,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 
 	// Some demos have an additional prefix for player weapons weapon
 	var wepPrefix string
-	if playerEntity.FindProperty(playerWeaponPrefix+"000") != nil {
+	if playerEntity.FindPropertyI(playerWeaponPrefix+"000") != nil {
 		wepPrefix = playerWeaponPrefix
 	} else {
 		wepPrefix = playerWeaponPrePrefix + playerWeaponPrefix
@@ -264,7 +264,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 	var cache [maxWeapons]int
 	for i := range cache {
 		i2 := i // Copy for passing to handler
-		playerEntity.FindProperty(wepPrefix + fmt.Sprintf("%03d", i)).OnUpdate(func(val st.PropertyValue) {
+		playerEntity.FindPropertyI(wepPrefix + fmt.Sprintf("%03d", i)).OnUpdate(func(val st.PropertyValue) {
 			entityID := val.IntVal & entityHandleIndexMask
 			if entityID != entityHandleIndexMask {
 				if cache[i2] != 0 {
@@ -289,7 +289,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 	}
 
 	// Active weapon
-	playerEntity.FindProperty("m_hActiveWeapon").OnUpdate(func(val st.PropertyValue) {
+	playerEntity.FindPropertyI("m_hActiveWeapon").OnUpdate(func(val st.PropertyValue) {
 		pl.ActiveWeaponID = val.IntVal & entityHandleIndexMask
 	})
 
@@ -298,7 +298,7 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 		playerEntity.BindProperty("m_iAmmo."+fmt.Sprintf("%03d", i2), &pl.AmmoLeft[i2], st.ValTypeInt)
 	}
 
-	playerEntity.FindProperty("m_bIsDefusing").OnUpdate(func(val st.PropertyValue) {
+	playerEntity.FindPropertyI("m_bIsDefusing").OnUpdate(func(val st.PropertyValue) {
 		if p.gameState.currentDefuser == pl && pl.IsDefusing && val.IntVal == 0 {
 			p.eventDispatcher.Dispatch(events.BombDefuseAborted{Player: pl})
 			p.gameState.currentDefuser = nil

datatables_test.go

@@ -84,7 +84,7 @@ func fakePlayerEntity(id int) st.IEntity {
 		destroyCallback = args.Get(0).(func())
 	})
 	entity.On("OnPositionUpdate", mock.Anything).Return()
-	entity.On("FindProperty", mock.Anything).Return(new(st.Property))
+	entity.On("FindPropertyI", mock.Anything).Return(new(st.Property))
 	entity.On("BindProperty", mock.Anything, mock.Anything, mock.Anything).Return(new(st.Property))
 	entity.On("Destroy").Run(func(mock.Arguments) {
 		destroyCallback()

fake/game_state.go

@@ -8,6 +8,8 @@ import (
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
+var _ dem.IGameState = new(GameState)
+
 // GameState is a mock for of demoinfocs.IGameState.
 type GameState struct {
 	mock.Mock
@@ -28,6 +30,11 @@ func (gs *GameState) TeamTerrorists() *common.TeamState {
 	return gs.Called().Get(0).(*common.TeamState)
 }
 
+// Team is a mock-implementation of IGameState.Team().
+func (gs *GameState) Team(team common.Team) *common.TeamState {
+	return gs.Called().Get(0).(*common.TeamState)
+}
+
 // Participants is a mock-implementation of IGameState.Participants().
 func (gs *GameState) Participants() dem.IParticipants {
 	return gs.Called().Get(0).(dem.IParticipants)

fake/parser.go

@@ -13,6 +13,8 @@ import (
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
+var _ dem.IParser = new(Parser)
+
 // Parser is a mock for of demoinfocs.IParser.
 type Parser struct {
 	mock.Mock

fake/participants.go

@@ -1,11 +1,14 @@
 package fake
 
 import (
-	mock "github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/mock"
 
-	common "github.com/markus-wa/demoinfocs-golang/common"
+	dem "github.com/markus-wa/demoinfocs-golang"
+	"github.com/markus-wa/demoinfocs-golang/common"
 )
 
+var _ dem.IParticipants = new(Participants)
+
 // Participants is a mock for of demoinfocs.IParticipants.
 type Participants struct {
 	mock.Mock
@@ -45,3 +48,13 @@ func (ptcp *Participants) TeamMembers(team common.Team) []*common.Player {
 func (ptcp *Participants) FindByHandle(handle int) *common.Player {
 	return ptcp.Called().Get(0).(*common.Player)
 }
+
+// SpottersOf is a mock-implementation of IParticipants.SpottersOf().
+func (ptcp *Participants) SpottersOf(spotted *common.Player) []*common.Player {
+	return ptcp.Called().Get(0).([]*common.Player)
+}
+
+// SpottedBy is a mock-implementation of IParticipants.SpottedBy().
+func (ptcp *Participants) SpottedBy(spotter *common.Player) []*common.Player {
+	return ptcp.Called().Get(0).([]*common.Player)
+}

game_events.go

@@ -4,11 +4,11 @@ import (
 	"fmt"
 	"strconv"
 
-	r3 "github.com/golang/geo/r3"
+	"github.com/golang/geo/r3"
 
-	common "github.com/markus-wa/demoinfocs-golang/common"
-	events "github.com/markus-wa/demoinfocs-golang/events"
-	msg "github.com/markus-wa/demoinfocs-golang/msg"
+	"github.com/markus-wa/demoinfocs-golang/common"
+	"github.com/markus-wa/demoinfocs-golang/events"
+	"github.com/markus-wa/demoinfocs-golang/msg"
 )
 
 func (p *Parser) handleGameEventList(gel *msg.CSVCMsg_GameEventList) {

game_state.go

@@ -228,3 +228,23 @@ func (ptcp Participants) initalizeSliceFromByUserID() ([]*common.Player, map[int
 	byUserID := ptcp.ByUserID()
 	return make([]*common.Player, 0, len(byUserID)), byUserID
 }
+
+// SpottersOf returns a list of all players who have spotted the passed player.
+func (ptcp Participants) SpottersOf(spotted *common.Player) (spotters []*common.Player) {
+	for _, other := range ptcp.playersByUserID {
+		if spotted.IsSpottedBy(other) {
+			spotters = append(spotters, other)
+		}
+	}
+	return
+}
+
+// SpottedBy returns a list of all players that the passed player has spotted.
+func (ptcp Participants) SpottedBy(spotter *common.Player) (spotted []*common.Player) {
+	for _, other := range ptcp.playersByUserID {
+		if other.Entity != nil && other.IsSpottedBy(spotter) {
+			spotted = append(spotted, other)
+		}
+	}
+	return
+}

game_state_test.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/markus-wa/demoinfocs-golang/common"
 	st "github.com/markus-wa/demoinfocs-golang/sendtables"
+	"github.com/markus-wa/demoinfocs-golang/sendtables/fake"
 )
 
 func TestNewGameState(t *testing.T) {
@@ -180,6 +181,78 @@ func TestParticipants_Connected_SuppressNotConnected(t *testing.T) {
 	assert.ElementsMatch(t, []*common.Player{pl}, allPlayers)
 }
 
+func TestParticipants_SpottersOf(t *testing.T) {
+	spotter1 := newPlayer()
+	spotter1.EntityID = 1
+	spotter2 := newPlayer()
+	spotter2.EntityID = 35
+	nonSpotter := newPlayer()
+	nonSpotter.EntityID = 5
+
+	spotted := newPlayer()
+	entity := new(fake.Entity)
+	prop0 := new(fake.Property)
+	prop0.On("Value").Return(st.PropertyValue{IntVal: 1})
+	entity.On("FindPropertyI", "m_bSpottedByMask.000").Return(prop0)
+	prop1 := new(fake.Property)
+	prop1.On("Value").Return(st.PropertyValue{IntVal: 1 << 2})
+	entity.On("FindPropertyI", "m_bSpottedByMask.001").Return(prop1)
+	spotted.Entity = entity
+	spotted.EntityID = 3
+
+	ptcps := Participants{
+		playersByUserID: map[int]*common.Player{
+			0: spotted,
+			1: spotter1,
+			2: spotter2,
+			3: nonSpotter,
+		},
+	}
+
+	spotters := ptcps.SpottersOf(spotted)
+
+	assert.ElementsMatch(t, []*common.Player{spotter1, spotter2}, spotters)
+}
+
+func TestParticipants_SpottedBy(t *testing.T) {
+	spotted1 := newPlayer()
+	spotted1.EntityID = 1
+	spotted2 := newPlayer()
+	spotted2.EntityID = 35
+
+	entity := new(fake.Entity)
+	prop0 := new(fake.Property)
+	prop0.On("Value").Return(st.PropertyValue{IntVal: 1})
+	entity.On("FindPropertyI", "m_bSpottedByMask.000").Return(prop0)
+	spotted1.Entity = entity
+	spotted2.Entity = entity
+
+	unSpotted := newPlayer()
+	unSpotted.EntityID = 5
+	spotter := newPlayer()
+	spotter.EntityID = 1
+
+	unSpottedEntity := new(fake.Entity)
+	unSpottedProp := new(fake.Property)
+	unSpottedProp.On("Value").Return(st.PropertyValue{IntVal: 0})
+	unSpottedEntity.On("FindPropertyI", "m_bSpottedByMask.000").Return(unSpottedProp)
+	unSpotted.Entity = unSpottedEntity
+	spotter.Entity = unSpottedEntity
+
+	ptcps := Participants{
+		playersByUserID: map[int]*common.Player{
+			0: spotter,
+			1: spotted1,
+			2: spotted2,
+			3: unSpotted,
+		},
+	}
+
+	spotted := ptcps.SpottedBy(spotter)
+
+	assert.ElementsMatch(t, []*common.Player{spotted1, spotted2}, spotted)
+}
+
 func newPlayer() *common.Player {
 	pl := common.NewPlayer(0, func() int { return 0 })
 	pl.Entity = new(st.Entity)