1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
include "tribes/scripting/help/format_help.lua"
include "tribes/scripting/help/calculations.lua"
-- RST
-- 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.
-- =======================================================
-- ************* Main ware help functions *************
-- =======================================================
-- RST
-- .. function:: ware_help_general_string(tribe, ware_description)
--
-- Displays general info texts about the ware
--
-- :arg tribe: The :class:`wl.map.TribeDescription` for a tribe that uses this ware.
-- :arg ware_description: the ware_description from C++.
-- :returns: General info about the ware
--
function ware_help_general_string(tribe, ware_description)
-- TODO(GunChleoc): Split into purpose and note
local helptexts = ware_description:helptexts(tribe.name)
if helptexts["purpose"] ~= nil then
return h2(_("Purpose")) .. li_image(ware_description.icon_name, helptexts["purpose"])
else
return img(ware_description.icon_name)
end
end
-- RST
-- .. function:: ware_help_producers_string(tribe, ware_description)
--
-- Displays the buildings that produce this ware with information about
-- wares consumed in their production programs
--
-- :arg tribe: The :class:`wl.map.TribeDescription` for a tribe that uses this ware.
-- :arg ware_description: the ware_description from C++.
-- :returns: Info about buildings producing this ware and the production cost.
--
function ware_help_producers_string(tribe, ware_description)
local result = ""
for i, building in ipairs(ware_description:producers(tribe.name)) do
if (tribe:has_building(building.name)) then
-- TRANSLATORS: Ware Encyclopedia: A building producing a ware
result = result .. h2(_("Producer"))
result = result .. dependencies({building, ware_description}, linkify_encyclopedia_object(building))
producing_programs, produced_wares_counters, produced_wares_strings = programs_wares_count(tribe, building, ware_description)
-- Now collect the consumed wares for each filtered program and print the program info
for j, program_name in ipairs(producing_programs) do
result = result .. help_consumed_wares_workers(tribe, building, program_name)
if (produced_wares_counters[program_name] > 0) then
if (produced_wares_counters[program_name] == 1) then
-- TRANSLATORS: Ware Encyclopedia: 1 ware produced by a productionsite
result = result .. h3(_("Ware produced:"))
else
-- TRANSLATORS: Ware Encyclopedia: More than 1 ware produced by a productionsite
result = result .. h3(_("Wares produced:"))
end
result = result .. produced_wares_strings[program_name]
end
end
end
end
return result
end
-- RST
-- .. function:: ware_help_consumers_string(tribe, ware_description)
--
-- Displays the buildings that consume this ware and about
-- workers that use this ware as a tool
--
-- :arg tribe: The :class:`wl.map.TribeDescription` for a tribe that uses this ware.
-- :arg ware_description: the ware_description from C++.
-- :returns: Info about buildings and workers that use this ware
--
function ware_help_consumers_string(tribe, ware_description)
local result = ""
-- Now collecting the buildings that consume this ware
local consumers_string = ""
local consumers_amount = 0
for i, building in ipairs(ware_description:consumers(tribe.name)) do
if (tribe:has_building(building.name)) then
consumers_string = consumers_string .. dependencies({ware_description, building}, linkify_encyclopedia_object(building))
consumers_amount = consumers_amount + 1
end
end
-- Constructionsite isn't listed with the consumers, so we need a special check
if (ware_description:is_construction_material(tribe.name)) then
local constructionsite_description = wl.Game():get_building_description("constructionsite")
consumers_string = consumers_string
.. dependencies({ware_description, constructionsite_description}, linkify_encyclopedia_object(constructionsite_description))
consumers_amount = consumers_amount + 1
end
-- Now collecting the workers that use this ware as a tool
local workers_string = ""
for i, worker in ipairs(tribe.workers) do
local add_this_worker = false
for j, buildcost in ipairs(worker.buildcost) do
if (buildcost ~= nil and buildcost == ware_description.name) then
add_this_worker = true
consumers_amount = consumers_amount + 1
break
end
end
if(add_this_worker) then
workers_string = workers_string .. image_line(worker.icon_name, 1, p(linkify_encyclopedia_object(worker)))
end
end
-- Now show consumers (buildings + workers)
if (consumers_amount > 0) then
if (consumers_amount == 1) then
-- TRANSLATORS: Ware Encyclopedia: Heading for 1 building and / or worker that consumes a ware
result = result .. h2(_("Consumer"))
else
-- TRANSLATORS: Ware Encyclopedia: A list of buildings and / or workers that consume a ware
result = result .. h2(_("Consumers"))
end
if (consumers ~= "") then
result = result .. consumers_string
end
if (workers_string ~= "") then
result = result .. workers_string
end
end
return result
end
return {
func = function(tribename, warename)
push_textdomain("tribes_encyclopedia")
local tribe = wl.Game():get_tribe_description(tribename)
local ware_description = wl.Game():get_ware_description(warename)
local r = {
title = ware_description.descname,
text = ware_help_general_string(tribe, ware_description)
.. ware_help_producers_string(tribe, ware_description)
.. ware_help_consumers_string(tribe, ware_description)
}
pop_textdomain()
return r
end
}
|
