Topic: Allow buildings to specify the icon used for “Purpose” in the Help

While working on a custom tribe, I noticed that the icon displayed next to the “Purpose” section in the building help text is always selected automatically in building_help.lua.

For production sites, the code tries output_ware_types[1], then output_worker_types[1], and then has several other fallbacks.

This works reasonably well in general, but it means that the building author cannot explicitly choose which object should represent the purpose of the building.

For example, I have a building that produces meat, fish and wool, and also recruits a donkey. For this particular building the donkey is the important new feature, so I would like the Purpose icon to be the donkey. The current automatic selection instead uses one of the produced wares because they have priority in the choosing of the icon.

I was thinking that an optional field such as purpose_icon in the building helptexts in units.lua could solve this:

helptexts = { purpose = pgettext(...), purpose_icon = "carrier_donkey" }

If purpose_icon is specified, the Help would use it; otherwise the current automatic selection would remain unchanged.

I already checked the code and I can prepare the corresponding code change and submit it if this sounds like a useful addition. What do you think?

Top

Quote

Thanks, give me a few days and I will propose the code change, it is pretty small and straightforward.

Top

Quote