ware_help.lua

This script returns a formatted entry for the ingame ware help. Pass the internal tribe name and ware name to the coroutine to select the ware type.

ware_help_general_string(tribe, ware_description)

Displays general info texts about the ware

Parameters:

  • tribe – The wl.map.TribeDescription for a tribe that uses this ware.

  • ware_description – the ware_description from C++.

Returns:

General info about the ware

ware_help_producers_string(tribe, ware_description)

Displays the buildings that produce this ware with information about wares consumed in their production programs

Parameters:

  • tribe – The wl.map.TribeDescription for a tribe that uses this ware.

  • ware_description – the ware_description from C++.

Returns:

Info about buildings producing this ware and the production cost.

ware_help_consumers_string(tribe, ware_description)

Displays the buildings that consume this ware and about workers that use this ware as a tool

Parameters:

  • tribe – The wl.map.TribeDescription for a tribe that uses this ware.

  • ware_description – the ware_description from C++.

Returns:

Info about buildings and workers that use this ware