Expose datatables (beta)

Author: markus-wa

events/events.go

@@ -296,3 +296,8 @@ type ItemDropEvent struct {
 	Weapon common.Equipment
 	Player *common.Player
 }
+
+// DataTablesParsedEvent signals that the datatables were parsed.
+// You can use the Parser.SendTableParser() after this event to register update notification on entities & properties.
+// DataTablesParsedEvent is a beta feature, it may be replaced or changed without notice.
+type DataTablesParsedEvent struct{}

parser.go

@@ -22,7 +22,7 @@ import (
 // Use Parser.RegisterEventHandler() to receive notifications about events.
 type Parser struct {
 	bitReader             *bit.BitReader
-	stParser              st.Parser
+	stParser              st.SendTableParser
 	msgDispatcher         dp.Dispatcher
 	eventDispatcher       dp.Dispatcher
 	msgQueue              chan interface{}
@@ -66,6 +66,12 @@ func (bbi boundingBoxInformation) contains(point r3.Vector) bool {
 		point.Z >= bbi.min.Z && point.Z <= bbi.max.Z
 }
 
+// SendTableParser returns the sendtable parser.
+// This is a beta feature and may be changed or replaced without notice.
+func (p *Parser) SendTableParser() *st.SendTableParser {
+	return &p.stParser
+}
+
 // Header returns the DemoHeader which contains the demo's metadata.
 func (p *Parser) Header() common.DemoHeader {
 	return *p.header

parsing.go

@@ -192,6 +192,8 @@ func (p *Parser) parseFrame() bool {
 		p.mapEquipment()
 		p.bindEntities()
 
+		p.eventDispatcher.Dispatch(events.DataTablesParsedEvent{})
+
 	case dcStringTables:
 		p.msgDispatcher.SyncQueues(p.msgQueue)
 

sendtables/constants.go

@@ -20,6 +20,8 @@ func (e *Entity) Props() []PropertyEntry {
 }
 
 // FindProperty finds a property on the Entity by name.
+// Returns nil if the property wasn't found.
+// Panics if more than one property with the same name was found.
 func (e *Entity) FindProperty(name string) *PropertyEntry {
 	var prop *PropertyEntry
 	for i := range e.props {
@@ -30,9 +32,6 @@ func (e *Entity) FindProperty(name string) *PropertyEntry {
 			prop = &e.props[i]
 		}
 	}
-	if prop == nil {
-		panic(fmt.Sprintf("Could not find property with name %q", name))
-	}
 	return prop
 }
 

sendtables/entity.go

@@ -11,27 +11,33 @@ import (
 	msg "github.com/markus-wa/demoinfocs-golang/msg"
 )
 
-// Parser provides functions for parsing send-tables.
-type Parser struct {
+// SendTableParser provides functions for parsing send-tables.
+type SendTableParser struct {
 	sendTables         []sendTable
 	serverClasses      []*ServerClass
 	currentExcludes    []*excludeEntry
 	currentBaseclasses []*ServerClass
 }
 
+type excludeEntry struct {
+	varName     string
+	dtName      string
+	excludingDt string
+}
+
 // ClassBits seems to calculate how many bits must be read for the server-class ID.
 // Not 100% sure how tho tbh.
-func (p *Parser) ClassBits() int {
+func (p *SendTableParser) ClassBits() int {
 	return int(math.Ceil(math.Log2(float64(len(p.serverClasses)))))
 }
 
 // ServerClasses returns the parsed server-classes
-func (p *Parser) ServerClasses() []*ServerClass {
+func (p *SendTableParser) ServerClasses() []*ServerClass {
 	return p.serverClasses
 }
 
 // ParsePacket parses a send-table packet.
-func (p *Parser) ParsePacket(r *bit.BitReader) {
+func (p *SendTableParser) ParsePacket(r *bit.BitReader) {
 	for {
 		t := msg.SVC_Messages(r.ReadVarInt32())
 		if t != msg.SVC_Messages_svc_SendTable {
@@ -101,7 +107,7 @@ func parseSendTable(r *bit.BitReader) sendTable {
 	return res
 }
 
-func (p *Parser) flattenDataTable(serverClassIndex int) {
+func (p *SendTableParser) flattenDataTable(serverClassIndex int) {
 	tab := &p.sendTables[p.serverClasses[serverClassIndex].DataTableID]
 
 	p.currentExcludes = nil
@@ -150,7 +156,7 @@ func (p *Parser) flattenDataTable(serverClassIndex int) {
 	}
 }
 
-func (p *Parser) gatherExcludesAndBaseClasses(st *sendTable, collectBaseClasses bool) {
+func (p *SendTableParser) gatherExcludesAndBaseClasses(st *sendTable, collectBaseClasses bool) {
 	for _, v := range st.properties {
 		if v.flags.hasFlagSet(propFlagExclude) {
 			p.currentExcludes = append(p.currentExcludes, &excludeEntry{varName: v.name, dtName: v.dataTableName, excludingDt: st.name})
@@ -169,13 +175,13 @@ func (p *Parser) gatherExcludesAndBaseClasses(st *sendTable, collectBaseClasses
 	}
 }
 
-func (p *Parser) gatherProps(st *sendTable, serverClassIndex int, prefix string) {
+func (p *SendTableParser) gatherProps(st *sendTable, serverClassIndex int, prefix string) {
 	var tmpFlattenedProps []FlattenedPropEntry
 	p.gatherPropsIterate(st, serverClassIndex, prefix, &tmpFlattenedProps)
 	p.serverClasses[serverClassIndex].FlattenedProps = append(p.serverClasses[serverClassIndex].FlattenedProps, tmpFlattenedProps...)
 }
 
-func (p *Parser) gatherPropsIterate(tab *sendTable, serverClassIndex int, prefix string, flattenedProps *[]FlattenedPropEntry) {
+func (p *SendTableParser) gatherPropsIterate(tab *sendTable, serverClassIndex int, prefix string, flattenedProps *[]FlattenedPropEntry) {
 	for i := range tab.properties {
 		prop := &tab.properties[i]
 		if prop.flags.hasFlagSet(propFlagInsideArray) || prop.flags.hasFlagSet(propFlagExclude) || p.isPropertyExcluded(tab, prop) {
@@ -204,7 +210,7 @@ func (p *Parser) gatherPropsIterate(tab *sendTable, serverClassIndex int, prefix
 	}
 }
 
-func (p *Parser) isPropertyExcluded(tab *sendTable, prop *sendTableProperty) bool {
+func (p *SendTableParser) isPropertyExcluded(tab *sendTable, prop *sendTableProperty) bool {
 	for _, v := range p.currentExcludes {
 		if v.dtName == tab.name && v.varName == prop.name {
 			return true
@@ -213,7 +219,7 @@ func (p *Parser) isPropertyExcluded(tab *sendTable, prop *sendTableProperty) boo
 	return false
 }
 
-func (p *Parser) getTableByName(name string) *sendTable {
+func (p *SendTableParser) getTableByName(name string) *sendTable {
 	for i := range p.sendTables {
 		if p.sendTables[i].name == name {
 			return &p.sendTables[i]
@@ -222,7 +228,7 @@ func (p *Parser) getTableByName(name string) *sendTable {
 	return nil
 }
 
-func (p *Parser) findServerClassByDtName(name string) *ServerClass {
+func (p *SendTableParser) findServerClassByDtName(name string) *ServerClass {
 	var sc *ServerClass
 	for _, v := range p.serverClasses {
 		if v.DTName == name {
@@ -232,14 +238,13 @@ func (p *Parser) findServerClassByDtName(name string) *ServerClass {
 			sc = v
 		}
 	}
-	if sc == nil {
-		panic(fmt.Sprintf("No server class with DT name %q found", name))
-	}
 	return sc
 }
 
 // FindServerClassByName finds and returns a server-class by it's name.
-func (p *Parser) FindServerClassByName(name string) *ServerClass {
+// Returns nil if the server-class wasn't found.
+// Panics if more than one server-class with the same name was found.
+func (p *SendTableParser) FindServerClassByName(name string) *ServerClass {
 	var sc *ServerClass
 	for _, v := range p.serverClasses {
 		if v.Name == name {
@@ -249,8 +254,5 @@ func (p *Parser) FindServerClassByName(name string) *ServerClass {
 			sc = v
 		}
 	}
-	if sc == nil {
-		panic(fmt.Sprintf("No server class with name %q found", name))
-	}
 	return sc
 }

sendtables/parser.go

@@ -9,6 +9,17 @@ import (
 	bit "github.com/markus-wa/demoinfocs-golang/bitread"
 )
 
+const (
+	propTypeInt int = iota
+	propTypeFloat
+	propTypeVector
+	propTypeVectorXY
+	propTypeString
+	propTypeArray
+	propTypeDataTable
+	propTypeInt64
+)
+
 const (
 	coordFractionalBitsMp             = 5
 	coordFractionalBitsMpLowPrecision = 3
@@ -26,6 +37,34 @@ const (
 	normalResolution  = 1.0 / normalDenominator
 )
 
+const (
+	dataTableMaxStringBits   = 9
+	dataTableMaxStringLength = 1 << dataTableMaxStringBits
+)
+
+const (
+	propFlagUnsigned sendPropertyFlags = (1 << iota)
+	propFlagCoord
+	propFlagNoScale
+	propFlagRoundDown
+	propFlagRoundUp
+	propFlagNormal
+	propFlagExclude
+	propFlagXYZE
+	propFlagInsideArray
+	propFlagProxyAlwaysYes
+	propFlagIsVectorElement
+	propFlagCollapsible
+	propFlagCoordMp
+	propFlagCoordMpLowPrecision
+	propFlagCoordMpIntegral
+	propFlagCellCoord
+	propFlagCellCoordLowPrecision
+	propFlagCellCoordIntegral
+	propFlagChangesOften
+	propFlagVarInt
+)
+
 const specialFloatFlags = propFlagNoScale | propFlagCoord | propFlagCellCoord | propFlagNormal | propFlagCoordMp | propFlagCoordMpLowPrecision | propFlagCoordMpIntegral | propFlagCellCoordLowPrecision | propFlagCellCoordIntegral
 
 var propDecoder propertyDecoder

sendtables/propdecoder.go

@@ -1,5 +1,32 @@
+// Package sendtables contains sendtable specific magic and should really be better documented (TODO).
 package sendtables
 
+// sendPropertyFlags stores multiple send property flags.
+type sendPropertyFlags int
+
+// hasFlagSet returns true if the given flag is set
+func (spf sendPropertyFlags) hasFlagSet(flag sendPropertyFlags) bool {
+	return int(spf)&int(flag) == int(flag)
+}
+
+type sendTable struct {
+	properties []sendTableProperty
+	name       string
+	isEnd      bool
+}
+
+type sendTableProperty struct {
+	flags            sendPropertyFlags
+	name             string
+	dataTableName    string
+	lowValue         float32
+	highValue        float32
+	numberOfBits     int
+	numberOfElements int
+	priority         int
+	rawType          int
+}
+
 // ServerClass stores meta information about Entity types (e.g. palyers, teams etc.).
 type ServerClass struct {
 	ClassID               int
@@ -39,12 +66,6 @@ func (fpe FlattenedPropEntry) Name() string {
 	return fpe.name
 }
 
-type excludeEntry struct {
-	varName     string
-	dtName      string
-	excludingDt string
-}
-
 // EntityCreatedEvent contains information about a newly created entity.
 type EntityCreatedEvent struct {
 	ServerClass *ServerClass