common: add Inferno.Owner() to retreive thrower (#131)

Author: markus-wa

common/common_test.go

@@ -6,6 +6,9 @@ import (
 
 	"github.com/golang/geo/r3"
 	"github.com/stretchr/testify/assert"
+
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
+	stfake "github.com/markus-wa/demoinfocs-golang/sendtables/fake"
 )
 
 func TestBombPosition(t *testing.T) {
@@ -75,3 +78,37 @@ func TestTeamState_FreezeTimeEndEquipmentValue(t *testing.T) {
 
 	assert.Equal(t, 300, state.FreezeTimeEndEquipmentValue())
 }
+
+type demoInfoProviderMock struct {
+	tickRate        float64
+	ingameTick      int
+	playersByHandle map[int]*Player
+}
+
+func (p demoInfoProviderMock) TickRate() float64 {
+	return p.tickRate
+}
+
+func (p demoInfoProviderMock) IngameTick() int {
+	return p.ingameTick
+}
+
+func (p demoInfoProviderMock) FindPlayerByHandle(handle int) *Player {
+	return p.playersByHandle[handle]
+}
+
+func mockDemoInfoProvider(tickRate float64, tick int) demoInfoProvider {
+	return demoInfoProviderMock{
+		tickRate:   tickRate,
+		ingameTick: tick,
+	}
+}
+
+func entityWithProperty(propName string, value st.PropertyValue) st.IEntity {
+	entity := new(stfake.Entity)
+	entity.On("ID").Return(1)
+	prop := new(stfake.Property)
+	prop.On("Value").Return(value)
+	entity.On("FindPropertyI", propName).Return(prop)
+	return entity
+}

common/inferno.go

@@ -4,21 +4,25 @@ import (
 	"math/rand"
 	"sort"
 
-	r2 "github.com/golang/geo/r2"
-	r3 "github.com/golang/geo/r3"
-	quickhull "github.com/markus-wa/quickhull-go"
+	"github.com/golang/geo/r2"
+	"github.com/golang/geo/r3"
+	"github.com/markus-wa/quickhull-go"
+
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
 // Inferno is a list of Fires with helper functions.
 // Also contains already extinguished fires.
 //
 // See also: Inferno.Active() and Fire.IsBurning
 type Inferno struct {
-	EntityID int
+	Entity   st.IEntity
+	EntityID int // Same as Entity.ID(), use Entity.ID() instead
 	Fires    []*Fire
 
 	// uniqueID is used to distinguish different infernos (which potentially have the same, reused entityID) from each other.
-	uniqueID int64
+	uniqueID         int64
+	demoInfoProvider demoInfoProvider
 }
 
 // Fire is a component of an Inferno.
@@ -133,13 +137,23 @@ func (inf Inferno) ConvexHull3D() quickhull.ConvexHull {
 	return convexHull(pointCloud)
 }
 
+// Owner returns the player who threw the fire grenade.
+func (inf Inferno) Owner() *Player {
+	return inf.demoInfoProvider.FindPlayerByHandle(inf.Entity.FindPropertyI("m_hOwnerEntity").Value().IntVal)
+}
+
 func convexHull(pointCloud []r3.Vector) quickhull.ConvexHull {
 	return new(quickhull.QuickHull).ConvexHull(pointCloud, false, false, 0)
 }
 
 // NewInferno creates a inferno and sets the Unique-ID.
 //
 // Intended for internal use only.
-func NewInferno() *Inferno {
-	return &Inferno{uniqueID: rand.Int63()}
+func NewInferno(demoInfoProvider demoInfoProvider, entity st.IEntity) *Inferno {
+	return &Inferno{
+		Entity:           entity,
+		EntityID:         entity.ID(),
+		uniqueID:         rand.Int63(),
+		demoInfoProvider: demoInfoProvider,
+	}
 }

common/inferno_test.go

@@ -3,16 +3,19 @@ package common
 import (
 	"testing"
 
-	r2 "github.com/golang/geo/r2"
-	r3 "github.com/golang/geo/r3"
-	assert "github.com/stretchr/testify/assert"
+	"github.com/golang/geo/r2"
+	"github.com/golang/geo/r3"
+	"github.com/stretchr/testify/assert"
+
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
-func TestInfernoUniqueID(t *testing.T) {
-	assert.NotEqual(t, NewInferno().UniqueID(), NewInferno().UniqueID(), "UniqueIDs of different infernos should be different")
+func TestInferno_UniqueID(t *testing.T) {
+	entity := new(st.Entity)
+	assert.NotEqual(t, NewInferno(nil, entity).UniqueID(), NewInferno(nil, entity).UniqueID(), "UniqueIDs of different infernos should be different")
 }
 
-func TestInfernoActive(t *testing.T) {
+func TestInferno_Active(t *testing.T) {
 	inf := Inferno{
 		Fires: []*Fire{
 			{
@@ -39,7 +42,7 @@ func TestInfernoActive(t *testing.T) {
 	assert.Equal(t, activeFires, inf.Active().Fires, "Active inferno should contain active fires")
 }
 
-func TestInfernoConvexHull2D(t *testing.T) {
+func TestInferno_ConvexHull2D(t *testing.T) {
 	// Construct a Inferno that looks roughly like this.
 	// D should be inside the 2D Convex Hull but a corner of the 3D Convex Hull
 	//
@@ -79,7 +82,7 @@ func TestInfernoConvexHull2D(t *testing.T) {
 }
 
 // Just check that all fires are passed to quickhull.ConvexHull()
-func TestInfernoConvexHull3D(t *testing.T) {
+func TestInferno_ConvexHull3D(t *testing.T) {
 	inf := Inferno{
 		Fires: []*Fire{
 			{
@@ -106,3 +109,14 @@ func TestInfernoConvexHull3D(t *testing.T) {
 
 	assert.ElementsMatch(t, expectedHull, inf.ConvexHull3D().Vertices, "ConvexHull3D should contain all fire locations")
 }
+
+func TestInferno_Owner(t *testing.T) {
+	entity := entityWithProperty("m_hOwnerEntity", st.PropertyValue{IntVal: 1})
+
+	player := new(Player)
+	provider := demoInfoProviderMock{
+		playersByHandle: map[int]*Player{1: player},
+	}
+
+	assert.Equal(t, player, NewInferno(provider, entity).Owner())
+}

common/player.go

@@ -188,6 +188,7 @@ type AdditionalPlayerInformation struct {
 type demoInfoProvider interface {
 	IngameTick() int   // current in-game tick, used for IsBlinded()
 	TickRate() float64 // in-game tick rate, used for Player.IsBlinded()
+	FindPlayerByHandle(handle int) *Player
 }
 
 // NewPlayer creates a *Player with an initialized equipment map.

common/player_test.go

@@ -6,8 +6,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/markus-wa/demoinfocs-golang/sendtables"
-	"github.com/markus-wa/demoinfocs-golang/sendtables/fake"
+	st "github.com/markus-wa/demoinfocs-golang/sendtables"
 )
 
 func TestPlayerActiveWeapon(t *testing.T) {
@@ -125,7 +124,7 @@ func TestPlayer_FlashDurationTimeRemaining_Fallback(t *testing.T) {
 }
 
 func TestPlayer_IsSpottedBy_HasSpotted_True(t *testing.T) {
-	pl := playerWithProperty("m_bSpottedByMask.000", sendtables.PropertyValue{IntVal: 2})
+	pl := playerWithProperty("m_bSpottedByMask.000", st.PropertyValue{IntVal: 2})
 	pl.EntityID = 1
 
 	other := newPlayer(0)
@@ -136,7 +135,7 @@ func TestPlayer_IsSpottedBy_HasSpotted_True(t *testing.T) {
 }
 
 func TestPlayer_IsSpottedBy_HasSpotted_False(t *testing.T) {
-	pl := playerWithProperty("m_bSpottedByMask.000", sendtables.PropertyValue{IntVal: 0})
+	pl := playerWithProperty("m_bSpottedByMask.000", st.PropertyValue{IntVal: 0})
 	pl.EntityID = 1
 
 	other := newPlayer(0)
@@ -147,7 +146,7 @@ func TestPlayer_IsSpottedBy_HasSpotted_False(t *testing.T) {
 }
 
 func TestPlayer_IsSpottedBy_HasSpotted_BitOver32(t *testing.T) {
-	pl := playerWithProperty("m_bSpottedByMask.001", sendtables.PropertyValue{IntVal: 1})
+	pl := playerWithProperty("m_bSpottedByMask.001", st.PropertyValue{IntVal: 1})
 	pl.EntityID = 1
 
 	other := newPlayer(0)
@@ -168,25 +167,25 @@ func TestPlayer_IsSpottedBy_EntityNull(t *testing.T) {
 }
 
 func TestPlayer_IsInBombZone(t *testing.T) {
-	pl := playerWithProperty("m_bInBombZone", sendtables.PropertyValue{IntVal: 1})
+	pl := playerWithProperty("m_bInBombZone", st.PropertyValue{IntVal: 1})
 
 	assert.True(t, pl.IsInBombZone())
 }
 
 func TestPlayer_IsInBuyZone(t *testing.T) {
-	pl := playerWithProperty("m_bInBuyZone", sendtables.PropertyValue{IntVal: 1})
+	pl := playerWithProperty("m_bInBuyZone", st.PropertyValue{IntVal: 1})
 
 	assert.True(t, pl.IsInBuyZone())
 }
 
 func TestPlayer_IsWalking(t *testing.T) {
-	pl := playerWithProperty("m_bIsWalking", sendtables.PropertyValue{IntVal: 1})
+	pl := playerWithProperty("m_bIsWalking", st.PropertyValue{IntVal: 1})
 
 	assert.True(t, pl.IsWalking())
 }
 
 func TestPlayer_IsScoped(t *testing.T) {
-	pl := playerWithProperty("m_bIsScoped", sendtables.PropertyValue{IntVal: 1})
+	pl := playerWithProperty("m_bIsScoped", st.PropertyValue{IntVal: 1})
 
 	assert.True(t, pl.IsScoped())
 }
@@ -195,31 +194,6 @@ func newPlayer(tick int) *Player {
 	return NewPlayer(mockDemoInfoProvider(128, tick))
 }
 
-type demoInfoProviderMock struct {
-	tickRate   float64
-	ingameTick int
-}
-
-func (p demoInfoProviderMock) TickRate() float64 {
-	return p.tickRate
-}
-
-func (p demoInfoProviderMock) IngameTick() int {
-	return p.ingameTick
-}
-
-func mockDemoInfoProvider(tickRate float64, tick int) demoInfoProvider {
-	return demoInfoProviderMock{
-		tickRate:   tickRate,
-		ingameTick: tick,
-	}
-}
-
-func playerWithProperty(propName string, value sendtables.PropertyValue) *Player {
-	entity := new(fake.Entity)
-	prop := new(fake.Property)
-	prop.On("Value").Return(value)
-	entity.On("FindPropertyI", propName).Return(prop)
-	pl := &Player{Entity: entity}
-	return pl
+func playerWithProperty(propName string, value st.PropertyValue) *Player {
+	return &Player{Entity: entityWithProperty(propName, value)}
 }

datatables.go

@@ -457,10 +457,8 @@ func (p *Parser) bindWeapon(entity *st.Entity, wepType common.EquipmentElement)
 }
 
 func (p *Parser) bindNewInferno(entity *st.Entity) {
-	entityID := entity.ID()
-	inf := common.NewInferno()
-	inf.EntityID = entityID
-	p.gameState.infernos[entityID] = inf
+	inf := common.NewInferno(p.demoInfoProvider, entity)
+	p.gameState.infernos[entity.ID()] = inf
 
 	entity.OnCreateFinished(func() {
 		p.eventDispatcher.Dispatch(events.InfernoStart{

events/events_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func TestPlayerFlashed_FlashDuration(t *testing.T) {
-	p := common.NewPlayer(demoInfoProvider{})
+	p := common.NewPlayer(demoInfoProviderMock{})
 	e := PlayerFlashed{Player: p}
 
 	assert.Equal(t, time.Duration(0), e.FlashDuration())
@@ -81,13 +81,17 @@ func TestItemPickup_WeaponTraceable_WeaponNotFound(t *testing.T) {
 	assert.Equal(t, e.Weapon, *e.WeaponTraceable())
 }
 
-type demoInfoProvider struct {
+type demoInfoProviderMock struct {
 }
 
-func (p demoInfoProvider) IngameTick() int {
+func (p demoInfoProviderMock) IngameTick() int {
 	return 0
 }
 
-func (p demoInfoProvider) TickRate() float64 {
+func (p demoInfoProviderMock) TickRate() float64 {
 	return 128
 }
+
+func (p demoInfoProviderMock) FindPlayerByHandle(handle int) *common.Player {
+	return nil
+}

parser.go

@@ -281,3 +281,7 @@ func (p demoInfoProvider) IngameTick() int {
 func (p demoInfoProvider) TickRate() float64 {
 	return p.parser.header.TickRate()
 }
+
+func (p demoInfoProvider) FindPlayerByHandle(handle int) *common.Player {
+	return p.parser.gameState.Participants().FindByHandle(handle)
+}