Player.GetUnhappinessForecast (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

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


Function.png This function is a member of Player.

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


Usage

int Player:GetUnhappinessForecast(City newCity, City newCity)


Returned Value

No description available.

Parameters

newCity: No description available.
newCity: No description available.


Source code samples

Redundant occurences have been removed.

PuppetCityPopup.lua

UI/InGame/PopupsGeneric/PuppetCityPopup.lua
0037
local iUnhappinessAnnexedCity = activePlayer:GetUnhappinessForecast(newCity, nil);   -- pAssumeCityAnnexed, pAssumeCityPuppeted
0038
local iUnhappinessPuppetCity = activePlayer:GetUnhappinessForecast(nil, newCity);      -- pAssumeCityAnnexed, pAssumeCityPuppeted


PuppetCityPopup.lua (G&K)

DLC/Expansion/UI/InGame/PopupsGeneric/PuppetCityPopup.lua
0046
iUnhappinessAnnexedCity = activePlayer:GetUnhappinessForecast(nil, newCity);



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.