events: add PlayerSpottersChanged event (#114)

Author: markus-wa

datatables.go

@@ -306,6 +306,15 @@ func (p *Parser) bindNewPlayer(playerEntity st.IEntity) {
 		pl.IsDefusing = val.IntVal != 0
 	})
 
+	spottedByMaskProp := playerEntity.FindPropertyI("m_bSpottedByMask.000")
+	if spottedByMaskProp != nil {
+		spottersChanged := func(val st.PropertyValue) {
+			p.eventDispatcher.Dispatch(events.PlayerSpottersChanged{Spotted: pl})
+		}
+		spottedByMaskProp.OnUpdate(spottersChanged)
+		playerEntity.FindPropertyI("m_bSpottedByMask.001").OnUpdate(spottersChanged)
+	}
+
 	if isNew && pl.SteamID != 0 {
 		p.eventDispatcher.Dispatch(events.PlayerConnect{Player: pl})
 	}

datatables_test.go

@@ -67,7 +67,50 @@ func TestParser_BindNewPlayer_Issue98_Reconnect(t *testing.T) {
 	p.bindNewPlayer(player)
 
 	assert.Len(t, p.GameState().Participants().All(), 1)
+}
+
+func TestParser_BindNewPlayer_PlayerSpotted_Under32(t *testing.T) {
+	testPlayerSpotted(t, "m_bSpottedByMask.000")
+}
+func TestParser_BindNewPlayer_PlayerSpotted_Over32(t *testing.T) {
+	testPlayerSpotted(t, "m_bSpottedByMask.001")
+}
+
+func testPlayerSpotted(t *testing.T, propName string) {
+	p := newParser()
+
+	p.rawPlayers = map[int]*playerInfo{
+		0: {
+			userID: 2,
+			name:   "Spotter",
+			guid:   "123",
+			xuid:   1,
+		},
+	}
+
+	// TODO: Player interface so we don't have to mock all this
+	spotted := new(fakest.Entity)
+	spottedByProp0 := new(fakest.Property)
+	var spottedByUpdateHandler st.PropertyUpdateHandler
+	spottedByProp0.On("OnUpdate", mock.Anything).Run(func(args mock.Arguments) {
+		spottedByUpdateHandler = args.Get(0).(st.PropertyUpdateHandler)
+	})
+	spotted.On("FindPropertyI", propName).Return(spottedByProp0)
+	configurePlayerEntityMock(1, spotted)
+	p.bindNewPlayer(spotted)
+
+	var actual events.PlayerSpottersChanged
+	p.RegisterEventHandler(func(e events.PlayerSpottersChanged) {
+		actual = e
+	})
 
+	spottedByUpdateHandler(st.PropertyValue{IntVal: 1})
+
+	expected := events.PlayerSpottersChanged{
+		Spotted: p.gameState.playersByEntityID[1],
+	}
+	assert.NotNil(t, expected.Spotted)
+	assert.Equal(t, expected, actual)
 }
 
 func newParser() *Parser {
@@ -76,18 +119,22 @@ func newParser() *Parser {
 	return p
 }
 
-func fakePlayerEntity(id int) st.IEntity {
+func fakePlayerEntity(id int) *fakest.Entity {
 	entity := new(fakest.Entity)
+	configurePlayerEntityMock(id, entity)
+	return entity
+}
+
+func configurePlayerEntityMock(id int, entity *fakest.Entity) {
 	entity.On("ID").Return(id)
 	var destroyCallback func()
 	entity.On("OnDestroy", mock.Anything).Run(func(args mock.Arguments) {
 		destroyCallback = args.Get(0).(func())
 	})
 	entity.On("OnPositionUpdate", mock.Anything).Return()
 	entity.On("FindPropertyI", mock.Anything).Return(new(st.Property))
-	entity.On("BindProperty", mock.Anything, mock.Anything, mock.Anything).Return(new(st.Property))
+	entity.On("BindProperty", mock.Anything, mock.Anything, mock.Anything)
 	entity.On("Destroy").Run(func(mock.Arguments) {
 		destroyCallback()
 	})
-	return entity
 }

events/events.go

@@ -501,3 +501,8 @@ type IsWarmupPeriodChanged struct {
 	OldIsWarmupPeriod bool
 	NewIsWarmupPeriod bool
 }
+
+// PlayerSpottersChanged signals that a player's spotters (other players that can se him) changed.
+type PlayerSpottersChanged struct {
+	Spotted *common.Player
+}

sendtables/fake/property.go

@@ -25,10 +25,10 @@ func (p *Property) Value() st.PropertyValue {
 
 // OnUpdate is a mock-implementation of IProperty.OnUpdate().
 func (p *Property) OnUpdate(handler st.PropertyUpdateHandler) {
-	p.Called()
+	p.Called(handler)
 }
 
 // Bind is a mock-implementation of IProperty.Bind().
 func (p *Property) Bind(variable interface{}, valueType st.PropertyValueType) {
-	p.Called()
+	p.Called(variable, valueType)
 }