events: deprecate TickDone in favour of FrameDone (#120)

Author: markus-wa

demoinfocs_test.go

@@ -13,13 +13,13 @@ import (
 	"testing"
 	"time"
 
-	proto "github.com/gogo/protobuf/proto"
+	"github.com/gogo/protobuf/proto"
 	dispatch "github.com/markus-wa/godispatch"
 
 	dem "github.com/markus-wa/demoinfocs-golang"
-	common "github.com/markus-wa/demoinfocs-golang/common"
-	events "github.com/markus-wa/demoinfocs-golang/events"
-	msg "github.com/markus-wa/demoinfocs-golang/msg"
+	"github.com/markus-wa/demoinfocs-golang/common"
+	"github.com/markus-wa/demoinfocs-golang/events"
+	"github.com/markus-wa/demoinfocs-golang/msg"
 )
 
 const csDemosPath = "cs-demos"
@@ -202,7 +202,7 @@ func TestCancelParseToEnd(t *testing.T) {
 	var tix int
 
 	var handlerID dispatch.HandlerIdentifier
-	handlerID = p.RegisterEventHandler(func(events.TickDone) {
+	handlerID = p.RegisterEventHandler(func(events.FrameDone) {
 		tix++
 		if tix == maxTicks {
 			p.Cancel()
@@ -215,7 +215,7 @@ func TestCancelParseToEnd(t *testing.T) {
 		t.Error("Parsing cancelled but error was not ErrCancelled:", err)
 	}
 	if tix > maxTicks {
-		t.Error("TickDoneEvent handler was triggered after being unregistered")
+		t.Error("FrameDone handler was triggered after being unregistered")
 	}
 }
 

events/events.go

@@ -8,15 +8,20 @@ package events
 import (
 	"time"
 
-	r3 "github.com/golang/geo/r3"
+	"github.com/golang/geo/r3"
 
-	common "github.com/markus-wa/demoinfocs-golang/common"
-	msg "github.com/markus-wa/demoinfocs-golang/msg"
+	"github.com/markus-wa/demoinfocs-golang/common"
+	"github.com/markus-wa/demoinfocs-golang/msg"
 )
 
-// TickDone signals that a tick is done.
+// TickDone is deprecated, use the identical FrameDone event instead.
+// It does NOT signal the end of a tick, it signals the end of a demo-frame instead.
 type TickDone struct{}
 
+// FrameDone signals that a demo-frame has been processed.
+// A frame can contain multiple ticks (usually 2 or 4) if the tv_snapshotrate differs from the tick-rate the game was played at.
+type FrameDone struct{}
+
 // MatchStart signals that the match has started.
 type MatchStart struct{}
 
@@ -425,7 +430,7 @@ type DataTablesParsed struct{}
 
 // StringTableCreated signals that a string table was created via net message.
 // Can be useful for figuring out when player-info is available via Parser.GameState().[Playing]Participants().
-// E.g. after the table 'userinfo' has been created the player-data should be available after the next TickDone.
+// E.g. after the table 'userinfo' has been created the player-data should be available after the next FrameDone.
 // The reason it's not immediately available is because we need to do some post-processing to prep that data after a tick has finished.
 type StringTableCreated struct {
 	TableName string

parsing.go

@@ -349,6 +349,7 @@ func (p *Parser) handleFrameParsed(*frameParsedTokenType) {
 
 	p.currentFrame++
 	p.eventDispatcher.Dispatch(events.TickDone{})
+	p.eventDispatcher.Dispatch(events.FrameDone{})
 }
 
 /*