CvCity - Revision history

Jiraboas: /* Functions */

2014-03-29T12:15:09Z

Functions

← Older revision		Revision as of 12:15, 29 March 2014
Line 184:		Line 184:
	\|Boolean		\|Boolean
	\|Returns true if the city has exceeded the maximum limit for the # of buildings.		\|Returns true if the city has exceeded the maximum limit for the # of buildings.
			\|-
			!CvCity::getFoodTurnsLeft()
			\|None
			\|Int
			\|Get the number of turns left, until city will grow, according to current food left and current growth treshold
	\|}		\|}

	{{Civ4_SDK_Files}}		{{Civ4_SDK_Files}}

Jiraboas: /* Functions */

2014-03-29T11:34:20Z

Functions

← Older revision		Revision as of 11:34, 29 March 2014
Line 58:		Line 58:
	\|None		\|None
	\|Boolean		\|Boolean
	\|~~Called when the~~ city is selected ~~in-game~~		\|returns true or false if a particular city is selected or not
	\|-		\|-
	!CvCity::canBeSelected()		!CvCity::canBeSelected()

Afforess at 01:27, 26 December 2009

2009-12-26T01:27:54Z

@@ Line 104: / Line 104: @@
 |CvPlot*
 |Returns plot X,Y coordinates of the given index number.
 |}
 {{Civ4_SDK_Files}}

Afforess at 17:40, 23 December 2009

2009-12-23T17:40:21Z

← Older revision		Revision as of 17:40, 23 December 2009
Line 79:		Line 79:
	\|Void		\|Void
	\|Called at the start of the game and removes the fog of war and adds visibility for the city		\|Called at the start of the game and removes the fog of war and adds visibility for the city
			\|-
	!CvCity::createGreatPeople()		!CvCity::createGreatPeople()
	\|UnitTypes eGreatPersonUnit, bool bIncrementThreshold, bool bIncrementExperience		\|UnitTypes eGreatPersonUnit, bool bIncrementThreshold, bool bIncrementExperience
	\|Void		\|Void
	\|Calls the CvPlayer::createGreatPeople function.		\|Calls the CvPlayer::createGreatPeople function.
			\|-
	!CvCity::doTask()		!CvCity::doTask()
	\|TaskTypes eTask, int iData1, int iData2, bool bOption, bool bAlt, bool bShift, bool bCtrl		\|TaskTypes eTask, int iData1, int iData2, bool bOption, bool bAlt, bool bShift, bool bCtrl
	\|Void		\|Void
	\|Called when a player commands a city to do a task (like hurry production), and calls the function for the specific task that was called, or does nothing if it is given an invalid task type.		\|Called when a player commands a city to do a task (like hurry production), and calls the function for the specific task that was called, or does nothing if it is given an invalid task type.
			\|-
	!CvCity::chooseProduction()		!CvCity::chooseProduction()
	\|UnitTypes eTrainUnit, BuildingTypes eConstructBuilding, ProjectTypes eCreateProject, bool bFinish, bool bFront		\|UnitTypes eTrainUnit, BuildingTypes eConstructBuilding, ProjectTypes eCreateProject, bool bFinish, bool bFront
	\|Void		\|Void
	\|Creates the pop-up for the human player to choose the next construction project that the city will have, and fills it with the recommended unit, or recommended building, or the recommended project. This function is only used for the human player.		\|Creates the pop-up for the human player to choose the next construction project that the city will have, and fills it with the recommended unit, or recommended building, or the recommended project. This function is only used for the human player.
			\|-
	!CvCity::getCityPlotIndex()		!CvCity::getCityPlotIndex()
	\|CvPlot* pPlot		\|CvPlot* pPlot
	\|Int		\|Int
	\|Returns the index number of the plot given.		\|Returns the index number of the plot given.
			\|-
	!CvCity::getCityIndexPlot()		!CvCity::getCityIndexPlot()
	\|int iIndex		\|int iIndex

Afforess at 17:39, 23 December 2009

