Events.RequestYieldDisplay (Civ5 API)

From Civilization Modding Wiki
Revision as of 18:57, 19 September 2012 by DonQuich (talk | contribs) (Bot update)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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


Function.png This function is a member of Events.

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


Usage

void Events.RequestYieldDisplay(YieldDisplayType type, ResourceType arg1 = nil, ResourceType gridX = nil, int gridY = nil)


Event Type

Regular event: you can subscribe to it through Events.RequestYieldDisplay.Add(<function handler>) or invoke it directly through Events.RequestYieldDisplay(<arguments list>).

Parameters

type: No description available.
arg1: No description available.
gridX: No description available.
gridY: No description available.


Source code samples

Redundant occurences have been removed.

CityView.lua

UI/InGame/CityView/CityView.lua
0956
Events.RequestYieldDisplay( YieldDisplayTypes.CITY_OWNED, pCity:GetX(), pCity:GetY() );
0961
Events.RequestYieldDisplay( YieldDisplayTypes.CITY_WORKED, pCity:GetX(), pCity:GetY() );
1832
Events.RequestYieldDisplay( YieldDisplayTypes.CITY_PURCHASABLE, pCity:GetX(), pCity:GetY() );


InGame.lua

UI/InGame/InGame.lua
0294
Events.RequestYieldDisplay( YieldDisplayTypes.CITY_WORKED, lastCityEntered:GetX(), lastCityEntered:GetY() );
0970
Events.RequestYieldDisplay( YieldDisplayTypes.AREA, 2, gridX, gridY );
0995
Events.RequestYieldDisplay( YieldDisplayTypes.EMPIRE );
0999
Events.RequestYieldDisplay( YieldDisplayTypes.AREA, 2, unit:GetX(), unit:GetY() );
1003
Events.RequestYieldDisplay( YieldDisplayTypes.AREA, 0 );


MiniMapPanel.lua

UI/InGame/WorldView/MiniMapPanel.lua
0399
Events.RequestYieldDisplay.Add( OnYieldDisplay );


ResourceIconManager.lua

UI/InGame/ResourceIconManager.lua
0139
Events.RequestYieldDisplay.Add( OnRequestYieldDisplay );



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.