sendtables: make structs private, only expose interfaces

Author: markus-wa

examples/entities/entities.go

@@ -20,7 +20,7 @@ func main() {
 	p := demoinfocs.NewParser(f)
 
 	p.RegisterEventHandler(func(events.DataTablesParsed) {
-		p.ServerClasses().FindByName("CWeaponAWP").OnEntityCreated(func(ent *st.Entity) {
+		p.ServerClasses().FindByName("CWeaponAWP").OnEntityCreated(func(ent st.Entity) {
 			ent.Property("m_hOwnerEntity").OnUpdate(func(val st.PropertyValue) {
 				x := p.GameState().Participants().FindByHandle(val.IntVal)
 				if x != nil {

pkg/demoinfocs/common/common.go

@@ -62,7 +62,7 @@ func (h DemoHeader) FrameTime() time.Duration {
 // GrenadeProjectile is a grenade thrown intentionally by a player. It is used to track grenade projectile
 // positions between the time at which they are thrown and until they detonate.
 type GrenadeProjectile struct {
-	Entity         st.IEntity
+	Entity         st.Entity
 	WeaponInstance *Equipment
 	Thrower        *Player     // Always seems to be the same as Owner, even if the grenade was picked up
 	Owner          *Player     // Always seems to be the same as Thrower, even if the grenade was picked up
@@ -115,7 +115,7 @@ type TeamState struct {
 	team            Team
 	membersCallback func(Team) []*Player
 
-	Entity st.IEntity
+	Entity st.Entity
 
 	// Terrorist TeamState for CTs, CT TeamState for Terrorists
 	Opponent *TeamState

pkg/demoinfocs/common/common_test.go

@@ -117,7 +117,7 @@ type demoInfoProviderMock struct {
 	tickRate             float64
 	ingameTick           int
 	playersByHandle      map[int]*Player
-	playerResourceEntity st.IEntity
+	playerResourceEntity st.Entity
 }
 
 func (p demoInfoProviderMock) TickRate() float64 {
@@ -132,7 +132,7 @@ func (p demoInfoProviderMock) FindPlayerByHandle(handle int) *Player {
 	return p.playersByHandle[handle]
 }
 
-func (p demoInfoProviderMock) PlayerResourceEntity() st.IEntity {
+func (p demoInfoProviderMock) PlayerResourceEntity() st.Entity {
 	return p.playerResourceEntity
 }
 

pkg/demoinfocs/common/entity_util.go

@@ -2,31 +2,31 @@ package common
 
 import st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 
-func getInt(entity st.IEntity, propName string) int {
+func getInt(entity st.Entity, propName string) int {
 	if entity == nil {
 		return 0
 	}
 
 	return entity.PropertyValueMust(propName).IntVal
 }
 
-func getFloat(entity st.IEntity, propName string) float32 {
+func getFloat(entity st.Entity, propName string) float32 {
 	if entity == nil {
 		return 0
 	}
 
 	return entity.PropertyValueMust(propName).FloatVal
 }
 
-func getString(entity st.IEntity, propName string) string {
+func getString(entity st.Entity, propName string) string {
 	if entity == nil {
 		return ""
 	}
 
 	return entity.PropertyValueMust(propName).StringVal
 }
 
-func getBool(entity st.IEntity, propName string) bool {
+func getBool(entity st.Entity, propName string) bool {
 	if entity == nil {
 		return false
 	}

pkg/demoinfocs/common/equipment.go

@@ -285,7 +285,7 @@ const (
 // This also includes the skin and some additional data.
 type Equipment struct {
 	Type           EquipmentType // The type of weapon which the equipment instantiates.
-	Entity         st.IEntity    // The game entity instance
+	Entity         st.Entity    // The game entity instance
 	Owner          *Player       // The player carrying the equipment, not necessarily the buyer.
 	OriginalString string        // E.g. 'models/weapons/w_rif_m4a1_s.mdl'. Used internally to differentiate alternative weapons (M4A4 / M4A1-S etc.).
 

pkg/demoinfocs/common/inferno.go

@@ -17,7 +17,7 @@ import (
 //
 // See also: Inferno.Active() and Fire.IsBurning
 type Inferno struct {
-	Entity st.IEntity
+	Entity st.Entity
 
 	// uniqueID is used to distinguish different infernos (which potentially have the same, reused entityID) from each other.
 	uniqueID         int64
@@ -186,7 +186,7 @@ func convexHull(pointCloud []r3.Vector) quickhull.ConvexHull {
 // NewInferno creates a inferno and sets the Unique-ID.
 //
 // Intended for internal use only.
-func NewInferno(demoInfoProvider demoInfoProvider, entity st.IEntity) *Inferno {
+func NewInferno(demoInfoProvider demoInfoProvider, entity st.Entity) *Inferno {
 	return &Inferno{
 		Entity:           entity,
 		uniqueID:         rand.Int63(),

pkg/demoinfocs/common/inferno_test.go

@@ -8,10 +8,11 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
+	stfake "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables/fake"
 )
 
 func TestInferno_UniqueID(t *testing.T) {
-	entity := new(st.Entity)
+	entity := new(stfake.Entity)
 	assert.NotEqual(t, NewInferno(nil, entity).UniqueID(), NewInferno(nil, entity).UniqueID(), "UniqueIDs of different infernos should be different")
 }
 

pkg/demoinfocs/common/player.go

@@ -28,7 +28,7 @@ type Player struct {
 	Inventory         map[int]*Equipment // All weapons / equipment the player is currently carrying. See also Weapons().
 	AmmoLeft          [32]int            // Ammo left for special weapons (e.g. grenades), index corresponds Equipment.AmmoType
 	EntityID          int                // Usually the same as Entity.ID() but may be different between player death and re-spawn.
-	Entity            st.IEntity         // May be nil between player-death and re-spawn
+	Entity            st.Entity          // May be nil between player-death and re-spawn
 	FlashDuration     float32            // Blindness duration from the flashbang currently affecting the player (seconds)
 	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
@@ -152,7 +152,7 @@ func (p *Player) IsSpottedBy(other *Player) bool {
 	clientSlot := other.EntityID - 1
 	bit := uint(clientSlot)
 
-	var mask st.IProperty
+	var mask st.Property
 	if bit < 32 {
 		mask = p.Entity.Property("m_bSpottedByMask.000")
 	} else {
@@ -343,7 +343,7 @@ 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
-	PlayerResourceEntity() st.IEntity
+	PlayerResourceEntity() st.Entity
 }
 
 // NewPlayer creates a *Player with an initialized equipment map.

pkg/demoinfocs/datatables.go

@@ -83,7 +83,7 @@ func (p *parser) bindBomb() {
 
 	// Track bomb when it is dropped on the ground or being held by a player
 	scC4 := p.stParser.ServerClasses().FindByName("CC4")
-	scC4.OnEntityCreated(func(bombEntity *st.Entity) {
+	scC4.OnEntityCreated(func(bombEntity st.Entity) {
 		bombEntity.OnPositionUpdate(func(pos r3.Vector) {
 			// Bomb only has a position when not held by a player
 			bomb.Carrier = nil
@@ -107,7 +107,7 @@ func (p *parser) bindBomb() {
 
 	// Track bomb when it has been planted
 	scPlantedC4 := p.stParser.ServerClasses().FindByName("CPlantedC4")
-	scPlantedC4.OnEntityCreated(func(bombEntity *st.Entity) {
+	scPlantedC4.OnEntityCreated(func(bombEntity st.Entity) {
 		// Player can't hold the bomb when it has been planted
 		p.gameState.bomb.Carrier = nil
 
@@ -116,7 +116,7 @@ func (p *parser) bindBomb() {
 }
 
 func (p *parser) bindTeamStates() {
-	p.stParser.ServerClasses().FindByName("CCSTeam").OnEntityCreated(func(entity *st.Entity) {
+	p.stParser.ServerClasses().FindByName("CCSTeam").OnEntityCreated(func(entity st.Entity) {
 		team := entity.PropertyValueMust("m_szTeamname").StringVal
 
 		var s *common.TeamState
@@ -155,12 +155,12 @@ func (p *parser) bindTeamStates() {
 }
 
 func (p *parser) bindBombSites() {
-	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(playerResource *st.Entity) {
+	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(playerResource st.Entity) {
 		playerResource.BindProperty("m_bombsiteCenterA", &p.bombsiteA.center, st.ValTypeVector)
 		playerResource.BindProperty("m_bombsiteCenterB", &p.bombsiteB.center, st.ValTypeVector)
 	})
 
-	p.stParser.ServerClasses().FindByName("CBaseTrigger").OnEntityCreated(func(baseTrigger *st.Entity) {
+	p.stParser.ServerClasses().FindByName("CBaseTrigger").OnEntityCreated(func(baseTrigger st.Entity) {
 		t := new(boundingBoxInformation)
 		p.triggers[baseTrigger.ID()] = t
 
@@ -170,11 +170,11 @@ func (p *parser) bindBombSites() {
 }
 
 func (p *parser) bindPlayers() {
-	p.stParser.ServerClasses().FindByName("CCSPlayer").OnEntityCreated(func(player *st.Entity) {
+	p.stParser.ServerClasses().FindByName("CCSPlayer").OnEntityCreated(func(player st.Entity) {
 		p.bindNewPlayer(player)
 	})
 
-	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(entity *st.Entity) {
+	p.stParser.ServerClasses().FindByName("CCSPlayerResource").OnEntityCreated(func(entity st.Entity) {
 		p.playerResourceEntity = entity
 	})
 }
@@ -215,7 +215,7 @@ func (p *parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, pl
 	return isNew, player
 }
 
-func (p *parser) bindNewPlayer(playerEntity st.IEntity) {
+func (p *parser) bindNewPlayer(playerEntity st.Entity) {
 	entityID := playerEntity.ID()
 	rp := p.rawPlayers[entityID-1]
 
@@ -289,7 +289,7 @@ func (p *parser) bindNewPlayer(playerEntity st.IEntity) {
 	}
 }
 
-func (p *parser) bindPlayerWeapons(playerEntity st.IEntity, pl *common.Player) {
+func (p *parser) bindPlayerWeapons(playerEntity st.Entity, pl *common.Player) {
 	// Some demos have an additional prefix for player weapons weapon
 	var wepPrefix string
 	if playerEntity.Property(playerWeaponPrefix+"000") != nil {
@@ -345,7 +345,7 @@ func (p *parser) bindWeapons() {
 			switch bc.Name() {
 			case "CWeaponCSBase":
 				sc2 := sc // Local copy for loop
-				sc.OnEntityCreated(func(e *st.Entity) { p.bindWeapon(e, p.equipmentMapping[sc2]) })
+				sc.OnEntityCreated(func(e st.Entity) { p.bindWeapon(e, p.equipmentMapping[sc2]) })
 			case "CBaseGrenade": // Grenade that has been thrown by player.
 				sc.OnEntityCreated(p.bindGrenadeProjectiles)
 			case "CBaseCSGrenade":
@@ -360,7 +360,7 @@ func (p *parser) bindWeapons() {
 
 // bindGrenadeProjectiles keeps track of the location of live grenades (parser.gameState.grenadeProjectiles), actively thrown by players.
 // It does NOT track the location of grenades lying on the ground, i.e. that were dropped by dead players.
-func (p *parser) bindGrenadeProjectiles(entity *st.Entity) {
+func (p *parser) bindGrenadeProjectiles(entity st.Entity) {
 	entityID := entity.ID()
 
 	proj := common.NewGrenadeProjectile()
@@ -448,7 +448,7 @@ func (p *parser) nadeProjectileDestroyed(proj *common.GrenadeProjectile) {
 	}
 }
 
-func (p *parser) bindWeapon(entity *st.Entity, wepType common.EquipmentType) {
+func (p *parser) bindWeapon(entity st.Entity, wepType common.EquipmentType) {
 	entityID := entity.ID()
 
 	eq, eqExists := p.gameState.weapons[entityID]
@@ -502,7 +502,7 @@ func (p *parser) bindWeapon(entity *st.Entity, wepType common.EquipmentType) {
 	}
 }
 
-func (p *parser) bindNewInferno(entity *st.Entity) {
+func (p *parser) bindNewInferno(entity st.Entity) {
 	inf := common.NewInferno(p.demoInfoProvider, entity)
 	p.gameState.infernos[entity.ID()] = inf
 
@@ -540,7 +540,7 @@ func (p *parser) bindGameRules() {
 	}
 
 	gameRules := p.ServerClasses().FindByName("CCSGameRulesProxy")
-	gameRules.OnEntityCreated(func(entity *st.Entity) {
+	gameRules.OnEntityCreated(func(entity st.Entity) {
 		entity.Property(grPrefix("m_gamePhase")).OnUpdate(func(val st.PropertyValue) {
 			oldGamePhase := p.gameState.gamePhase
 			p.gameState.gamePhase = common.GamePhase(val.IntVal)

pkg/demoinfocs/datatables_test.go

@@ -9,7 +9,7 @@ import (
 	common "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/common"
 	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
-	fakest "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables/fake"
+	stfake "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables/fake"
 )
 
 type DevNullReader struct {
@@ -89,8 +89,8 @@ func testPlayerSpotted(t *testing.T, propName string) {
 	}
 
 	// TODO: Player interface so we don't have to mock all this
-	spotted := new(fakest.Entity)
-	spottedByProp0 := new(fakest.Property)
+	spotted := new(stfake.Entity)
+	spottedByProp0 := new(stfake.Property)
 
 	var spottedByUpdateHandler st.PropertyUpdateHandler
 	spottedByProp0.On("OnUpdate", mock.Anything).Run(func(args mock.Arguments) {
@@ -122,14 +122,14 @@ func newParser() *parser {
 	return p
 }
 
-func fakePlayerEntity(id int) *fakest.Entity {
-	entity := new(fakest.Entity)
+func fakePlayerEntity(id int) *stfake.Entity {
+	entity := new(stfake.Entity)
 	configurePlayerEntityMock(id, entity)
 
 	return entity
 }
 
-func configurePlayerEntityMock(id int, entity *fakest.Entity) {
+func configurePlayerEntityMock(id int, entity *stfake.Entity) {
 	entity.On("ID").Return(id)
 
 	var destroyCallback func()
@@ -138,7 +138,9 @@ func configurePlayerEntityMock(id int, entity *fakest.Entity) {
 	})
 
 	entity.On("OnPositionUpdate", mock.Anything).Return()
-	entity.On("Property", mock.Anything).Return(new(st.Property))
+	prop := new(stfake.Property)
+	prop.On("OnUpdate", mock.Anything).Return()
+	entity.On("Property", mock.Anything).Return(prop)
 	entity.On("BindProperty", mock.Anything, mock.Anything, mock.Anything)
 	entity.On("Destroy").Run(func(mock.Arguments) {
 		destroyCallback()