events: Clean up naming (fixes #45)

- Remove stuttery 'Event' suffixes
- Improve grouping when lexographically ordered
- Use more appropriate tenses

PR #46

Author: markus-wa

README.md

@@ -20,7 +20,7 @@ You can use gitter to ask questions and discuss ideas about this project.
 
 ## Example
 
-This is a simple example on how to use the library. It collects all positions where weapons were fired from (using `events.WeaponFiredEvent`) and creates a heatmap using [go-heatmap](https://github.com/dustin/go-heatmap).
+This is a simple example on how to use the library. It collects all positions where weapons were fired from (using `events.WeaponFire`) and creates a heatmap using [go-heatmap](https://github.com/dustin/go-heatmap).
 
 Check out the [examples](examples) folder for more examples and the [godoc of the `events` package](https://godoc.org/github.com/markus-wa/demoinfocs-golang/events) for some information about the other available events and their purpose.
 
@@ -58,10 +58,10 @@ func main() {
 	// Get metadata for the map that's being played
 	m := metadata.MapNameToMap[header.MapName]
 
-	// Register handler for WeaponFiredEvent, triggered every time a shot is fired
+	// Register handler for WeaponFire, triggered every time a shot is fired
 	points := []heatmap.DataPoint{}
 	var bounds image.Rectangle
-	p.RegisterEventHandler(func(e events.WeaponFiredEvent) {
+	p.RegisterEventHandler(func(e events.WeaponFire) {
 		// Translate positions from in-game coordinates to radar overview
 		x, y := m.TranslateScale(e.Shooter.Position.X, e.Shooter.Position.Y)
 
@@ -139,7 +139,7 @@ Running the above code (`go run heatmap.go > heatmap.png`) will create a JPEG of
 * Grenade projectiles / trajectories - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang#GameState.GrenadeProjectiles) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/nade-trajectories)
 * Access to entities, server-classes & data-tables - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang/sendtables#ServerClasses) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/entities)
 * Access to all net-messages - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang#NetMessageCreator) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/net-messages)
-* Chat & console messages <sup id="achat1">1</sup> - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang/events#ChatMessageEvent) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
+* Chat & console messages <sup id="achat1">1</sup> - [docs](https://godoc.org/github.com/markus-wa/demoinfocs-golang/events#ChatMessage) / [example](https://github.com/markus-wa/demoinfocs-golang/tree/master/examples/print-events)
 * [Easy debugging via build-flags](#debugging)
 * Built with performance & concurrency in mind
 

datatables.go

@@ -308,7 +308,7 @@ func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
 	p.gameState.grenadeProjectiles[entityID] = proj
 
 	entity.OnCreateFinished(func() {
-		p.eventDispatcher.Dispatch(events.NadeProjectileThrownEvent{
+		p.eventDispatcher.Dispatch(events.GrenadeProjectileThrow{
 			Projectile: proj,
 		})
 	})
@@ -342,7 +342,7 @@ func (p *Parser) bindGrenadeProjectiles(entity *st.Entity) {
 	if bounceProp != nil {
 		bounceProp.OnUpdate(func(val st.PropertyValue) {
 			if val.IntVal != 0 {
-				p.eventDispatcher.Dispatch(events.NadeProjectileBouncedEvent{
+				p.eventDispatcher.Dispatch(events.GrenadeProjectileBounce{
 					Projectile: proj,
 					BounceNr:   val.IntVal,
 				})
@@ -359,7 +359,7 @@ func (p *Parser) nadeProjectileDestroyed(proj *common.GrenadeProjectile) {
 		return
 	}
 
-	p.eventDispatcher.Dispatch(events.NadeProjectileDestroyedEvent{
+	p.eventDispatcher.Dispatch(events.GrenadeProjectileDestroy{
 		Projectile: proj,
 	})
 
@@ -412,7 +412,7 @@ func (p *Parser) bindNewInferno(entity *st.Entity) {
 	p.gameState.infernos[entityID] = inf
 
 	entity.OnCreateFinished(func() {
-		p.eventDispatcher.Dispatch(events.InfernoStartedEvent{
+		p.eventDispatcher.Dispatch(events.InfernoStart{
 			Inferno: inf,
 		})
 	})
@@ -449,7 +449,7 @@ func (p *Parser) infernoExpired(inf *common.Inferno) {
 		return
 	}
 
-	p.eventDispatcher.Dispatch(events.InfernoExpiredEvent{
+	p.eventDispatcher.Dispatch(events.InfernoExpired{
 		Inferno: inf,
 	})
 

demoinfocs_test.go

@@ -67,7 +67,7 @@ func TestDemoInfoCs(t *testing.T) {
 
 	fmt.Println("Registering handlers")
 	gs := p.GameState()
-	p.RegisterEventHandler(func(e events.RoundEndedEvent) {
+	p.RegisterEventHandler(func(e events.RoundEnd) {
 		var winner *dem.TeamState
 		var loser *dem.TeamState
 		var winnerSide string
@@ -100,7 +100,7 @@ func TestDemoInfoCs(t *testing.T) {
 	})
 
 	// Check some things at match start
-	p.RegisterEventHandler(func(events.MatchStartedEvent) {
+	p.RegisterEventHandler(func(events.MatchStart) {
 		participants := gs.Participants()
 		all := participants.All()
 		players := participants.Playing()
@@ -123,7 +123,7 @@ func TestDemoInfoCs(t *testing.T) {
 	})
 
 	// Regression test for grenade projectiles not being deleted at the end of the round (issue #42)
-	p.RegisterEventHandler(func(events.RoundStartedEvent) {
+	p.RegisterEventHandler(func(events.RoundStart) {
 		if nProjectiles := len(p.GameState().GrenadeProjectiles()); nProjectiles > 0 {
 			t.Error("Expected 0 GrenadeProjectiles at the start of the round, got", nProjectiles)
 		}
@@ -214,7 +214,7 @@ func TestValveMatchmakingFuzzyEmitters(t *testing.T) {
 
 	teamSwitchDone := false
 	tScoreBeforeSwap, ctScoreBeforeSwap := -1, -1
-	p.RegisterEventHandler(func(ev events.RoundEndedEvent) {
+	p.RegisterEventHandler(func(ev events.RoundEnd) {
 		switch ev.Winner {
 		case common.TeamTerrorists:
 			tScoreBeforeSwap = p.GameState().TeamTerrorists().Score() + 1
@@ -261,7 +261,7 @@ func TestCancelParseToEnd(t *testing.T) {
 	var tix int
 
 	var handlerID dispatch.HandlerIdentifier
-	handlerID = p.RegisterEventHandler(func(events.TickDoneEvent) {
+	handlerID = p.RegisterEventHandler(func(events.TickDone) {
 		tix++
 		if tix == maxTicks {
 			p.Cancel()

demopacket.go

@@ -80,7 +80,7 @@ func (p *Parser) parsePacket() {
 			} else {
 				// Send a warning if the command is unknown
 				// This might mean our proto files are out of date
-				p.eventDispatcher.Dispatch(events.ParserWarnEvent{Message: fmt.Sprintf("Unknown message command %q", cmd)})
+				p.eventDispatcher.Dispatch(events.ParserWarn{Message: fmt.Sprintf("Unknown message command %q", cmd)})
 			}
 
 			// On to the next one