Merge lp:~widelands-dev/widelands/Economy_tutorial_fix into lp:widelands

[hessenfarmer]

fixes Bug #1624001
explains the new enhanced encyclopedia within the economy tutorial

explain the additional tabs of the encyclopedia
changes the way how the set target amount for marble columns is checked

[hessenfarmer (stephan-lutz)]

branch is playtested
however grammar and language should be checked

[bunnybot (widelandsofficial)]

Continuous integration builds have changed state:

Travis build 3402. State: passed. Details: https://travis-ci.org/widelands/widelands/builds/369856941.
Appveyor build 3208. State: success. Details: https://ci.appveyor.com/project/widelands-dev/widelands/build/_widelands_dev_widelands_Economy_tutorial_fix-3208.

[GunChleoc (gunchleoc)]

Stared proofreading. A bit cumbersome, since I can't hack on the code directly right now :(

[hessenfarmer (stephan-lutz)]

Read your comments so far. They will be implemented tonight. Just give me a hint when you are finished. Sorry for my grammar. I even can't set the commas in German. Regarding tone and language I tried to be in line with the rest of the tutorial. Hope it seems ´to be ok for you. Thanks for the first review

[GunChleoc (gunchleoc)]

I have done some edits - please proofread my changes.

I also noticed that the objective titles had . at the end of them, and I fixed those too.

Merge if you're happy with my changes.

review: Approve

[hessenfarmer (stephan-lutz)]

Have you checked how it looks like in the Game. Li_image with text looks only good with short texts in my eyes. If not I will test on Tuesday and merge then

[GunChleoc (gunchleoc)]

Yes, I have tested everything in-game. Do feel free to make further changes though if you don't like the result, I can then take another look when you're happy.

[Marcus Bell (marcuspbell)]

unsubscribe

On Sun, Apr 29, 2018 at 12:21 PM, GunChleoc <email address hidden>
wrote:

> Yes, I have tested everything in-game. Do feel free to make further
> changes though if you don't like the result, I can then take another look
> when you're happy.
> --
> https://code.launchpad.net/~widelands-dev/widelands/
> Economy_tutorial_fix/+merge/343770
> You are subscribed to branch lp:widelands.
>

[hessenfarmer (stephan-lutz)]

Ok now it looks good. I am happy now. just have a look at my new code

review: Needs Resubmitting

[GunChleoc (gunchleoc)]

Yes, that looks a lot nicer :)

@bunnybot merge

=== modified file 'data/campaigns/tutorial04_economy.wmf/scripting/mission_thread.lua'
--- data/campaigns/tutorial04_economy.wmf/scripting/mission_thread.lua	2017-12-19 23:25:05 +0000
+++ data/campaigns/tutorial04_economy.wmf/scripting/mission_thread.lua	2018-05-01 20:41:09 +0000
@@ -41,6 +41,24 @@
    end
 end
 
+function encyclopedia_tutorial()
+   sleep(100*1000)
+   local o = message_box_objective(plr, ware_encyclopedia) -- where to get help
+   while not mv.windows.encyclopedia do sleep(200) end
+   set_objective_done(o, wl.Game().real_speed)
+   
+   o = message_box_objective(plr, explain_encyclopedia) -- what information is available
+   local o2 = add_campaign_objective(reopen_encyclopedia_obj)
+   o2.visible = false
+   wait_for_window_and_tab_or_complain(
+      "encyclopedia",
+      "encyclopedia_wares",
+      o2, reopen_encyclopedia
+   )
+   while mv.windows.encyclopedia do sleep(200) end
+   set_objective_done(o, wl.Game().real_speed)
+end
+
 function burn_tavern_down()
    sleep(500)
    scroll_to_field(tavern_field)
@@ -86,8 +104,7 @@
    sleep(2000)
    o = message_box_objective(plr, build_taverns)
 
-   sleep(100*1000)
-   message_box_objective(plr, ware_encyclopedia) -- a small insert
+   encyclopedia_tutorial()
 
    while #plr:get_buildings("empire_tavern") < 2 do sleep(500) end
    set_objective_done(o, 0)
@@ -135,11 +152,14 @@
    message_box_objective(plr, economy_settings2)
    o = message_box_objective(plr, economy_settings3)
 
-   while sf.immovable:get_wares("marble_column") < 12 do sleep(500) end
+   local eco = sf.brn.immovable.economy
+   while eco:ware_target_quantity("marble_column") ~= 20 do
+      sleep(200)
+   end
    -- wait that the player has really changed the target quantity
-
-   o.visible = false
-   -- just forget about the old objective, the new one includes the old one
+   set_objective_done(o)
+   
+   -- new objective all has to be transported to the front
    o = message_box_objective(plr, warehouse_preference_settings)
 
    local enough_wares = false

