common: Clean up

Merge branch 'clean-up-common' into v1.0.0

Author: markus-wa

Gopkg.lock

@@ -48,3 +48,7 @@
 [prune]
   go-tests = true
   unused-packages = true
+
+[[constraint]]
+  name = "github.com/stretchr/testify"
+  version = "1.2.2"

Gopkg.toml

@@ -2,154 +2,103 @@
 package common
 
 import (
-	"strings"
+	"math/rand"
+	"time"
+
+	r3 "github.com/golang/geo/r3"
+)
+
+// Team is the type for the various TeamXYZ constants.
+type Team byte
+
+// Team constants give information about which team a player is on.
+const (
+	TeamUnassigned Team = iota
+	TeamSpectators
+	TeamTerrorists
+	TeamCounterTerrorists
 )
 
-var eqNameToWeapon map[string]EquipmentElement
+// DemoHeader contains information from a demo's header.
+type DemoHeader struct {
+	Filestamp       string        // aka. File-type, must be HL2DEMO
+	Protocol        int           // Should be 4
+	NetworkProtocol int           // Not sure what this is for
+	ServerName      string        // Server's 'hostname' config value
+	ClientName      string        // Usually 'GOTV Demo'
+	MapName         string        // E.g. de_cache, de_nuke, cs_office, etc.
+	GameDirectory   string        // Usually 'csgo'
+	PlaybackTime    time.Duration // Demo duration in seconds (= PlaybackTicks / Server's tickrate)
+	PlaybackTicks   int           // Game duration in ticks (= PlaybackTime * Server's tickrate)
+	PlaybackFrames  int           // Amount of 'frames' aka demo-ticks recorded (= PlaybackTime * Demo's recording rate)
+	SignonLength    int           // Length of the Signon package in bytes
+}
+
+// FrameRate returns the frame rate of the demo (frames / demo-ticks per second).
+// Not necessarily the tick-rate the server ran on during the game.
+func (h DemoHeader) FrameRate() float64 {
+	return float64(h.PlaybackFrames) / h.PlaybackTime.Seconds()
+}
 
-var eqElementToName map[EquipmentElement]string
+// FrameTime returns the time a frame / demo-tick takes in seconds.
+func (h DemoHeader) FrameTime() time.Duration {
+	return time.Duration(h.PlaybackTime.Nanoseconds() / int64(h.PlaybackFrames))
+}
+
+// TickRate returns the tick-rate the server ran on during the game.
+// VolvoPlx128TixKTnxBye
+func (h DemoHeader) TickRate() float64 {
+	return float64(h.PlaybackTicks) / h.PlaybackTime.Seconds()
+}
+
+// TickTime returns the time a single tick takes in seconds.
+func (h DemoHeader) TickTime() time.Duration {
+	return time.Duration(h.PlaybackTime.Nanoseconds() / int64(h.PlaybackTicks))
+}
+
+// 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 {
+	EntityID   int
+	Weapon     EquipmentElement
+	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
+	Position   r3.Vector
+	Trajectory []r3.Vector // List of all known locations of the grenade up to the current point
+
+	// uniqueID is used to distinguish different grenades (which potentially have the same, reused entityID) from each other.
+	uniqueID int64
+}
 
