Civilization IV Python Documentation

CyMap

Method Resolution Order

1. CyMap
2. Boost.Python.instance
3. __builtin__.object

Methods defined in this class

• __init__(...)
• calculatePathDistance(...) - finds the shortest passable path between two CyPlots and returns its length, or returns -1 if no such path exists. Note: the path must be all-land or all-water
• erasePlots(...) - () - erases the plots
• findBiggestArea(...) - CyArea* ()
• findCity(...) - CyCity* (int iX, int iY, int (PlayerTypes) eOwner = NO_PLAYER, int (TeamTypes) eTeam = NO_TEAM, bool bSameArea = true, bool bCoastalOnly = false, int (TeamTypes) eTeamAtWarWith = NO_TEAM, int (DirectionTypes) eDirection = NO_DIRECTION, CvCity* pSkipCity = NULL) - finds city
• findSelectionGroup(...) - CvSelectionGroup* (int iX, int iY, int /*PlayerTypes*/ eOwner, bool bReadyToSelect, bool bWorkers)
• findWater(...) - bool (CyPlot* pPlot, int iRange, bool bFreshWater)
• getArea(...) - CyArea (iID) - get CyArea at iID
• getBottomLatitude(...) - int () - bottom latitude (usually -90)
• getClimate(...) - ClimateTypes () - climate of the world
• getCustomMapOption(...) - CustomMapOptionTypes () - user defined map setting at this option id
• getGridHeight(...) - int () - the height of the map, in plots
• getGridWidth(...) - int () - the width of the map, in plots
• getIndexAfterLastArea(...) - int () - index for handling NULL areas
• getLandPlots(...) - int () - total land plots
• getMapFractalFlags(...) - int ()
• getNextRiverID(...) - int ()
• getNumAreas(...) - int () - total areas
• getNumBonuses(...) - int () - total bonuses
• getNumBonusesOnLand(...) - int () - total bonuses on land plots
• getNumCustomMapOptions(...) - int () - number of custom map settings
• getNumLandAreas(...) - int () - total land areas
• getOwnedPlots(...) - int () - total owned plots
• getSeaLevel(...) - SeaLevelTypes () - sealevel of the world
• getTopLatitude(...) - int () - top latitude (usually 90)
• getWorldSize(...) - WorldSizeTypes () - size of the world
• incrementNextRiverID(...) - void ()
• isNone(...) - bool () - valid CyMap() interface
• isPlot(...) - bool (iX,iY) - is (iX, iY) a valid plot?
• isWrapX(...) - bool () - whether the map wraps in the X axis
• isWrapY(...) - bool () - whether the map wraps in the Y axis
• numPlots(...) - int () - total plots in the map
• plot(...) - CyPlot (iX,iY) - get CyPlot at (iX,iY)
• plotByIndex(...) - CyPlot (iIndex) - get a plot by its Index
• plotNum(...) - int (iX,iY) - the index for a given plot
• plotX(...) - int (iIndex) - given the index of a plot, returns its X coordinate
• plotY(...) - int (iIndex) - given the index of a plot, returns its Y coordinate
• pointToPlot(...)
• rebuild(...) - used to initialize the map during WorldBuilder load
• recalculateAreas(...) - void () - Recalculates the areaID for each plot. Should be preceded by CyMap.setPlotTypes(...)
• regenerateGameElements(...) - used to regenerate everything but the terrain and height maps
• revealPlots(...) - void (int /*TeamTypes*/ eTeam, bool bTerrainOnly) - reveals the plots to eTeam
• sPlot(...) - CyPlot (iX,iY) - static - get CyPlot at (iX,iY)
• sPlotByIndex(...) - CyPlot (iIndex) - static - get plot by iIndex
• setAllPlotTypes(...) - void (int /*PlotTypes*/ ePlotType) - sets all plots to ePlotType
• syncRandPlot(...) - CyPlot* (iFlags,iArea,iMinUnitDistance,iTimeout) - random plot based on conditions
• updateFog(...) - void ()
• updateMinOriginalStartDist(...) - void (CyArea* pArea)
• updateMinimapColor(...) - void ()
• updateVisibility(...) - () - updates the plots visibility

Other Attributes

• __instance_size__ = 12

Inherited Attributes

• __dict__ = <dictproxy object>
• __new__ = <built-in method __new__ of Boost.Python.class object>
• T.__new__(S, ...) -> a new object with type S, a subtype of T
• __weakref__ = <member '__weakref__' of 'Boost.Python.instance' objects...