LuaEvents.TryDismissTutorial (Civ5 API)

From Civilization Modding Wiki
Jump to navigationJump to search

This page is a part of the Lua and UI Reference (Civ5).


Function.png This function is a member of LuaEvents.

This is a static method, invoke it with a dot.


Usage

void LuaEvents.TryDismissTutorial(string tutorialID)


Event Type

Regular event: you can subscribe to it through LuaEvents.TryDismissTutorial.Add(<function handler>) or invoke it directly through LuaEvents.TryDismissTutorial(<arguments list>).

Parameters

tutorialID: No description available.


Source code samples

Redundant occurences have been removed.

CityView.lua

UI/InGame/CityView/CityView.lua
0075
LuaEvents.TryDismissTutorial("CITY_SCREEN");


TradeLogic.lua

UI/InGame/WorldView/TradeLogic.lua
0497
LuaEvents.TryDismissTutorial("DIPLO_TRADE_SCREEN");


TutorialEngine.lua

Tutorial/TutorialEngine.lua
0681
LuaEvents.TryDismissTutorial.Add(function(tutorialID)
0682
--print("Trying to dismiss a tutorial");
0683
for i,v in ipairs(TutorialInfo) do
0684
   if(v.ID == tutorialID) then
0685
   DismissActiveTutorial(tutorial);
0686
   break;
0687
   end
0688
   end
0689
   end);



The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.