Add WorldlyToolTip support for Furnishings

[jdrueckert]

WorldlyTooltip currently has support for blocks, players, and WildAnimals: https://github.com/Terasology/WorldlyTooltip#worldlytooltip
However, the items in furnishings (currently doors and trunks) don't qualify as normal blocks, which is why the tooltip does not properly show a name and icon for them:

[jdrueckert]

My assumption is that we need to use WorldlyTooltipAPI and intercept GetTooltipIconEvent and GetTooltipNameEvent similar to what WildAnimals does in https://github.com/Terasology/WildAnimals/blob/e640ff5c651f93ac20953cc2134b0fd26a652c5b/src/main/java/org/terasology/wildAnimals/WorldlyTooltipDisplay/WildAnimalsTooltipSystem.java#L28-L42

[abu271]

Hi @jdrueckert I am taking a look at this issue, I am new to Java. My question is that when intercepting GetTooltipIconEvent and GetTooltipNameEvent events.

Do I need to use both DoorComponet & TrunkComponent classes for display name and icon?

[jdrueckert]

Hi @abu271
You only need one of them at a time. DoorComponent is present in door entities whereas TrunkComponent is present in trunk entities.

The ReceiveEvent in combination with the specified components has the effect, that the method is only executed if the event occurs for an entity that has the specified component. So if you check for DoorComponent, the method will be executed if the event occurs for a door entity, but not for a trunk. I you check for TrunkComponent, the method will be executed if the event occurs for a trunk entity, but not for a door. If you check for both, then the method will likely never be executed, because there is no entity that has both, a DoorComponent and a TrunkComponent.

Hope that answers the question 🙂

Commit your changes and create a PR as early as possible, then I can provide some more help on the basis of your changes in case you get stuck with something 😉

(also feel free to join our Discord, for potentially less asychronous communication)