Move some constants to events package (#16)

Author: markus-wa

common/common.go

@@ -1,10 +1,4 @@
 // Package common contains common types, constants and functions used over different demoinfocs packages.
-// Some constants prefixes:
-// MVPReason - the reason why someone got the MVP award.
-// HG - HitGroup - where a bullet hit the player.
-// EE - EquipmentElement - basically the weapon identifiers.
-// RER - RoundEndReason - why the round ended (bomb exploded, defused, time ran out. . .).
-// EC - EquipmentClass - type of equipment (pistol, smg, heavy. . .).
 package common
 
 import (

common/constants.go

@@ -3,15 +3,6 @@ package common
 const weaponPrefix = "weapon_"
 
 type (
-	// RoundMVPReason is the type for the various MVPReasonYXZ constants.
-	RoundMVPReason byte
-
-	// HitGroup is the type for the various HitGroupXYZ constants.
-	HitGroup byte
-
-	// RoundEndReason is the type for the various RoundEndReasonXYZ constants.
-	RoundEndReason byte
-
 	// Team is the type for the various TeamXYZ constants.
 	Team byte
 
@@ -22,49 +13,6 @@ type (
 	EquipmentClass int
 )
 
-// RoundMVPReasons constants give information about why a player got the MVP award.
-const (
-	MVPReasonMostEliminations RoundMVPReason = 1
-	MVPReasonBombDefused      RoundMVPReason = 2
-	MVPReasonBombPlanted      RoundMVPReason = 3
-)
-
-// HitGroup constants give information about where a player got hit.
-// e.g. head, chest, legs etc.
-const (
-	HitGroupGeneric  HitGroup = 0
-	HitGroupHead     HitGroup = 1
-	HitGroupChest    HitGroup = 2
-	HitGroupStomach  HitGroup = 3
-	HitGroupLeftArm  HitGroup = 4
-	HitGroupRightArm HitGroup = 5
-	HitGroupLeftLeg  HitGroup = 6
-	HitGroupRightLeg HitGroup = 7
-	HitGroupGear     HitGroup = 10
-)
-
-// RoundEndReasons constants give information about why a round ended (Bomb defused, exploded etc.).
-const (
-	RoundEndReasonTargetBombed         RoundEndReason = 1
-	RoundEndReasonVIPEscaped           RoundEndReason = 2
-	RoundEndReasonVIPKilled            RoundEndReason = 3
-	RoundEndReasonTerroristsEscaped    RoundEndReason = 4
-	RoundEndReasonCTStoppedEscape      RoundEndReason = 5
-	RoundEndReasonTerroristsStopped    RoundEndReason = 6
-	RoundEndReasonBombDefused          RoundEndReason = 7
-	RoundEndReasonCTWin                RoundEndReason = 8
-	RoundEndReasonTerroristsWin        RoundEndReason = 9
-	RoundEndReasonDraw                 RoundEndReason = 10
-	RoundEndReasonHostagesRescued      RoundEndReason = 11
-	RoundEndReasonTargetSaved          RoundEndReason = 12
-	RoundEndReasonHostagesNotRescued   RoundEndReason = 13
-	RoundEndReasonTerroristsNotEscaped RoundEndReason = 14
-	RoundEndReasonVIPNotEscaped        RoundEndReason = 15
-	RoundEndReasonGameStart            RoundEndReason = 16
-	RoundEndReasonTerroristsSurrender  RoundEndReason = 17
-	RoundEndReasonCTSurrender          RoundEndReason = 18
-)
-
 // Team constants give information about which team a player is on.
 const (
 	TeamUnassigned Team = iota

events/events.go

@@ -17,22 +17,61 @@ type MatchStartedEvent struct{}
 // RoundAnnounceMatchStartedEvent signals that the announcement "Match Started" has been displayed.
 type RoundAnnounceMatchStartedEvent struct{}
 
+// RoundEndReason is the type for the various RoundEndReasonXYZ constants.
+//
+// See RoundEndedEvent.
+type RoundEndReason byte
+
+// RoundEndReason constants give information about why a round ended (Bomb defused, exploded etc.).
+const (
+	RoundEndReasonTargetBombed         RoundEndReason = 1
+	RoundEndReasonVIPEscaped           RoundEndReason = 2
+	RoundEndReasonVIPKilled            RoundEndReason = 3
+	RoundEndReasonTerroristsEscaped    RoundEndReason = 4
+	RoundEndReasonCTStoppedEscape      RoundEndReason = 5
+	RoundEndReasonTerroristsStopped    RoundEndReason = 6
+	RoundEndReasonBombDefused          RoundEndReason = 7
+	RoundEndReasonCTWin                RoundEndReason = 8
+	RoundEndReasonTerroristsWin        RoundEndReason = 9
+	RoundEndReasonDraw                 RoundEndReason = 10
+	RoundEndReasonHostagesRescued      RoundEndReason = 11
+	RoundEndReasonTargetSaved          RoundEndReason = 12
+	RoundEndReasonHostagesNotRescued   RoundEndReason = 13
+	RoundEndReasonTerroristsNotEscaped RoundEndReason = 14
+	RoundEndReasonVIPNotEscaped        RoundEndReason = 15
+	RoundEndReasonGameStart            RoundEndReason = 16
+	RoundEndReasonTerroristsSurrender  RoundEndReason = 17
+	RoundEndReasonCTSurrender          RoundEndReason = 18
+)
+
 // RoundEndedEvent signals that a round just finished.
 // Attention: TeamState.Score() won't be up to date yet after this.
 // Add +1 to the winner's score as a workaround.
 type RoundEndedEvent struct {
 	Message string
-	Reason  common.RoundEndReason
+	Reason  RoundEndReason
 	Winner  common.Team
 }
 
 // RoundOfficiallyEndedEvent signals that the round 'has officially ended', not exactly sure what that is tbh.
 type RoundOfficiallyEndedEvent struct{}
 
+// RoundMVPReason is the type for the various MVPReasonYXZ constants.
+//
+// See RoundMVPEvent.
+type RoundMVPReason byte
+
+// RoundMVPReasons constants give information about why a player got the MVP award.
+const (
+	MVPReasonMostEliminations RoundMVPReason = 1
+	MVPReasonBombDefused      RoundMVPReason = 2
+	MVPReasonBombPlanted      RoundMVPReason = 3
+)
+
 // RoundMVPEvent signals the announcement of the last rounds MVP.
 type RoundMVPEvent struct {
 	Player *common.Player
-	Reason common.RoundMVPReason
+	Reason RoundMVPReason
 }
 
 // RoundStartedEvent signals that a new round has started.
@@ -226,6 +265,25 @@ type BombBeginDefuseEvent struct {
 
 func (BombBeginDefuseEvent) implementsBombEventIf() {}
 
+// HitGroup is the type for the various HitGroupXYZ constants.
+//
+// See PlayerHurtEvent.
+type HitGroup byte
+
+// HitGroup constants give information about where a player got hit.
+// e.g. head, chest, legs etc.
+const (
+	HitGroupGeneric  HitGroup = 0
+	HitGroupHead     HitGroup = 1
+	HitGroupChest    HitGroup = 2
+	HitGroupStomach  HitGroup = 3
+	HitGroupLeftArm  HitGroup = 4
+	HitGroupRightArm HitGroup = 5
+	HitGroupLeftLeg  HitGroup = 6
+	HitGroupRightLeg HitGroup = 7
+	HitGroupGear     HitGroup = 10
+)
+
 // PlayerHurtEvent signals that a player has been damaged.
 type PlayerHurtEvent struct {
 	Player       *common.Player
@@ -236,7 +294,7 @@ type PlayerHurtEvent struct {
 	WeaponString string // Wrong for CZ, M4A1-S etc.
 	HealthDamage int
 	ArmorDamage  int
-	HitGroup     common.HitGroup
+	HitGroup     HitGroup
 }
 
 // PlayerBindEvent signals that a player has connected.

game_events.go

@@ -75,7 +75,7 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 
 		p.eventDispatcher.Dispatch(events.RoundEndedEvent{
 			Message: data["message"].GetValString(),
-			Reason:  common.RoundEndReason(data["reason"].GetValByte()),
+			Reason:  events.RoundEndReason(data["reason"].GetValByte()),
 			Winner:  t,
 		})
 
@@ -87,7 +87,7 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 
 		p.eventDispatcher.Dispatch(events.RoundMVPEvent{
 			Player: p.gameState.players[int(data["userid"].GetValShort())],
-			Reason: common.RoundMVPReason(data["reason"].GetValShort()),
+			Reason: events.RoundMVPReason(data["reason"].GetValShort()),
 		})
 
 	case "bot_takeover": // Bot got taken over
@@ -151,7 +151,7 @@ func (p *Parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 			Armor:        int(data["armor"].GetValByte()),
 			HealthDamage: int(data["dmg_health"].GetValShort()),
 			ArmorDamage:  int(data["dmg_armor"].GetValByte()),
-			HitGroup:     common.HitGroup(data["hitgroup"].GetValByte()),
+			HitGroup:     events.HitGroup(data["hitgroup"].GetValByte()),
 			Weapon:       getAttackingWeapon(&wep, attacker),
 		})