Module CorsixTH.CorsixTH.Lua.dialogs.fullscreen.annual_report
Annual Report fullscreen window shown at the start of each year.
Functions
| UIAnnualReport:addAward (text, award_type, amount) | Adds an award frame with some text if the player clicks on it. |
| UIAnnualReport:addTrophy (text, award_type, amount) | Adds a trophy figure with some text if the player clicks on it. |
| UIAnnualReport:changePage (page_no) | Changes the page of the annual report. |
| UIAnnualReport:checkTrophiesAndAwards (world) | Finds out which awards and/or trophies the player has been awarded this year. |
| UIAnnualReport:close () | Overridden close function. |
| UIAnnualReport:showAwardMotivation (text_index_to_show) | Activates the motivation scroll with the given text on it. |
| UIAnnualReport:showTrophyMotivation (text_index_to_show) | Activates the motivation plaque with the given text on it. |
Functions
- UIAnnualReport:addAward (text, award_type, amount)
-
Adds an award frame with some text if the player clicks on it.
Parameters:
- text (string) The text to show as motivation.
- award_type (string) Should be one of "reputation" or "money"
- amount (integer) How much the player got/lost.
- UIAnnualReport:addTrophy (text, award_type, amount)
-
Adds a trophy figure with some text if the player clicks on it.
Parameters:
- text (string) The text to show as motivation.
- award_type (string) Should be one of "reputation" or "money"
- amount (integer) How much the player got/lost.
- UIAnnualReport:changePage (page_no)
-
Changes the page of the annual report.
Parameters:
- page_no The page to go to, either page 1, 2 or 3. Default is currently page 2.
- UIAnnualReport:checkTrophiesAndAwards (world)
-
Finds out which awards and/or trophies the player has been awarded this year.
Parameters:
- world
- UIAnnualReport:close ()
- Overridden close function. The game should be unpaused again when closing the dialog.
- UIAnnualReport:showAwardMotivation (text_index_to_show)
-
Activates the motivation scroll with the given text on it.
Parameters:
- text_index_to_show The index of the award to show info from.
- UIAnnualReport:showTrophyMotivation (text_index_to_show)
-
Activates the motivation plaque with the given text on it.
Parameters:
- text_index_to_show The index of the trophy to show info from.