2009-12-23T17:39:42Z

@@ Line 60: / Line 60: @@
 |Called when the city is selected in-game
 |-
-!dCvCity::canBeSelected()
+!CvCity::canBeSelected()
 |None
 |Boolean
 |Called to see if the active team member can select the city in question or not.
 |}
 {{Civ4_SDK_Files}}

TC01: Formatting

2009-12-23T14:59:44Z

Formatting

← Older revision		Revision as of 14:59, 23 December 2009
Line 1:		Line 1:
	The CvCity controls everything that occurs in each city in the game. Everything from Religion spread, Meltdowns, and city growth are controlled here.		The '''CvCity''' file controls everything that occurs in each city in the game. Everything from Religion spread, Meltdowns, and city growth are controlled here.

	The SDK files are written in the C++ programming language. They can be edited in a text editor such as notepad or in a programming editor like Microsoft's Visual Studio.		The SDK files are written in the C++ programming language. They can be edited in a text editor such as notepad or in a programming editor like Microsoft's Visual Studio.

TC01: There was already an incomplete notice at the top of the page...

2009-12-23T14:58:53Z

There was already an incomplete notice at the top of the page...

← Older revision		Revision as of 14:58, 23 December 2009
Line 66:		Line 66:
	\|}		\|}

	~~(Note: this file is incomplete. I will finish it at a later date [[User:Afforess\|Afforess]])~~		{{Civ4_SDK_Files}}

Afforess: Created page with 'The CvCity controls everything that occurs in each city in the game. Everything from Religion spread, Meltdowns, and city growth are controlled here. The SDK files are written i...'

2009-12-23T06:59:41Z

Created page with 'The CvCity controls everything that occurs in each city in the game. Everything from Religion spread, Meltdowns, and city growth are controlled here. The SDK files are written i...'

New page

The CvCity controls everything that occurs in each city in the game. Everything from Religion spread, Meltdowns, and city growth are controlled here.

The SDK files are written in the C++ programming language. They can be edited in a text editor such as notepad or in a programming editor like Microsoft's Visual Studio.

<font color=red>This page is missing information. Do not remove this notice until it is complete.</font>

==Functions==

Below is a list of all the functions in the file. Each function has a quick description attached to it. Note that there are comments strewn throughout some of these files, direct from the developers in order to aid the potential modders. All these functions are in the class CvCity.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Return Type
! style="background:#efefef;" | Description
|-
!CvCity::CvCity()
|None
|Void
|Initializes and creates references for the arrays for each city ID
|-
!CvCity::~CvCity()
|None
|Void
|Clears the arrays of all data and size
|-
!CvCity::init()
|int iID, PlayerTypes eOwner, int iX, int iY, bool bBumpUnits, bool bUpdatePlotGroups
|Void
|Begins the initial city setup, finds the plot the city is located on, updates the city's culture, line of sight, destroys any features the city is built on top of, adds a road underneath the city, adds any initial free buildings, etc...
|-
!CvCity::uninit()
|None
|Void
|Clears all the arrays of size and data, for when the game is shutting down, or the city is destroyed.
|-
!CvCity::reset()
|int iID, PlayerTypes eOwner, int iX, int iY, bool bConstructorCall
|Void
|Initializes all variables and arrays to their default value (usually 0 or -1)
|-
!CvCity::setupGraphical()
|None
|Void
|Sets up the graphical display for the city
|-
!CvCity::kill
|bool bUpdatePlotGroups
|Void
|Destroys the city, called when the city is razed.
|-
!CvCity::doTurn()
|None
|Void
|Called each turn by CvGame. Does all of the standard actions a city experiences, growth, religion spread, Great People, Production... etc..
|-
!CvCity::isCitySelected()
|None
|Boolean
|Called when the city is selected in-game
|-
!dCvCity::canBeSelected()
|None
|Boolean
|Called to see if the active team member can select the city in question or not.
|}

(Note: this file is incomplete. I will finish it at a later date [[User:Afforess|Afforess]])