PythonCallbackDefines

The PythonCallbackDefines.xml file was added in the Beyond the Sword expansion to disable some unnecessary callbacks. A callback is a python function called from the SDK, and some callbacks were called often but did not actually do anything. This file allows you to disable or enable the callbacks listed in it.

All tags must be opened and closed; the first is the "open", the second the "close" tag. If nothing goes inside a "list tag", then it should just be the opening tag with a "/" before the closing bracket. The following tables contain all available tags, as well as their purpose and accepted values.

Tags

Headers

These tags typically bracket other tags, sometimes the entire file, and are generally used to specify more than one piece of data.

Tag Name	Description
Civ4Defines	Begins and ends the file. Everything must go between these two tags
Define	Begins and ends an individual python callback define

Text

Tag Name	Description
DefineName	The python callback that is being defined in each entry

Integers

All of these tags have a numerical value. Though it sometimes can be negative, it usually is not.

Tag Name	Description
iDefineIntValue	Defines whether the game will use the callback, acts like a boolean

Callbacks Disabled

All of the callbacks listed below are disabled in Beyond the Sword

Calllback Name	Python File
cannotFoundCity	CvGameUtils
canFoundCitiesOnWater	CvGameUtils
isPlayerResearch	CvGameUtils
canResearch	CvGameUtils
cannotDoCivic	CvGameUtils
canDoCivic	CvGameUtils
cannotConstruct	CvGameUtils
canConstruct	CvGameUtils
canDeclareWar	CvGameUtils
cannotResearch	CvGameUtils
getUnitCostMod	CvGameUtils
getBuildingCostMod	CvGameUtils
getCityFoundValue	CvGameUtils
getBuildingCostMod	CvGameUtils
cannotHandleAction	CvGameUtils
canBuild	CvGameUtils
cannotTrain	CvGameUtils
canTrain	CvGameUtils
unitCannotMoveInto	CvGameUtils
getBuildingCostMod	CvGameUtils
cannotSpreadReligion	CvGameUtils
finishText	Unknown
onUnitSetXY	CvEventManager
onUnitSelected	CvEventManager
onUnitSelected	CvEventManager
onUpdate	CvEventManager
onUnitCreated	CvEventManager
onUnitLost	CvEventManager

Example

In the following example of code, please note that there is a specific order of all of the tags. You must list the tags in this order for the game to properly interpret your file.

 <Define>
  <DefineName>USE_CAN_TRAIN_CALLBACK</DefineName>
  <iDefineIntVal>0</iDefineIntVal>
 </Define>

Civ4 XML Files GlobalDefines • GlobalDefinesAlt • GlobalTypes • PythonCallbackDefines Art: Civ4ArtDefines_Bonus • Civ4ArtDefines_Building • Civ4ArtDefines_Civilization • Civ4ArtDefines_Feature • Civ4ArtDefines_Improvement • Civ4ArtDefines_Interface • Civ4ArtDefines_Leaderhead • Civ4ArtDefines_Misc • Civ4ArtDefines_Movie • Civ4ArtDefines_Terrain • Civ4ArtDefines_Unit • Civ4MainMenus • Civ4RiverModelInfos • Civ4RouteModelInfos Audio; Buildings: Audio2DScripts • Audio3DScripts • AudioDefines • AudioSoundscapeScripts • Civ4BuildingClassInfos • Civ4BuildingInfos • Civ4CityLSystem • Civ4PlotLSystem • Civ4SpecialBuildingInfos BasicInfos: Civ4AttitudeInfos • Civ4BasicInfos • Civ4CalendarInfos • Civ4CityTabInfos • Civ4DenialInfos • Civ4DomainInfos • Civ4InvisibleInfos • Civ4MemoryInfos • Civ4MonthInfos • Civ4NewConceptInfos • Civ4SeasonInfos • Civ4UnitAIInfos • Civ4UnitCombatInfos Civilizations; Events: Civ4CivilizationInfos • Civ4LeaderHeadInfos • Civ4TraitInfos • Civ4UnitArtStyleTypeInfos • Civ4EventInfos • Civ4EventTriggerInfos GameInfo: Civ4CivicInfos • Civ4CivicOptionInfos • Civ4ClimateInfo • Civ4CommerceInfo • Civ4CorporationInfo • Civ4CultureLevelInfo • Civ4CursorInfo • Civ4DiplomacyInfos • Civ4EmphasizeInfos • Civ4EspionageMissionInfo • Civ4EraInfos • Civ4ForceControlInfos • Civ4GameOptionInfos • Civ4GameSpeedInfo • Civ4GoodyInfo • Civ4GraphicOptionInfos • Civ4HandicapInfo • Civ4Hints • Civ4MPOptionInfos • Civ4PlayerOptionInfos • Civ4ProcessInfo • Civ4ReligionInfo • Civ4SeaLevelInfo • Civ4SpecialistInfos • Civ4TurnTimerInfo • Civ4UpKeepInfo • Civ4VictoryInfo • Civ4VoteInfo • Civ4VoteSourceInfos • Civ4WorldInfo Interface: Civ4AdvisorInfos • Civ4CameraInfos • Civ4ColorVals • Civ4InterfaceModeInfos • Civ4PlayerColorInfos • Civ4SlideShowInfos • Civ4SlideShowRandomInfos • Civ4SpaceShipInfos • Civ4ThroneRoomeInfos • Civ4ThroneRoomCameraInfos • Civ4ThroneRoomStyleInfos • Civ4WorldPickerInfos Misc: Civ4AttachableInfos • Civ4CameraOverlayInfos • Civ4DetailManager • Civ4EffectInfos • Civ4QuestInfos • Civ4RiverInfos • Civ4RouteInfos • Civ4TerrainPlainInfos • Civ4TutorialInfos • Civ4WaterPlaneInfos Technologies: Civ4TechInfos Terrain: Civ4BonusClassInfos • Civ4BonusInfos • Civ4FeatureInfos • Civ4ImprovementInfos • Civ4SymbolMeshPaths • Civ4TerrainInfos • Civ4TerrainSettings • Civ4YieldInfos Units: Civ4AnimationInfos • Civ4AnimationPathInfos • Civ4AutomateInfos • Civ4BuildInfos • Civ4CommandInfos • Civ4ControlInfos • Civ4EntityEventInfos • Civ4FormationInfos • Civ4MissionInfos • Civ4PromotionInfos • Civ4SpecialUnitInfos • Civ4UnitClassInfos • Civ4UnitInfos Schemas: Civ4GlobalDefinesSchema • Civ4GlobalTypesSchema • Civ4ArtDefinesSchema • AudioDefinesSchema • AudioScriptSchema • Civ4BasicInfoSchema • Civ4BuildingSchema • Civ4LSystemSchema • Civ4CivilizationSchema • Civ4EventSchema • Civ4GameInfoSchema • Civ4InterfaceSchema • Civ4MiscSchema • Civ4TutorialSchema • Civ4DetailManagerSchema • Civ4TechnologiesSchema • Civ4TerrainSchema • Civ4FormationSchema • Civ4UnitSchema Italics: Beyond the Sword only