UI.GetMapPreview (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 UI.

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


Usage

WorldBuilderMapData UI.GetMapPreview(string mapFilePath)


Returned Value

No description available.

Parameters

mapFilePath: No description available.


Source code samples

Redundant occurences have been removed.

AdvancedSetup.lua

UI/FrontEnd/GameSetup/AdvancedSetup.lua
0700
local mapData = UI.GetMapPreview(map.File);


GameMenu.lua

UI/InGame/Menus/GameMenu.lua
0257
local mapData = UI.GetMapPreview(mapScript);


GameSetupScreen.lua

UI/FrontEnd/GameSetup/GameSetupScreen.lua
0336
local mapInfo = UI.GetMapPreview(mapScriptFileName);
0398
local preview = UI.GetMapPreview(mapFileName);


LoadMenu.lua

UI/FrontEnd/LoadMenu.lua
0347
local mapData = UI.GetMapPreview(header.MapScript);


Lobby.lua

UI/FrontEnd/Multiplayer/Lobby.lua
0274
local mapData = UI.GetMapPreview(serverMapFile);


MPGameOptions.lua

UI/FrontEnd/Multiplayer/GameSetup/MPGameOptions.lua
0610
local mapInfo = UI.GetMapPreview(v[1]);


SaveMapMenu.lua

UI/InGame/Menus/SaveMapMenu.lua
0118
SetSaveInfo(UI.GetMapPreview(entry.File).MapSize, date);


SelectMapType.lua

UI/FrontEnd/GameSetup/SelectMapType.lua
0068
local mapInfo = UI.GetMapPreview(mapScript);


SinglePlayer.lua

UI/FrontEnd/SinglePlayer.lua
0057
local mapData = UI.GetMapPreview(savedMapScript);



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.