Player.GetNumResourceTotal (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:GetNumResourceTotal(ResourceType resource, bool includeImport)


Returned Value

No description available.

Parameters

resource: No description available.
includeImport: No description available.


Source code samples

Redundant occurences have been removed.

HappinessInfo.lua

UI/InGame/Popups/HappinessInfo.lua
0213
if (pPlayer:GetNumResourceTotal(resourceID, true) > 0) then
0614
local iNum = pPlayer:GetNumResourceTotal(iResourceID, true);
0740
local iNum = pPlayer:GetNumResourceTotal(iResourceID, false) + pPlayer:GetResourceExport(iResourceID);


ResourceList.lua

UI/InGame/ResourceList.lua
0088
iTotal = pPlayer:GetNumResourceTotal( iResource, true );


TopPanel.lua

UI/InGame/TopPanel.lua
0173
iNumTotal = pPlayer:GetNumResourceTotal(iResourceLoop, true);



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.