AssignStartingPlots.EvaluateCandidatePlot (Civ5 API)

From Civilization Modding Wiki
Revision as of 13:50, 20 September 2012 by DonQuich (talk | contribs) (Bot update)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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

int, bool AssignStartingPlots:EvaluateCandidatePlot(int plotIndex, int region_type)


Returned Values

No description available.

Parameters

plotIndex: 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
2763
local score, meets_minimums = self:EvaluateCandidatePlot(plotIndex, region_type)
2764
-- Test current plot against best known plot.
2765
if meets_minimums == true then
2816
local score, meets_minimums = self:EvaluateCandidatePlot(closestPlot, region_type)
2817
-- Assign this plot as the start for this region.
2818
self.startingPlots[region_number] = {x, y, score};



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.