Minecolonies & Huge Citizen Refactor

Hey everyone, these days we had gotten a lot of complaints about citizens going missing, duplicating or becoming zombies.
For that reason, I took a look at our EntityCitizen code to take care of that.
Unfortunately, it was almost impossible to figure out what the issue was.

The EntityCitizen.java class has over 2300 lines, less documentation than most other classes and all methods are spread randomly over the class.

Therefore, I noticed that a necessary step would be to extract this completely.

Similar to previous refactor I went a twofold way:

• Extract specific behavior into handlers;
• Extract not colony related entity overrides in an abstract class.

This way the file should be significantly smaller and at the same time way easier to handle in the future.

For this reason, I created the above list of handlers.
More specifically:

• Chat Handler: Handling Chat messages from the citizen to the player;
• Colony Handler: Handling the integration of a citizen with its colony;
• Experience Handler: Handling gaining experience of a citizen and leveling up;
• Inventory Handler: Handling inventory functions of the citizen;
• Item Handler: Handling interaction with items;
• Job Handler: Handling the Job the citizen has within its colony;
• Sleep Handler: Handling the citizen going to sleep;
• Status Handler: Handling Status information about the citizen;
• Stuck Handler: Checking if citizen is stuck and handling it.

Additionally, I extracted things like Data, texture and model information into a super class "AbstractEntityCitizen" which our Citizen will extend.

Besides that I extracted the Enums into our API so, mods who want to develop an integration with us can access these.

Each of the previously mentioned handlers has the citizen it belongs to stored in a local variable which it gets on creation through the constructor.

The handler is then a field in the EntityCitizen class and is initiated in the constructor of the citizen.

All handlers required from the outside also have a getter in the class.

This way I was able to reduce the class to roughly 1000 lines of code.
Adding a bunch of documentation as well.

Bug fixes on the way:

Now on the way, I was able to fix some bugs as well.

As mentioned in the previous posts, I decreased the updates for inactive colonies. Including updating citizens and marking the colony dirty if barbarians didn't decide to raid an inactive colony.
Also, not ticking buildings if they're not loaded.

Added a check if the worker has been stored with the wrong key.

Correctly check if the citizen can be assigned to a hut for the guard towers.

Remembering that if you want all but the "instance of" you might want to consider checking for null as well.

Besides that, I cleaned up a bunch of other things which should make it overall cleaner and avoid the duplications of citizens finally by ripping out some of the detection at inappropriate places where we spawned citizens even they were just been loaded.

Pull Requests:

https://github.com/Minecolonies/minecolonies/pull/2501