=== modified file 'data/campaigns/tutorial04_economy.wmf/scripting/texts.lua'
--- data/campaigns/tutorial04_economy.wmf/scripting/texts.lua	2018-01-18 08:26:38 +0000
+++ data/campaigns/tutorial04_economy.wmf/scripting/texts.lua	2018-05-01 20:41:09 +0000
@@ -60,7 +60,7 @@
    ),
    h = 350,
    obj_name = "open_building_stat",
-   obj_title = _"Open the building statistics window.",
+   obj_title = _"Open the building statistics window",
    obj_body =
       li_image("images/wui/menus/menu_building_stats.png", _[[The building statistics window gives you an overview over the buildings you have.]]) ..
       -- TRANSLATORS: "it" refers to the building statistics window
@@ -83,7 +83,7 @@
       p(_[[This is enough explanation for now. Now try it out yourself. We want to know whether we still have taverns, so you have to choose the ‘Medium buildings’ tab. Close the building statistics menu afterwards.]])
    ),
    obj_name = "check_taverns",
-   obj_title = _"Look up how many taverns you have.",
+   obj_title = _"Look up how many taverns you have",
    obj_body = (
       li(_[[Choose the ‘Medium buildings’ tab in the building statistics window.]]) ..
       li(_[[Look up how many taverns you have.]]) ..
@@ -104,7 +104,7 @@
 
 reopen_building_stat_obj = {
    obj_name = "open_building_stat_again",
-   obj_title = _"Open the building statistics window again.",
+   obj_title = _"Open the building statistics window again",
    obj_body = (
       p(_[[You closed the building statistics window, although you have not yet looked up the number of taverns.]]) ..
       -- TRANSLATORS: "it" refers to the building statistics window.
@@ -124,7 +124,7 @@
    ),
    h = 300,
    obj_name = "open_inventory",
-   obj_title = _"Open your stock window.",
+   obj_title = _"Open your stock window",
    obj_body = (
       p(_[[The stock menu window gives you an overview over the wares you currently have.]]) ..
       -- TRANSLATORS: "it" refers to the stock menu window
@@ -145,7 +145,7 @@
    h = 350,
    show_instantly = true,
    obj_name = "switch_stock_tab",
-   obj_title = _"Switch to the third tab in the stock menu window.",
+   obj_title = _"Switch to the third tab in the stock menu window",
    obj_body = (
       p(_[[Have a look at the first two tabs in the stock menu window. They show all the wares and workers you have.]]) ..
       li(_[[When you have seen enough, switch to the third tab.]])
@@ -175,7 +175,7 @@
 
 reopen_stock_menu_obj = {
    obj_name = "open_stock_menu_again",
-   obj_title = _"Open the stock window again.",
+   obj_title = _"Open the stock window again",
    obj_body = (
       p(_[[You closed the stock menu window before I finished telling you everything about it. If you already know everything, please feel free to leave this tutorial at any time.]]) ..
       -- TRANSLATORS: "it" refers to the stock menu window.
@@ -194,7 +194,7 @@
    ),
    h = 300,
    obj_name = "build_taverns",
-   obj_title = _"Build new taverns.",
+   obj_title = _"Build new taverns",
    obj_body = (
       p(_[[To make our mines work, we need rations again – the more, the better.]]) ..
       li(_[[Build at least two taverns.]])
@@ -202,15 +202,70 @@
 }
 
 ware_encyclopedia = {
-   title = _"Ware Encyclopedia",
-   body = (
-      p(_[[I am not sure if you could follow my remarks. Why do we need rations to get soldiers?]]) ..
-      p(_[[When you’ve played a lot, you will know such things by heart. But when you’re unsure what this tribe needs for a special ware, you can easily look it up in your tribe’s ware encyclopedia.]]) ..
-      p(_[[This encyclopedia can be accessed via]])..
-      li_image("images/ui_basic/menu_help.png", _[[the help button at the bottom. For all your tribe’s wares, it shows a short help text, a list of buildings that produces the ware and the needed wares.]]) ..
-      p(_[[If you want, you can try it out. A soldier needs a wooden spear and a helmet – from there on out, you can search backwards.]])
-   ),
-   h = 350
+   title = _"Encyclopedia",
+   body = (
+      h1(_[[How to get help]]) ..
+      p(_[[Of course, it is difficult to remember all of my remarks and advice. For example, you might ask yourself: ‘Why do we need rations to get soldiers?’]]) ..
+      p(_[[When you’ve played a lot, you will know all these things by heart. But until then or if you’re unsure about your tribe’s needs and abilities and how its buildings and workers operate, you can look it up easily in our tribe-specific in-game help and encyclopedia.]]) ..
+      p(_[[This encyclopedia can be accessed via the help button at the bottom right.]])..
+      li_image("images/ui_basic/menu_help.png", _[[Please open the in-game help, and I’ll explain its contents to you.]])
+   ),
+   h = 350,
+   show_instantly = true,
+   obj_name = "open_encyclopedia",
+   obj_title = _"Open the in-game help window",
+   obj_body = (
+      li_image("images/ui_basic/menu_help.png", _[[The encyclopedia window contains the in-game help and an encyclopedia of the tribe you’re currently playing.]]) ..
+      -- TRANSLATORS: "it" refers to the encyclopedia window
+      li(_[[Open it. You can access it via the button at the bottom of the screen.]]) ..
+      li_arrow(_[[Alternatively, you can access it directly with the ‘F1’ key.]])
+   ),
+}
+
+explain_encyclopedia = {
+   position = "topright",
+   title = _"Encyclopedia details",
+   body = (
+      h1(_[[The Encyclopedia Categories]]) ..
+      p(_[[The encyclopedia has five tabs:]])..
+      div("width=100%", div("float=left padding_r=14 padding_t=5",p(img("images/logos/wl-ico-32.png"))) .. p(_[[The ‘General’ tab contains information about all the basic interface controls for Widelands. Furthermore, you can find tips that are relevant for your tribe there.]])) ..
+      div("width=100%", div("float=left padding_r=18 padding_t=15 padding_b=15 padding_l=4",p(img("images/wui/buildings/menu_tab_wares.png"))) .. p(_[[The ‘Wares’ tab shows information about the wares that your tribe needs, including a short help text, a list of buildings that produce each ware, the needed wares to produce it and where the ware is consumed.]])) ..
+      div("width=100%", div("float=left padding_r=16",p(img("images/wui/buildings/menu_tab_workers.png"))) .. p(_[[The ‘Workers’ tab shows information about your tribe’s workers in a similar manner to the wares in the second tab.]])) ..
+      div("width=100%", div("float=left padding_r=18 padding_t=5 padding_l=4",p(img("images/wui/stats/genstats_nrbuildings.png"))) .. p(_[[The ‘Buldings’ tab contains all the necessary information about the buildings of your tribe.]])) ..
+      li_image("tribes/immovables/field_harvested/idle_00.png", _[[Finally, the ‘Immovables’ tab shows information about the specific immovables that your tribe’s workers can place on the map.]]) ..
+      li(_[[Now use the encyclopedia to find out how to create new soldiers.]]) ..
+      li_arrow(_[[A soldier needs a wooden spear and a helmet – from there on out, you can search backwards to find the wares and the buildings you need to supply your barracks where the soldier is recruited. When you are finished, just close the encyclopedia window.]])
+   ),
+   h = 450,
+   show_instantly = true,
+   obj_name = "check_wares",
+   obj_title = _"Look up which wares are needed to recruit soldiers",
+   obj_body = (
+      li(_[[Choose the ‘Wares’ tab in the encyclopedia window.]]) ..
+      li(_[[Look up what is needed to produce a helmet and what is needed to produce a wooden spear.]]) ..
+      li_arrow(_[[If you want, you may further look up what is needed to produce the wares you just looked up.]]) ..
+      li(_[[Close the encyclopedia window when you are done.]])
+   )
+}
+
+reopen_encyclopedia = {
+   title = _"You closed the encyclopedia!",
+   body = (
+      p(_[[You have closed the encyclopedia window, but I didn’t notice that you were trying to find out which wares are needed to recruit a soldier. Would you please reopen it and do so?]])
+   ),
+   show_instantly = true,
+   w = 300,
+   h = 250
+}
+
+reopen_encyclopedia_obj = {
+   obj_name = "open_encyclopedia_again",
+   obj_title = _"Open the encyclopedia window again",
+   obj_body = (
+      p(_[[You closed the encyclopedia window without searching for the information we need. If you already know everything, please feel free to leave this tutorial at any time.]]) ..
+      li(_[[Otherwise, please reopen the encyclopedia window and choose the second tab.]])
+   ),
+   h = 250
 }
 
 building_priority_settings = {
@@ -239,7 +294,7 @@
    w = 200,
    h = 200,
    obj_name = "open_ware_stat",
-   obj_title = _"Open the ware statistics window.",
+   obj_title = _"Open the ware statistics window",
    obj_body = (
       li(_[[Open the ‘Ware statistics’ window, accessed via the statistics menu.]])
    )
@@ -255,7 +310,7 @@
    h = 250,
    show_instantly = true,
    obj_name = "switch_ware_stat_tab_to_third",
-   obj_title = _"Switch to the third tab in the ware statistics menu window.",
+   obj_title = _"Switch to the third tab in the ware statistics menu window",
    obj_body = (
       p(_[[The first two tabs show you the production and consumption of any ware. You can toggle them by simply clicking on them.]]) ..
       li(_[[When you have seen enough, switch to the third tab.]])
@@ -272,7 +327,7 @@
    h = 250,
    show_instantly = true,
    obj_name = "switch_ware_stat_tab_to_forth",
-   obj_title = _"Switch to the last tab in the ware statistics menu window.",
+   obj_title = _"Switch to the last tab in the ware statistics menu window",
    obj_body = (
       p(_[[The third tab shows you the economy health of the ware. When the value is positive, this means your stock is growing.]]) ..
       li(_[[When you have seen enough, switch to the fourth tab.]])
@@ -289,7 +344,7 @@
    h = 250,
    show_instantly = true,
    obj_name = "close_ware_stats",
-   obj_title = _"Close the ware statistics window.",
+   obj_title = _"Close the ware statistics window",
    obj_body = (
       p(_[[The stock tab shows you how many wares you have. Compare the information from the four tabs to understand the correlation.]]) ..
       li(_[[When you have finished, close the ware statistics window.]])
@@ -308,7 +363,7 @@
 
 reopen_ware_stats1_obj = {
    obj_name = "open_ware_stats_menu_again1",
-   obj_title = _"Open the ware statistics window again.",
+   obj_title = _"Open the ware statistics window again",
    obj_body = (
       p(_[[You closed the ware statistics menu window before I finished telling you everything about it. If you already know everything, please feel free to leave this tutorial at any time.]]) ..
       -- TRANSLATORS: "it" refers to the ware statistics window.
@@ -328,7 +383,7 @@
 
 reopen_ware_stats2_obj = {
    obj_name = "open_ware_stats_menu_again2",
-   obj_title = _"Open the ware statistics window again.",
+   obj_title = _"Open the ware statistics window again",
    obj_body = (
       p(_[[You closed the ware statistics menu window before I finished telling you everything about it. If you already know everything, please feel free to leave this tutorial at any time.]]) ..
       -- TRANSLATORS: "it" refers to the ware statistics window.
@@ -348,7 +403,7 @@
    ),
    h = 350,
    obj_name = "open_economy_settings",
-   obj_title = _"Open the ‘Configure economy’ window.",
+   obj_title = _"Open the ‘Configure economy’ window",
    obj_body = (
       li(_[[Open the ‘Configure economy’ window.]]) ..
       li_arrow(_[[The window can be accessed by clicking on any flag you own.]])
@@ -376,7 +431,7 @@
       li(_[[Set the target quantity for marble columns to 20 and wait for your stonemason to produce them.]])
    ),
    obj_name = "produce_marble_columns",
-   obj_title = _"Produce 20 marble columns.",
+   obj_title = _"Produce 20 marble columns",
    obj_body = (
       p(_[[Sometimes, you will need many wares at the same time quickly – faster than they can be produced. In this case, it is good to have enough on reserve.]]) ..
       li(_[[To be prepared for additional fortifications, you should produce 20 marble columns.]]) ..
@@ -394,15 +449,15 @@
       p(_[[The production of marble columns is working fine now, but it would be great if they were stored where we need them.]]) ..
       p(_[[Normally, produced wares are brought to the closest warehouse if they are not needed elsewhere. In this case, this means our headquarters. But we would like to have them in the warehouse near our fortresses.]]) ..
       p(_[[Every warehouse has four buttons to set the preference. If you move your mouse pointer over them, you will see tooltips that explain what the buttons do.]]) ..
-      li(_[[Bring all the marble columns to the warehouse near the front line.]]) ..
+      li(_[[Bring all of the 20 marble columns to the warehouse near the front line.]]) ..
       li_arrow(_[[To achieve this, you will have to do two things. First, set a preference for marble columns in the desired warehouse. All marble columns produced in the future will be brought there if possible.]]) ..
       li_arrow(_[[Then, to move the marble columns out of your headquarters, you will have to click on the remove button there.]])
    ),
    obj_name = "bring_marble_columns_to_front",
-   obj_title = _"Bring 20 marble columns to the front line.",
-   obj_body = economy_settings3.obj_body .. (
+   obj_title = _"Bring 20 marble columns to the front line",
+   obj_body = (
       p(_[[To decide where your wares get stored, you can use the preference buttons in the warehouses.]]) ..
-      li(_[[Bring all the marble columns to the warehouse near the front line.]]) ..
+      li(_[[Bring all of the 20 marble columns to the warehouse near the front line.]]) ..
       li_arrow(_[[To achieve this, you will have to do two things. First, set a preference for marble columns in the desired warehouse. All marble columns produced in the future will be brought there if possible.]]) ..
       li_arrow(_[[Then, to move the marble columns out of your headquarters, you will have to click on the remove button there.]])
    )