events: fix ItemPickup, ItemEquip & ItemRemove UniqueID() issue

- use getPlayerWeapon() in gameEventHandler
- add ItemPickup.WeaponTraceable()
- delay ItemPickup event (so the weapon is added to Player.RawWeapons)

fixes #119

Author: markus-wa

events/events.go

@@ -407,22 +407,42 @@ type RankUpdate struct {
 // ItemEquip signals an item was equipped.
 // This event is not available in all demos.
 type ItemEquip struct {
-	Weapon common.Equipment
-	Player *common.Player
+	Player    *common.Player
+	Weapon    common.Equipment // Value of WeaponPtr, use WeaponPtr instead
+	WeaponPtr *common.Equipment
 }
 
 // ItemPickup signals an item was bought or picked up.
 // This event is not available in all demos.
 type ItemPickup struct {
-	Weapon common.Equipment
 	Player *common.Player
+	Weapon common.Equipment // UniqueID() of this cannot be used to trace the weapon, use WeaponTraceable() instead
+}
+
+// WeaponTraceable attempts to return the original Equipment instance.
+// This can be used to trace the same weapon with UniqueID() when it's being dropped to other players.
+//
+// If the original instance cannot be found, the returned Equipment will still have a different UniqueID().
+func (pu ItemPickup) WeaponTraceable() *common.Equipment {
+	if pu.Player == nil {
+		return &pu.Weapon
+	}
+
+	for _, wep := range pu.Player.RawWeapons {
+		if wep.Weapon == pu.Weapon.Weapon {
+			return wep
+		}
+	}
+
+	return &pu.Weapon
 }
 
 // ItemDrop signals an item was dropped.
 // This event is not available in all demos.
 type ItemDrop struct {
-	Weapon common.Equipment
-	Player *common.Player
+	Player    *common.Player
+	Weapon    common.Equipment // Value of WeaponPtr, use WeaponPtr instead
+	WeaponPtr *common.Equipment
 }
 
 // DataTablesParsed signals that the datatables were parsed.

events/events_test.go

@@ -42,6 +42,45 @@ func TestBombEvents(t *testing.T) {
 	}
 }
 
+func TestItemPickup_WeaponTraceable_PlayerNil(t *testing.T) {
+	e := ItemPickup{
+		Weapon: common.Equipment{Weapon: common.EqAK47},
+		Player: nil,
+	}
+
+	assert.Equal(t, e.Weapon, *e.WeaponTraceable())
+}
+
+func TestItemPickup_WeaponTraceable_WeaponFound(t *testing.T) {
+	wep := &common.Equipment{
+		EntityID: 1,
+		Weapon:   common.EqAK47,
+	}
+	e := ItemPickup{
+		Weapon: common.Equipment{Weapon: common.EqAK47},
+		Player: &common.Player{RawWeapons: map[int]*common.Equipment{
+			1: wep,
+		}},
+	}
+
+	assert.Equal(t, wep, e.WeaponTraceable())
+}
+
+func TestItemPickup_WeaponTraceable_WeaponNotFound(t *testing.T) {
+	wep := &common.Equipment{
+		EntityID: 1,
+		Weapon:   common.EqAK47,
+	}
+	e := ItemPickup{
+		Weapon: common.Equipment{Weapon: common.EqKnife},
+		Player: &common.Player{RawWeapons: map[int]*common.Equipment{
+			1: wep,
+		}},
+	}
+
+	assert.Equal(t, e.Weapon, *e.WeaponTraceable())
+}
+
 type demoInfoProvider struct {
 }
 

game_events.go

@@ -481,33 +481,36 @@ func (geh gameEventHandler) bombBegindefuse(desc *msg.CSVCMsg_GameEventListDescr
 func (geh gameEventHandler) itemEquip(desc *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) {
 	player, weapon := geh.itemEvent(desc, ge)
 	geh.dispatch(events.ItemEquip{
-		Player: player,
-		Weapon: weapon,
+		Player:    player,
+		Weapon:    *weapon,
+		WeaponPtr: weapon,
 	})
 }
 
 func (geh gameEventHandler) itemPickup(desc *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) {
 	player, weapon := geh.itemEvent(desc, ge)
-	geh.dispatch(events.ItemPickup{
+	// Delayed because of #119 - Equipment.UniqueID()
+	geh.parser.delayedEvents = append(geh.parser.delayedEvents, events.ItemPickup{
 		Player: player,
-		Weapon: weapon,
+		Weapon: *weapon,
 	})
 }
 
 func (geh gameEventHandler) itemRemove(desc *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) {
 	player, weapon := geh.itemEvent(desc, ge)
 	geh.dispatch(events.ItemDrop{
-		Player: player,
-		Weapon: weapon,
+		Player:    player,
+		Weapon:    *weapon,
+		WeaponPtr: weapon,
 	})
 }
 
-func (geh gameEventHandler) itemEvent(desc *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) (*common.Player, common.Equipment) {
+func (geh gameEventHandler) itemEvent(desc *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_GameEvent) (*common.Player, *common.Equipment) {
 	data := mapGameEventData(desc, ge)
 	player := geh.playerByUserID32(data["userid"].GetValShort())
 
 	wepType := common.MapEquipment(data["item"].GetValString())
-	weapon := common.NewEquipment(wepType)
+	weapon := getPlayerWeapon(player, wepType)
 
 	return player, weapon
 }