-func init() {
-	initEqNameToWeapon()
-	initEqElementToName()
+// UniqueID returns the unique id of the grenade.
+// The unique id is a random int generated internally by this library and can be used to differentiate
+// grenades from each other. This is needed because demo-files reuse entity ids.
+func (g GrenadeProjectile) UniqueID() int64 {
+	return g.uniqueID
 }
 
-func initEqNameToWeapon() {
-	eqNameToWeapon = make(map[string]EquipmentElement)
-
-	eqNameToWeapon["ak47"] = EqAK47
-	eqNameToWeapon["aug"] = EqAUG
-	eqNameToWeapon["awp"] = EqAWP
-	eqNameToWeapon["bizon"] = EqBizon
-	eqNameToWeapon["c4"] = EqBomb
-	eqNameToWeapon["deagle"] = EqDeagle
-	eqNameToWeapon["decoy"] = EqDecoy
-	eqNameToWeapon["decoygrenade"] = EqDecoy
-	eqNameToWeapon["decoyprojectile"] = EqDecoy
-	eqNameToWeapon["elite"] = EqDualBarettas
-	eqNameToWeapon["famas"] = EqFamas
-	eqNameToWeapon["fiveseven"] = EqFiveSeven
-	eqNameToWeapon["flashbang"] = EqFlash
-	eqNameToWeapon["g3sg1"] = EqG3SG1
-	eqNameToWeapon["galil"] = EqGalil
-	eqNameToWeapon["galilar"] = EqGalil
-	eqNameToWeapon["glock"] = EqGlock
-	eqNameToWeapon["hegrenade"] = EqHE
-	eqNameToWeapon["hkp2000"] = EqP2000
-	eqNameToWeapon["incgrenade"] = EqIncendiary
-	eqNameToWeapon["incendiarygrenade"] = EqIncendiary
-	eqNameToWeapon["m249"] = EqM249
-	eqNameToWeapon["m4a1"] = EqM4A4
-	eqNameToWeapon["mac10"] = EqMac10
-	eqNameToWeapon["mag7"] = EqSwag7
-	eqNameToWeapon["molotov"] = EqMolotov
-	eqNameToWeapon["molotovgrenade"] = EqMolotov
-	eqNameToWeapon["molotovprojectile"] = EqMolotov
-	eqNameToWeapon["mp7"] = EqMP7
-	eqNameToWeapon["mp9"] = EqMP9
-	eqNameToWeapon["negev"] = EqNegev
-	eqNameToWeapon["nova"] = EqNova
-	eqNameToWeapon["p250"] = EqP250
-	eqNameToWeapon["p90"] = EqP90
-	eqNameToWeapon["sawedoff"] = EqSawedOff
-	eqNameToWeapon["scar20"] = EqScar20
-	eqNameToWeapon["sg556"] = EqSG556
-	eqNameToWeapon["smokegrenade"] = EqSmoke
-	eqNameToWeapon["smokegrenadeprojectile"] = EqSmoke
-	eqNameToWeapon["taser"] = EqZeus
-	eqNameToWeapon["tec9"] = EqTec9
-	eqNameToWeapon["ump45"] = EqUMP
-	eqNameToWeapon["xm1014"] = EqXM1014
-	eqNameToWeapon["m4a1_silencer"] = EqM4A1
-	eqNameToWeapon["m4a1_silencer_off"] = EqM4A1
-	eqNameToWeapon["cz75a"] = EqCZ
-	eqNameToWeapon["usp"] = EqUSP
-	eqNameToWeapon["usp_silencer"] = EqUSP
-	eqNameToWeapon["usp_silencer_off"] = EqUSP
-	eqNameToWeapon["world"] = EqWorld
-	eqNameToWeapon["inferno"] = EqIncendiary
-	eqNameToWeapon["revolver"] = EqRevolver
-	eqNameToWeapon["vest"] = EqKevlar
-	eqNameToWeapon["vesthelm"] = EqHelmet
-	eqNameToWeapon["defuser"] = EqDefuseKit
-
-	// These don't exist and / or used to crash the game with the give command
-	eqNameToWeapon["scar17"] = EqUnknown
-	eqNameToWeapon["sensorgrenade"] = EqUnknown
-	eqNameToWeapon["mp5navy"] = EqUnknown
-	eqNameToWeapon["p228"] = EqUnknown
-	eqNameToWeapon["scout"] = EqUnknown
-	eqNameToWeapon["sg550"] = EqUnknown
-	eqNameToWeapon["sg552"] = EqUnknown // This one still crashes the game :)
-	eqNameToWeapon["tmp"] = EqUnknown
-	eqNameToWeapon["worldspawn"] = EqUnknown
+// NewGrenadeProjectile creates a grenade projectile and sets the Unique-ID.
+//
+// Intended for internal use only.
+func NewGrenadeProjectile() *GrenadeProjectile {
+	return &GrenadeProjectile{uniqueID: rand.Int63()}
 }
 
-func initEqElementToName() {
-	eqElementToName = make(map[EquipmentElement]string)
-	eqElementToName[EqAK47] = "AK-47"
-	eqElementToName[EqAUG] = "AUG"
-	eqElementToName[EqAWP] = "AWP"
-	eqElementToName[EqBizon] = "PP-Bizon"
-	eqElementToName[EqBomb] = "C4"
-	eqElementToName[EqDeagle] = "Desert Eagle"
-	eqElementToName[EqDecoy] = "Decoy Grenade"
-	eqElementToName[EqDualBarettas] = "Dual Barettas"
-	eqElementToName[EqFamas] = "FAMAS"
-	eqElementToName[EqFiveSeven] = "Five-SeveN"
-	eqElementToName[EqFlash] = "Flashbang"
-	eqElementToName[EqG3SG1] = "G3SG1"
-	eqElementToName[EqGalil] = "Galil AR"
-	eqElementToName[EqGlock] = "Glock-18"
-	eqElementToName[EqHE] = "HE Grenade"
-	eqElementToName[EqP2000] = "P2000"
-	eqElementToName[EqIncendiary] = "Incendiary Grenade"
-	eqElementToName[EqM249] = "M249"
-	eqElementToName[EqM4A4] = "M4A1"
-	eqElementToName[EqMac10] = "MAC-10"
-	eqElementToName[EqSwag7] = "MAG-7"
-	eqElementToName[EqMolotov] = "Molotov"
-	eqElementToName[EqMP7] = "MP7"
-	eqElementToName[EqMP9] = "MP9"
-	eqElementToName[EqNegev] = "Negev"
-	eqElementToName[EqNova] = "Nova"
-	eqElementToName[EqP250] = "p250"
-	eqElementToName[EqP90] = "P90"
-	eqElementToName[EqSawedOff] = "Sawed-Off"
-	eqElementToName[EqScar20] = "SCAR-20"
-	eqElementToName[EqSG553] = "SG 553"
-	eqElementToName[EqSmoke] = "Smoke Grenade"
-	eqElementToName[EqScout] = "SSG 08"
-	eqElementToName[EqZeus] = "Zeus x27"
-	eqElementToName[EqTec9] = "Tec-9"
-	eqElementToName[EqUMP] = "UMP-45"
-	eqElementToName[EqXM1014] = "XM1014"
-	eqElementToName[EqM4A1] = "M4A1"
-	eqElementToName[EqCZ] = "CZ75 Auto"
-	eqElementToName[EqUSP] = "USP-S"
-	eqElementToName[EqWorld] = "World"
-	eqElementToName[EqRevolver] = "R8 Revolver"
-	eqElementToName[EqKevlar] = "Kevlar Vest"
-	eqElementToName[EqHelmet] = "Kevlar + Helmet"
-	eqElementToName[EqDefuseKit] = "Defuse Kit"
-	eqElementToName[EqKnife] = "Knife"
-	eqElementToName[EqUnknown] = "UNKNOWN"
+// Bomb tracks the bomb's position, and the player carrying it, if any.
+type Bomb struct {
+	// Intended for internal use only. Use Position() instead.
+	// Contains the last location of the dropped or planted bomb.
+	LastOnGroundPosition r3.Vector
+	Carrier              *Player
 }
 
-// MapEquipment creates an EquipmentElement from the name of the weapon / equipment.
-func MapEquipment(eqName string) EquipmentElement {
-	eqName = strings.TrimPrefix(eqName, weaponPrefix)
-
-	var wep EquipmentElement
-	if strings.Contains(eqName, "knife") || strings.Contains(eqName, "bayonet") {
-		wep = EqKnife
-	} else {
-		// If the eqName isn't known it will be EqUnknown as that is the default value for EquipmentElement
-		var ok bool
-		if wep, ok = eqNameToWeapon[eqName]; !ok {
-			// TODO: Return error / warning for unmapped weapons
-		}
+// Position returns the current position of the bomb.
+// This is either the position of the player holding it
+// or LastOnGroundPosition if it's dropped or planted.
+func (b Bomb) Position() r3.Vector {
+	if b.Carrier != nil {
+		return b.Carrier.Position
 	}
 
-	return wep
+	return b.LastOnGroundPosition
 }