Fix entity baseline problems

The previous implementation of entity-baselines was broken which resulted
in wrong property values being sent out & stored on the entities (#25).

It also fired multiple updates for values that didn't match the default
value set in the baseline (#24) when an entity was created.

Now there is only one update right after the entity is created and the
values should be correct.

Author: markus-wa

entities.go

@@ -40,6 +40,7 @@ func (p *Parser) handlePacketEntities(pe *msg.CSVCMsg_PacketEntities) {
 				e := p.readEnterPVS(r, currentEntity)
 				p.entities[currentEntity] = e
 				e.ApplyUpdate(r)
+				e.ServerClass.FireEntityCreatedEvent(e)
 			} else {
 				// Delta Update
 				p.entities[currentEntity].ApplyUpdate(r)
@@ -54,23 +55,19 @@ func (p *Parser) readEnterPVS(reader *bit.BitReader, entityID int) *st.Entity {
 	reader.Skip(10) // Serial Number
 
 	newEntity := st.NewEntity(entityID, p.stParser.ServerClasses()[scID])
-	newEntity.ServerClass.FireEntityCreatedEvent(newEntity)
 
 	if p.preprocessedBaselines[scID] != nil {
 		for idx, val := range p.preprocessedBaselines[scID] {
 			newEntity.Props()[idx].FirePropertyUpdate(val)
 		}
 	} else {
-		ppBase := make(map[int]st.PropValue)
 		if p.instanceBaselines[scID] != nil {
-			newEntity.CollectProperties(&ppBase)
 			r := bit.NewSmallBitReader(bytes.NewReader(p.instanceBaselines[scID]))
-			newEntity.ApplyUpdate(r)
+			p.preprocessedBaselines[scID] = newEntity.InitializeBaseline(r)
 			r.Pool()
-			// TODO: Unregister PropertyUpdateHandlers from CollectProperties()
-			// PropertyUpdateHandlers would have to be registered as pointers for that to work
+		} else {
+			p.preprocessedBaselines[scID] = make(map[int]st.PropValue)
 		}
-		p.preprocessedBaselines[scID] = ppBase
 	}
 
 	return newEntity

sendtables/entity.go

@@ -97,34 +97,39 @@ func readFieldIndex(reader *bit.BitReader, lastIndex int, newWay bool) int {
 	return lastIndex + 1 + int(res)
 }
 
-// CollectProperties registers PropertyUpdateHandlers on the Entitiy
-// that will update a 'preprocessedBasleine' map with the most recent values.
-// This is used if entities leave and re-enter the PVS as entities will be re-created at that point
-// and we can then take the map as baseline for the new entity.
-func (e *Entity) CollectProperties(ppBase *map[int]PropValue) {
+// InitializeBaseline applies an update and collects a baseline (default values) from the update.
+func (e *Entity) InitializeBaseline(r *bit.BitReader) map[int]PropValue {
+	baseline := make(map[int]PropValue)
 	for i := range e.props {
 		i2 := i // Copy for the adder
 		adder := func(val PropValue) {
-			(*ppBase)[e.props[i2].index] = val
+			baseline[i2] = val
 		}
 
 		e.props[i].RegisterPropertyUpdateHandler(adder)
 	}
+
+	e.ApplyUpdate(r)
+
+	for i := range e.props {
+		e.props[i].updateHandlers = nil
+	}
+
+	return baseline
 }
 
 // NewEntity creates a new Entity with a given id and ServerClass and returns it.
 func NewEntity(id int, serverClass *ServerClass) *Entity {
-	props := make([]PropertyEntry, 0, len(serverClass.FlattenedProps))
+	props := make([]PropertyEntry, len(serverClass.FlattenedProps))
 	for i := range serverClass.FlattenedProps {
-		props = append(props, PropertyEntry{index: i, entry: &serverClass.FlattenedProps[i]})
+		props[i] = PropertyEntry{entry: &serverClass.FlattenedProps[i]}
 	}
 	return &Entity{ID: id, ServerClass: serverClass, props: props}
 }
 
 // PropertyEntry wraps a FlattenedPropEntry and allows registering handlers
 // that can be triggered on a update of the property.
 type PropertyEntry struct {
-	index          int
 	entry          *FlattenedPropEntry
 	updateHandlers []PropertyUpdateHandler
 	value          PropValue

sendtables/sendtables.go

@@ -46,6 +46,10 @@ func (sc *ServerClass) FireEntityCreatedEvent(entity *Entity) {
 			h(EntityCreatedEvent{Entity: entity, ServerClass: sc})
 		}
 	}
+
+	for _, v := range entity.props {
+		v.FirePropertyUpdate(v.value)
+	}
 }
 
 // RegisterEntityCreatedHandler registers a EntityCreatedHandler on the ServerClass.