AssignStartingPlots.IterateThroughCandidatePlotList (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 AssignStartingPlots.

This is an instance method, invoke it with a colon.


Usage

unknown AssignStartingPlots:IterateThroughCandidatePlotList(table(int => int) plot_list, int region_type)


Returned Value

No description available.

Parameters

plot_list: No description available.
region_type: No description available.


Source code samples

Redundant occurences have been removed.

AssignStartingPlots.lua (G&K)

DLC/Expansion/Gameplay/Lua/AssignStartingPlots.lua
2729
local election_returns = self:IterateThroughCandidatePlotList(plot_list, region_type)
2730
-- If any candidates are eligible, choose one.
2731
local found_eligible = election_returns[1];
3049
local election_returns = self:IterateThroughCandidatePlotList(plot_list, region_type)
3050
-- If any riverside candidates are eligible, choose one.
3051
local found_eligible = election_returns[1];
3309
local election_returns = self:IterateThroughCandidatePlotList(plot_list, region_type)
3310
-- If any plots in this area are eligible, choose one.
3311
local found_eligible = election_returns[1];



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.