The Datawatcher

hydroflame · August 11, 2013

so lets talk about this guy

basicly the datawatcher is a threadsafe object that will detect changes in values that should be sync between the client and the server. it allows you to store a variety of different type (byte, short, int, float, string, ItemStack and ChunkCoordinates) and will automaticly sync them between clients and the server. sounds good

now DataWatchers watch object (of type enumerated above) and place them in a hashmap, yet for some reason there seem to be a check to have a data id smaller then 32

public void addObject(int par1, Object par2Obj)
{

Integer integer = (Integer)dataTypes.get(par2Obj.getClass());

if (integer == null)

{

throw new IllegalArgumentException("Unknown data type: " + par2Obj.getClass());

}

else if (par1 > 31)

{

throw new IllegalArgumentException("Data value id is too big with " + par1 + "! (Max is " + 31 + ")");

}

which is weird because obviously a hashmap can contain MANY more values :\

and the method that writes the object into the packets isnt restricted in any way about the amount of information that can be sent in it:

 public static void writeObjectsInListToStream(List par0List, DataOutput par1DataOutput) throws IOException
    {
        if (par0List != null)
        {
            Iterator iterator = par0List.iterator();

            while (iterator.hasNext())
            {
                WatchableObject watchableobject = (WatchableObject)iterator.next();
                writeWatchableObject(par1DataOutput, watchableobject);
            }
        }

        par1DataOutput.writeByte(127);//terminator btw
    }

now if we look into example EntityPlayer class, we can see that the maximum data id that will be occupied by the EntityPlayer data watcher is id 18

protected void entityInit()
    {
        super.entityInit();
        this.dataWatcher.addObject(16, Byte.valueOf((byte)0));
        this.dataWatcher.addObject(17, Float.valueOf(0.0F));
        this.dataWatcher.addObject(18, Integer.valueOf(0));
    }

this implies that there are still a couple of values left free that modders could potentially use (of course in other class too)

Is there a reason why we are not increasing the limit of datawatchers ? (note that would require a partial rewrite of DataWatcher.readWatchableObjects because it does something related to the 31 limit)

also i search a little into the forge class and there didn't seem to be anything that would "reserve" a data id for your mod (alerting other mods that this is was already taken)

couldn't there be a sort of system that would automatically allocate the available id between the different mods that needs them ?

hydroflame · August 11, 2013

ah i see, probably missed it last night.

in any case theres still a couple of free id and it wouldnt be imposible to rewrite the methods to expand to higher id

hydroflame · August 11, 2013

hey if no one is going to use those id because "theres not a lot free" ill gladly use them without looking back im not saying we should store 32000 new id on datawatchers im saying we could use the remaining ids to store value that require update on a regular basis (mana?, energy?)

lets take the example of a mod that adds energy to plauers and want the energy to change the way the player is rendered (he looks like exhaustedwhen he is low)

the datawatcher is a perfect place to store that as it update on a regular basis and it will update only to players who needs it (i dont need to spend time optimizing the distance from player to send the packet, mojang already did that for me)

also maybe just changing one class isnt enough, but my test showed me that it seems possible

i just want to check the efficiency of the system before and after to make sure performance hasnt dropped dramatically

Mazetar · August 11, 2013

Just wondering, wouldn't it be easier to create a new system.

Sort of like an ExtendedDataWatcher or something, which we can utilize like we do with the extended properties?

GotoLink · August 11, 2013

Personally I would replace the Exception thrown by an hook to another class.

hydroflame · August 12, 2013

after more research in the issue i have discovered that there is actually a very low amount of values that are actually used

result:

2013-08-12 10:55:02 [iNFO] [sTDOUT] class net.minecraft.entity.player.EntityPlayerMP

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 17 value: 0.0 value of type: Float

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 0 value: 0 value of type: Byte

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 16 value: 0 value of type: Byte

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 1 value: 300 value of type: Short

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 18 value: 0 value of type: Integer

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 6 value: 1.0 value of type: Float

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 7 value: 0 value of type: Integer

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 8 value: 0 value of type: Byte

2013-08-12 10:55:02 [iNFO] [sTDOUT] key: 9 value: 0 value of type: Byte

2013-08-12 10:55:02 [iNFO] [sTDOUT] we are using 9/31 meaning we have 22 free

2013-08-12 10:55:03 [iNFO] [sTDOUT]

2013-08-12 10:55:03 [iNFO] [sTDOUT] class net.minecraft.client.entity.EntityClientPlayerMP

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 17 value: 0.0 value of type: Float

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 0 value: 0 value of type: Byte

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 16 value: 0 value of type: Byte

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 1 value: 300 value of type: Short

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 18 value: 0 value of type: Integer

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 6 value: 1.0 value of type: Float

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 7 value: 0 value of type: Integer

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 8 value: 0 value of type: Byte

2013-08-12 10:55:03 [iNFO] [sTDOUT] key: 9 value: 0 value of type: Byte

2013-08-12 10:55:03 [iNFO] [sTDOUT] we are using 9/31 meaning we have 22 free

2013-08-12 10:55:22 [iNFO] [sTDOUT]

2013-08-12 10:55:22 [iNFO] [sTDOUT] class net.minecraft.entity.monster.EntitySlime

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 0 value: 0 value of type: Byte

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 16 value: 1 value of type: Byte

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 1 value: 300 value of type: Short

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 6 value: 1.0 value of type: Float

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 7 value: 0 value of type: Integer

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 8 value: 0 value of type: Byte

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 9 value: 0 value of type: Byte

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 10 value: value of type: String

2013-08-12 10:55:22 [iNFO] [sTDOUT] key: 11 value: 0 value of type: Byte

2013-08-12 10:55:22 [iNFO] [sTDOUT] we are using 9/31 meaning we have 22 free

2013-08-12 10:55:22 [iNFO] [sTDOUT]

2013-08-12 10:55:22 [iNFO] [sTDOUT] class net.minecraft.entity.monster.EntitySkeleton