Civilization Modding Wiki - User contributions [en]

How to Install the SDK

2011-07-01T20:11:10Z

TC01: Revisions for the new makefile (well, I say "new", but it's been out for quite some time now)

These instructions were originally compiled by [http://forums.civfanatics.com/downloads.php?do=file&id=10018 Refar] for Visual Studio 2005, and have since been slightly modified for a newer version of the Makefile. They will also work with Visual Studio 2008 and 2010. They assume the modder is compiling the Beyond the Sword (BTS) DLL.

Once you have the SDK installed, you'll probably want to look at Xienwof's [http://forums.civfanatics.com/showthread.php?t=314201 An Idiot's Guide to Editing the DLL] to get started with editing the SDK.

==Installing the Tools==
* Download and install [http://kael.civfanatics.net/files/VCToolkitSetup.exe Microsoft Visual C++ Toolkit 2003]
* Download the following three library files and put them in this folder: C:\Program Files\Microsoft Visual C++ Toolkit 2003\lib
** [http://kael.civfanatics.net/files/msvcrt.lib msvcrt.lib]
** [http://kael.civfanatics.net/files/msvcrtd.lib msvcrtd.lib]
** [http://kael.civfanatics.net/files/msvcprt.lib msvcprt.lib]
* Download and install [http://msdn.microsoft.com/vstudio/express/visualc/download/ Microsoft Visual C++ Express Edition]
* Download Makefile.7z from [http://forums.civfanatics.com/showthread.php?t=370861 this forum thread] and unzip it. You don't need to do anything with it yet.

* Download and install the [http://kael.civfanatics.net/files/PSDK-x86.exe Microsoft Platform SDK]

==Preparing the Working Folder==
Compiling a Civilization 4 DLL requires you to use the BtS source files as a base. To begin with locate the CvGameCoreDLL folder; it can be found in your main Beyond the Sword folder (if it is not there, you need to re-install your copy of BtS). Copy this folder to a working directory so that you maintain the original BtS source files in their original location, and have a separate development directory to work from. It is highly recommended that you first compile a clean BtS DLL using only the source files in the CvGameCoreDLL folder before editing the source, or merging in source from other mods.

* Remember: make a copy of the CvGameCoreDLL folder to work with (including its subfolders) and put this copy in a location where you want to keep your working files. '''From now on everything said refers to the working copy of the files. ''Don't ever modify the original files – you might need them''.'''
* Delete the files CvGameCoreDLL.vcproj and CvGameCoreDLL.rc. ''If you followed the instructions so far (i.e. are using a clean copy of the SDK files released with a patched version of BTS) these 2 are all you need to delete. If however your sources came with a mod or were edited with other programs before, there might be a few more files to get rid of. These might be: CvGameCoreDLL.vcproj.vspcc, CvGameCoreDLL.ncb, *.sln, and perhaps others. The only files you need are: All *.h files, all *.cpp files, all (2) *.inl files and everything in the both subfolders (You don’t need to touch the subfolders at all).''
* Put the makefile from Makefile.7z into your working folder. The Makefile should work for all versions of Civ, including Colonization, with no modifications.
* Open the Makefile in your preferred editor. You can use the freshly installed Visual Studio IDE, or something else if you prefer. ''Windows Notepad does not work well here.''
* At the very top, change the line that begins with TOOLKIT to the path of your Visual C++ Toolkit 2003 directory.
* Change the line that begins with PSDK to the path of your Microsoft Platform SDK.
* Optionally, uncomment the line beginning with "YOURMOD" to point to your mod's directory. This will automatically copy the DLL to your mod's Assets directory.
* Save the Makefile and exit.

==Setting up the Project==
Launch the IDE. When setting up the project for the first time, do not open the existing project file in Visual C++ Express Edition. ''In fact, if you followed so far, there should be no project file right now. When compiling the same project for the second, 3rd,… time, you do not need to repeat all the steps – you can then load the project file you will create when you are through with this instructions.''

* Click -File- -New- -Project-. The "New Project" window will open.
* In the "Project types" box select –General-. In the "Templates" box select -Makefile Project-.
* In the "Name" box type "CvGameCoreDLL".
* In the "Location" box browse to the folder where you copied your CvGameCoreDLL folder to. This folder MUST be the last folder listed in this box. For example, if you copied CvGameCoreDLL to another folder like so: C:\MyModsFolder\CvGameCoreDLL , then the entry in the "Location" box must read: C:\MyModsFolder
* UNCHECK the box that says "Create Directory for Solution".
* Click -OK-. The "Makefile Application Wizard" will open. Click –Next-. Clear all the boxes. Click –Finish-.

You will see the IDE interface now, showing you a yet empty project. To avoid possible errors in VS 2010, we will first configure the compiler, and then add source files.

* Click -Project- -CvGameCoreDLL Properties-. The "CvGameCoreDLL Properties Pages" window will open.
* In the left-hand box under "Configuration Properties" select "NMake". ''Previous versions of the makefile required you to change the configuration properties here. The newer makefile does not require you to do so.''

* Select the "Release" configuration from the "Configuration:" drop-down-box in the top left corner.
* In the right-hand box under "General" it says "Build Command Line". Click the empty box to the right of it and type nmake Release.
* In the next line down, to the right of where it says "Rebuild All Command Line", click in the empty box and then click the button in the box at the right. The "Rebuild All Command Line" window will open. Type nmake Release_clean, and then directly below it on a second line, type nmake Release. Click -OK-.
* In the next line down, to the right of where it says "Clean Command Line", type nmake Release_clean.
* Select the "Debug" configuration from the "Configuration:" drop-down-box in the top left corner, and repeat the 3 steps above for Debug. '''Note the underscores in the clean command.'''

Close the configuration windows with –OK-. Now, we'll add the source files to the project.

* Click -Project- -Add Existing Item…-. The "Add Existing Item – CvGameCoreDLL" window will open. This folder will contain all of the source code files, the Boost-1.32.0 folder, and the Python24 folder. Select everything (use Ctrl-A) and click -Add-. ''You only want to add: all *.h files, all (2) *.inl files, all *.cpp files and the both subfolders. If you followed the instructions so far (i.e. deleted all unneeded files) CTRL+A will give you exactly this. If you – for whatever reason – kept some of the unneeded files, you need to deselect them manually.''

Save your Project. It will create a new CvGameCoreDLL.vcproj file, which you can open later. It will have your settings saved.

You are done now. For a test you should compile the unchanged code under both Configurations (It takes a bit of time depending on your Hardware), to make sure everything does work as expected. You should use Build->Build Solution to do that.

==Compiling the Command Prompt==
You can also compile the project by invoking nmake from the command prompt. This might be useful if you repeatedly fail to get the configurations right, or if you want to quickly compile a 3rd party project without going through all the configurations steps. (You still need to install all the tools).

Run the Visual Studio IDE. Do not load a project (or do so – it doesn’t matter here). From menu select Tools->Visual Studio Command Prompt. A console window will open. It has all the needed environment variables set properly (as opposed the usual command prompt Windows will give you).

Navigate to the folder where your project is (Using cd …). Type: nmake /f Makefile Final_Release to compile the final Release configuration. You can use another target instead, nmake /f Makefile Clean_Debug for example.

==Compiling a Single Source File==
Compiling a single file is much faster than building a full project. It does of course give you nothing actually run-able, but might still be useful when searching for code mistakes.

I did not find a way to do it from the IDE interface, but you can compile single files by invoking nmake from the console – as described above - and calling for intermediate targets.

nmake Debug/CvUnit.obj
nmake Final_Release/CvUnit.obj
for example will compile just CvUnit.cpp in the Debug or Final_Release configuration.

==Running the Debugger==
After compiling your project in the Debug configuration, you can run the game using the Debug-able CvGameCoreDLL.dll. It is a good deal bigger than your normal DLL and there is also a big CVGameCoreDLL.pdb file coming with it, which will contain information the debugger might need.

Start the IDE; load your project as switch to the debug configuration. Start the Game with the Debug-DLL.

I recommend running Civ4 Windowed; otherwise you might not be able to access the IDE after the game freezes on a breakpoint.

Choose Debug->Attach To Process… from the menu. Choose the Civ4 Process. You might need to re-enable some local Services – for inexplicable reasons on XP debugging with Visual Studio Express does require Terminal Services to be running. In the debugger output window you will see the List of Libraries loaded in the Process. Most of them will say "No Symbols Loaded". This is fine. We are going to debug our CvGameCoreDLL.dll, so this is the only one we need symbols for.

Now you can debug. For testing set a Break-point on some function. CvGame::DoHolyCity() works fine – it is called once per turn. When the Game reaches the Breakpoint it will freeze waiting for your debugging action.

Another good test is a break-point at CvUnit::GetExperience(). When the game stops there, you can access the memory of the Unit instance that called the method and change its Experience level. The unit should be promoted on the next turn.

Civ4 Modding Tutorials

2010-02-25T22:13:43Z

TC01: /* General Tutorials */ New tutorial by me

== General Tutorials ==
* [http://forums.civfanatics.com/showthread.php?t=262402 How To Create a Mod (Video Demo)]
* [http://forums.civfanatics.com/showthread.php?t=173061 How To Design a Mod]
* [http://forums.civfanatics.com/showthread.php?t=187699 How To Get Your Mod To Load Faster]
* [http://forums.civfanatics.com/showthread.php?t=229557 A Modder's Guide to Beyond the Sword]
* [http://forums.civfanatics.com/showthread.php?t=168876 How To Add Custom Sounds]
* [http://forums.civfanatics.com/showthread.php?t=161442 How To Change the Movies]
* [http://forums.civfanatics.com/showthread.php?t=191978 How To Add an Intro Movie]
* [http://forums.civfanatics.com/showthread.php?t=230567 Guide to Event Modding]
* [http://forums.civfanatics.com/showthread.php?t=236727 Random Events List] (Reference)
* [http://forums.civfanatics.com/showthread.php?t=175005 How To Isolate Crashes]
* [http://forums.civfanatics.com/showthread.php?t=268759 Non-Random Events in Beyond the Sword]
* [http://forums.civfanatics.com/showthread.php?p=7233336 Multiplayer Compatability Guide]
* [http://forums.civfanatics.com/showthread.php?t=132476 The Modder's Guide to Civ4]
* [http://forums.civfanatics.com/showthread.php?t=331321 How to Merge Mods]
* [http://forums.civfanatics.com/showthread.php?t=340885 Inno Install Script Tutorial]
* [http://forums.civfanatics.com/showthread.php?t=353005 The Map Making Process]
* [http://forums.civfanatics.com/showthread.php?t=355021 Public and Private Maps]

== Graphics Tutorials ==
* [http://forums.civfanatics.com/showthread.php?t=183568 Skinning For Beginners]
* [http://forums.civfanatics.com/showthread.php?t=153584 How To Skin and Add Resources and Improvements]
* [http://forums.civfanatics.com/showthread.php?p=5339402#post5339402 Create Noshader Units from Units With Shaders]
* [http://forums.civfanatics.com/showthread.php?t=167335 How To Import a Custom Model (Blender)]
* NifViewer Tutorial: [http://forums.civfanatics.com/showthread.php?t=163585 Part 1], [http://forums.civfanatics.com/showthread.php?t=165689 Part 2], [http://forums.civfanatics.com/showthread.php?t=176106 Part 3]
* [http://forums.civfanatics.com/showthread.php?t=214207 3ds Max Importing/Exporting]
* [http://forums.civfanatics.com/showthread.php?t=179747 Merge Animations With Your Models]
* [http://forums.civfanatics.com/showthread.php?t=184327 How to Create Units with 3ds Max]
* [http://forums.civfanatics.com/showthread.php?t=182779 3ds Max Unit Creation Guide]
* [http://forums.civfanatics.com/showthread.php?t=177468 Import NIF File into 3ds Max]
* [http://forums.civfanatics.com/showthread.php?t=162118 Getting Your Units Into Civilization IV]
* [http://forums.civfanatics.com/showthread.php?t=171934 How To Make .dds Textures for 3ds Max Models]
* [http://forums.civfanatics.com/showthread.php?t=240956 Damage States for Custom Units (3ds Max)]
* [http://forums.civfanatics.com/showthread.php?t=181119 How To Edit GameFont.tga]
* [http://forums.civfanatics.com/showthread.php?t=278946 How To Fix GameFont.tga]
* [http://forums.civfanatics.com/showthread.php?t=150275 How To Create Non-Distorted Flags]
* [http://forums.civfanatics.com/showthread.php?t=237832 How To Make Units Use Different Effects]
* [http://forums.civfanatics.com/showthread.php?t=183742 How To Import/Modify/Export Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=230458 How To Create Shaded Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=267233 How To Create Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=304100 Working with GameFont.tga in Photoshop]
* [http://forums.civfanatics.com/showthread.php?t=305606 Nifskope]
* [http://forums.civfanatics.com/showthread.php?t=312613 Modifying the Visibility of Weapons/Unit Animations]
* [http://forums.civfanatics.com/showthread.php?t=271331 Making Minor Changes to Unit Animation without 3DS Max]
* [http://forums.civfanatics.com/showthread.php?t=325606 Adding Action Sounds to Unit Animations]
* [http://forums.civfanatics.com/showthread.php?t=332014 The Cheat's Guide to Making Units]

== Tutorials Involving XML ==
* For tutorials on how to use XML, see [[Civ4 XML Reference|the XML section]].
* [http://forums.civfanatics.com/showthread.php?t=148507 How To Add a Civilization]
* [http://forums.civfanatics.com/showthread.php?t=139721 How To Add New Units]
* [http://forums.civfanatics.com/showthread.php?t=176460 Adding Units to Civilizations in 6 Easy Steps]
* [http://forums.civfanatics.com/showthread.php?t=188708 How To Add a New Building]
* [http://forums.civfanatics.com/showthread.php?t=138779 How To Add a Civic]
* [http://forums.civfanatics.com/showthread.php?t=304685 How To Add Diplomacy Text to a Leaderhead]
* [http://forums.civfanatics.com/showthread.php?t=234970 How To Add a Civ/Unit/Building in BtS (Modular XML Loading)]
* [http://forums.civfanatics.com/showthread.php?t=348539 How To Create a Civilization in BtS]

== Tutorials Involving Python ==
* For tutorials on how to use Python, see [[Civ4 Python|the Python section]].
* [http://forums.civfanatics.com/showthread.php?t=183126 How To Add Popups]
* [http://forums.civfanatics.com/showthread.php?t=142169 How To Save and Load Data in Your Mod]

== Tutorials Involving the SDK ==
* For tutorials on how to use the SDK, see [[Civ4 SDK|the SDK section]].
* [http://forums.civfanatics.com/showthread.php?t=166935 Adding New XML Values]
* [http://forums.civfanatics.com/showthread.php?t=183339 Adding New Missions For Units]
* [[How To Change the Maximum Number of Players]]

[[Category:Civilization 4]]

CvCity

2009-12-23T14:59:44Z

TC01: Formatting

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.

<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.
|}

{{Civ4_SDK_Files}}

CvCity

2009-12-23T14:58:53Z

TC01: There was already an incomplete notice at the top of the 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.
|}

{{Civ4_SDK_Files}}

Civ4 Modding Tutorials

2009-12-11T11:53:14Z

TC01: Restoring older article

== General Tutorials ==
* [http://forums.civfanatics.com/showthread.php?t=262402 How To Create a Mod (Video Demo)]
* [http://forums.civfanatics.com/showthread.php?t=173061 How To Design a Mod]
* [http://forums.civfanatics.com/showthread.php?t=187699 How To Get Your Mod To Load Faster]
* [http://forums.civfanatics.com/showthread.php?t=229557 A Modder's Guide to Beyond the Sword]
* [http://forums.civfanatics.com/showthread.php?t=168876 How To Add Custom Sounds]
* [http://forums.civfanatics.com/showthread.php?t=161442 How To Change the Movies]
* [http://forums.civfanatics.com/showthread.php?t=191978 How To Add an Intro Movie]
* [http://forums.civfanatics.com/showthread.php?t=230567 Guide to Event Modding]
* [http://forums.civfanatics.com/showthread.php?t=236727 Random Events List] (Reference)
* [http://forums.civfanatics.com/showthread.php?t=175005 How To Isolate Crashes]
* [http://forums.civfanatics.com/showthread.php?t=268759 Non-Random Events in Beyond the Sword]
* [http://forums.civfanatics.com/showthread.php?p=7233336 Multiplayer Compatability Guide]
* [http://forums.civfanatics.com/showthread.php?t=132476 The Modder's Guide to Civ4]
* [http://forums.civfanatics.com/showthread.php?t=331321 How to Merge Mods]
* [http://forums.civfanatics.com/showthread.php?t=340885 Inno Install Script Tutorial]

== Graphics Tutorials ==
* [http://forums.civfanatics.com/showthread.php?t=183568 Skinning For Beginners]
* [http://forums.civfanatics.com/showthread.php?t=153584 How To Skin and Add Resources and Improvements]
* [http://forums.civfanatics.com/showthread.php?p=5339402#post5339402 Create Noshader Units from Units With Shaders]
* [http://forums.civfanatics.com/showthread.php?t=167335 How To Import a Custom Model (Blender)]
* NifViewer Tutorial: [http://forums.civfanatics.com/showthread.php?t=163585 Part 1], [http://forums.civfanatics.com/showthread.php?t=165689 Part 2], [http://forums.civfanatics.com/showthread.php?t=176106 Part 3]
* [http://forums.civfanatics.com/showthread.php?t=214207 3ds Max Importing/Exporting]
* [http://forums.civfanatics.com/showthread.php?t=179747 Merge Animations With Your Models]
* [http://forums.civfanatics.com/showthread.php?t=184327 How to Create Units with 3ds Max]
* [http://forums.civfanatics.com/showthread.php?t=182779 3ds Max Unit Creation Guide]
* [http://forums.civfanatics.com/showthread.php?t=177468 Import NIF File into 3ds Max]
* [http://forums.civfanatics.com/showthread.php?t=162118 Getting Your Units Into Civilization IV]
* [http://forums.civfanatics.com/showthread.php?t=171934 How To Make .dds Textures for 3ds Max Models]
* [http://forums.civfanatics.com/showthread.php?t=240956 Damage States for Custom Units (3ds Max)]
* [http://forums.civfanatics.com/showthread.php?t=181119 How To Edit GameFont.tga]
* [http://forums.civfanatics.com/showthread.php?t=278946 How To Fix GameFont.tga]
* [http://forums.civfanatics.com/showthread.php?t=150275 How To Create Non-Distorted Flags]
* [http://forums.civfanatics.com/showthread.php?t=237832 How To Make Units Use Different Effects]
* [http://forums.civfanatics.com/showthread.php?t=183742 How To Import/Modify/Export Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=230458 How To Create Shaded Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=267233 How To Create Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=304100 Working with GameFont.tga in Photoshop]
* [http://forums.civfanatics.com/showthread.php?t=305606 Nifskope]
* [http://forums.civfanatics.com/showthread.php?t=312613 Modifying the Visibility of Weapons/Unit Animations]
* [http://forums.civfanatics.com/showthread.php?t=271331 Making Minor Changes to Unit Animation without 3DS Max]
* [http://forums.civfanatics.com/showthread.php?t=325606 Adding Action Sounds to Unit Animations]
* [http://forums.civfanatics.com/showthread.php?t=332014 The Cheat's Guide to Making Units]

== Tutorials Involving XML ==
* For tutorials on how to use XML, see [[Civ4 XML Reference|the XML section]].
* [http://forums.civfanatics.com/showthread.php?t=148507 How To Add a Civilization]
* [http://forums.civfanatics.com/showthread.php?t=139721 How To Add New Units]
* [http://forums.civfanatics.com/showthread.php?t=176460 Adding Units to Civilizations in 6 Easy Steps]
* [http://forums.civfanatics.com/showthread.php?t=188708 How To Add a New Building]
* [http://forums.civfanatics.com/showthread.php?t=138779 How To Add a Civic]
* [http://forums.civfanatics.com/showthread.php?t=304685 How To Add Diplomacy Text to a Leaderhead]
* [http://forums.civfanatics.com/showthread.php?t=234970 How To Add a Civ/Unit/Building in BtS (Modular XML Loading)]

== Tutorials Involving Python ==
* For tutorials on how to use Python, see [[Civ4 Python|the Python section]].
* [http://forums.civfanatics.com/showthread.php?t=183126 How To Add Popups]
* [http://forums.civfanatics.com/showthread.php?t=142169 How To Save and Load Data in Your Mod]

== Tutorials Involving the SDK ==
* For tutorials on how to use the SDK, see [[Civ4 SDK|the SDK section]].
* [http://forums.civfanatics.com/showthread.php?t=166935 Adding New XML Values]
* [http://forums.civfanatics.com/showthread.php?t=183339 Adding New Missions For Units]
* [[How To Change the Maximum Number of Players]]

[[Category:Civilization 4]]

Template:Civ4 XML Files

2009-12-11T11:52:46Z

TC01: Restoring older article

<br clear="all" />
{| align="center" border="0" cellspacing="0" cellpadding="0" style="background: #dcdce7; border: 1px solid #dcdce7; border-radius: 20px; -moz-border-radius: 20px;"
|-
| style="background: #bebed1; border-radius: 20px; -moz-border-radius: 20px; padding: 2px;" |
{| class="toccolours" align="center" cellspacing="0" cellpadding="5" style="text-align: center; line-height: 19px; border: 3px solid #88a; border-radius: 20px; -moz-border-radius: 20px; padding: 0px;"
|-
|
{| border="0" cellspacing="0" cellpadding="0" style="background: transparent;"
|-
! colspan="2" style="padding-bottom: 1px; -moz-padding-start: 20px; -moz-padding-end: 20px;" | <div style="background: #ccf; border-radius: 15px 15px 0px 0px; -moz-border-radius: 15px 15px 0px 0px; padding: 2px 15px;">[[Civ4_XML_Reference|Civ4 XML Files]]</div>
|- style="font-size: 90%;"
! style="background: #ddf; border-radius-topleft: 10px; -moz-border-radius-topleft: 10px; padding: 2px 15px;" |
| style="background: #e6e6ff; border-radius-topright: 10px; -moz-border-radius-topright: 10px; padding: 2px 10px;" |
[[GlobalDefines]] • [[GlobalDefinesAlt]] • [[GlobalTypes]] • [[PythonCallbackDefines]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Art:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[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]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Audio; Buildings:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Audio2DScripts]] • [[Audio3DScripts]] • [[AudioDefines]] • [[AudioSoundscapeScripts]] • [[Civ4BuildingClassInfos]] • [[Civ4BuildingInfos]] • [[Civ4CityLSystem]] • [[Civ4PlotLSystem]] • [[Civ4SpecialBuildingInfos]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | BasicInfos:
| style="background: #e6e6ff; padding: 2px 10px;" |
''[[Civ4AttitudeInfos]]'' • [[Civ4BasicInfos]] • ''[[Civ4CalendarInfos]]'' • ''[[Civ4CityTabInfos]]'' • ''[[Civ4DenialInfos]]'' • ''[[Civ4DomainInfos]]'' • ''[[Civ4InvisibleInfos]]'' • ''[[Civ4MemoryInfos]]'' • ''[[Civ4MonthInfos]]'' • ''[[Civ4NewConceptInfos]]'' • ''[[Civ4SeasonInfos]]'' • ''[[Civ4UnitAIInfos]]'' • ''[[Civ4UnitCombatInfos]]''
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Civilizations; Events:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Civ4CivilizationInfos]] • [[Civ4LeaderHeadInfos]] • [[Civ4TraitInfos]] • [[Civ4UnitArtStyleTypeInfos]] • ''[[Civ4EventInfos]]'' • ''[[Civ4EventTriggerInfos]]''
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | GameInfo:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[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]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Interface:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Civ4AdvisorInfos]] • [[Civ4CameraInfos]] • [[Civ4ColorVals]] • [[Civ4InterfaceModeInfos]] • [[Civ4PlayerColorInfos]] • ''[[Civ4SlideShowRandomInfos]]'' • ''[[Civ4SpaceShipInfos]]'' • [[Civ4ThroneRoomeInfos]] • ''[[Civ4ThroneRoomCameraInfos]]'' • [[Civ4ThroneRoomStyleInfos]] • [[Civ4WorldPickerInfos]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Misc:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Civ4AttachableInfos]] • ''[[Civ4CameraOverlayInfos]]'' • [[Civ4DetailManager]] • [[Civ4EffectInfos]] • [[Civ4QuestInfos]] • [[Civ4RiverInfos]] • [[Civ4RouteInfos]] • ''[[Civ4TerrainPlainInfos]]'' • [[Civ4TutorialInfos]] • [[Civ4WaterPlaneInfos]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Terrain:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Civ4BonusClassInfos]] • [[Civ4BonusInfos]] • [[Civ4FeatureInfos]] • [[Civ4ImprovementInfos]] • [[Civ4SymbolMeshPaths]] • [[Civ4TerrainInfos]] • [[Civ4TerrainSettings]] • [[Civ4YieldInfos]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Units:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Civ4AnimationInfos]] • ''[[Civ4AnimationPathInfos]]'' • [[Civ4AutomateInfos]] • [[Civ4BuildInfos]] • [[Civ4CommandInfos]] • [[Civ4ControlInfos]] • ''[[Civ4EntityEventInfos]]'' • [[Civ4FormationInfos]] • [[Civ4MissionInfos]] • [[Civ4PromotionInfos]] • [[Civ4SpecialUnitInfos]] • [[Civ4UnitClassInfos]] • [[Civ4UnitInfos]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; padding: 2px 15px;" | Other:
| style="background: #e6e6ff; padding: 2px 10px;" |
[[Civ4TechInfos]] • [[Format_for_new_XML_pages|XML Page Format]]
|-
| colspan="2" height="1" |
|- style="font-size: 90%;"
! style="background: #ddf; border-radius-bottomleft: 10px; -moz-border-radius-bottomleft: 10px; padding: 2px 15px;" | [[Schema Files|Schemas]]:
| style="background: #e6e6ff; border-radius-bottomright: 10px; -moz-border-radius-bottomright: 0px; padding: 2px 10px;" |
[[Civ4GlobalDefinesSchema]] • [[Civ4GlobalTypesSchema]] • [[Civ4ArtDefinesSchema]] • [[AudioDefinesSchema]] • [[AudioScriptSchema]] • [[Civ4BasicInfoSchema]] • [[Civ4BuildingSchema]] • [[Civ4LSystemSchema]] • [[Civ4CivilizationSchema]] • ''[[Civ4EventSchema]]'' • [[Civ4GameInfoSchema]] • [[Civ4InterfaceSchema]] • [[Civ4MiscSchema]] • [[Civ4TutorialSchema]] • [[Civ4DetailManagerSchema]] • [[Civ4TechnologiesSchema]] • [[Civ4TerrainSchema]] • [[Civ4FormationSchema]] • [[Civ4UnitSchema]]
|- style="font-size: 90%;"
!
! colspan="1" style="padding-top: 1px; -moz-padding-start: 0px; -moz-padding-end: 0px;" | <div style="font-weight:normal;background: #e6e6ff; border-radius: 0px 0px 15px 15px; -moz-border-radius: 0px 0px 15px 15px; padding: 2px 15px;">''Italics: Beyond the Sword only''</div>
|}
|}
|} <includeonly>[[Category:Civ4 XML Files]]</includeonly><noinclude>Based on a template from [http://bulbapedia.bulbagarden.net Bulbapedia].[[Category:Reference templates]]</noinclude>

CvEventInterface

2009-12-09T22:16:50Z

TC01: Created page with 'The '''CvEventInterface''' file calls the event functions in the Event Manager. By editing this file, it becomes possible to create custom event managers. As w...'

The '''CvEventInterface''' file calls the event functions in the [[CvEventManager|Event Manager]]. By editing this file, it becomes possible to create custom event managers. As with all interface files, it should not be imported, the function names should not be changed, and the functions in this file should not be placed into a class.

The Python files are written in the python programming language. They can be edited in a text editor such as notepad or in a programming editor like Python's IDLE.

==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. These four functions are not in any class.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Description
|-
!def getEventManager
|(No paramaters)
|Gets the event manager file (normally CvEventManager)
|-
!def onEvent
|argsList
|Called when a gave event happens and calls the event manager
|-
!def applyEvent
|argsList(context, playerID, netUserData, popupReturn)
|Applies events from the event manager
|-
!def beginEvent
|context, argsList=-1
|Begins an event in the event manager
|-
|}

==Example==

This example is a quick idea of what you can do in this file. While the four functions themselves should not be altered, you can add a custom event manager to the game by editing the top of the file, above the functions.

import CvEventManager
from CvPythonExtensions import *

normalEventManager = CvEventManager.CvEventManager()

If you create and then import a "CvCustomEventManager" file and then make normalEventManager point to that instead, the game will not read CvEventManager as the event manager but instead your custom file, like so.

import CvEventManager
from CvPythonExtensions import *
<font color="red">import CvCustomEventManager</font color>

normalEventManager = <font color="red">CvCustomEventManager.CvCustomEventManager()</font color>

{{Civ4_Python_Files}}

CvEventManager

2009-12-09T21:22:27Z

TC01:

The '''CvEventManager''' file controls what happens during events that occur in the game. These aren't events like Beyond the Sword random events but rather events like a unit moving, a turn beginning, or a nuclear explosion occuring. Some of the functions in this file are disabled in Beyond the Sword with [[PythonCallbackDefines]].xml- for a list of which functions, see that page.

The Python files are written in the python programming language. They can be edited in a text editor such as notepad or in a programming editor like Python's IDLE.

<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 CvEventManager.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Description
|-
!def _init_()
|self
|Initializes variables in file
|-
!def handleEvent()
|self, argsList
|Event Manager entry point
|-
!def beginEvent()
|self, context, argsList=-1
|Begins an event
|-
!def applyEvent()
|self, argsList (context, playerID, netUserData, popupReturn)
|Applies the effects of an event
|-
!def reportEvent()
|self, entry, context, argsList
|Records an event to Events.log
|-
!def onKdbEvent()
|self, argsList (eventType, key, mx, my, px, py)
|Handles the pressing of a key
|-
!def onModNetMessage()
|self, argsList (iData1, iData2, iData3, iData4, iData5)
|Called whenever CyMessageControl().sendModNetMessage is called
|-
!def onInit()
|self, argsList
|Called whenever Civilization starts up
|-
!def onUpdate()
|self, argsList (fDeltaTime)
|Called every frame
|-
!def onWindowActivation()
|self, argsList (bActive)
|Called when the game window activates or deactivates
|-
!def onUnInit()
|self, argsList
|Called before Civ shuts down
|-
!def onPreSave()
|self, argsList
|Called before the game is saved
|-
!def onSaveGame()
|self, argsList
|Returns the name of the save game
|-
!def onLoadGame()
|self, argsList
|Called on the loading of the game
|-
!def onGameStart()
|self, argsList
|Called on the start of the game
|-
!def onGameEnd()
|self, argsList
|Called at the end of the game
|-
!def onBeginGameTurn()
|self, argsList (iGameTurn)
|Called at the beginning of the end of each turn
|-
!def onEndGameTurn()
|self, argsList (iGameTurn)
|Called at the end of the end of each turn
|-
!def onBeginPlayerTurn()
|self, argsList (iGameTurn, iPlayer)
|Called at the beginning of a player's turn
|-
!def onEndPlayerTurn()
|self, argsList (iGameTurn, iPlayer)
|Called at the end of a player's turn
|-
!def onEndTurnReady()
|self, argsList (iGameTurn)
|Called when the turn is ready to end
|-
!def onFirstContact()
|self, argsList (iTeamX, iHasMetTeamY)
|Called when one team meets another team
|-
!def onCombatResult()
|self, argsList (iWinner, iLoser)
|Called after combat
|-
!def onCombatLogCalc()
|self, argsList (genericArgs)
|Not sure
|-
!def onCombatLogHit()
|self, argsList (genericArgs)
|Not sure
|-
!def onImprovementBuilt()
|self, argsList (iImprovement, iX, iY)
|Called when an improvement is built
|-
!def onImprovementDestroyed()
|self, argsList (iImprovement, iOwner, iX, iY)
|Called when an improvement is destroyed
|-
!def onRouteBuilt()
|self, argsList (iRoute, iX, iY)
|Called when a route is built
|-
!def onPlotRevealed()
|self, argsList (pPlot, iTeam)
|Called when a plot is revealed to a team
|-
!def onPlotFeatureRemoved()
|self, argsList (pPlot, iFeatureType, pCity)
|Called when a feature is removed on a plot
|-
!def onPlotPicked()
|self, argsList (pPlot)
|Called when a plot is picked
|-
!def onNukeExplosion()
|self, argsList (pPlot, pNukeUnit)
|Called when a nuke explodes or a meltdown occurs
|-
!def onGotoPlotSet()
|self, argsList (pPlot, iPlayer)
|Not sure
|-
!def onBuildingBuilt()
|self, argsList (pCity, iBuildingType)
|Called when a building is built
|-
!def onProjectBuilt()
|self, argsList (pCity, iProjectType)
|Called when a project is completed
|-
!def onSelectionGroupPushMission()
|self, argsList (eOwner, eMission, iNumUnits, listUnitIDs)
|Called when a mission is pushed for a unit or group of units
|-
!def onUnitMove()
|self, argsList (pPlot, pUnit, pOldPlot)
|Called when a unit moves onto a new plot
|-
!def onUnitSetXY()
|self, argsList (pPlot, pUnit)
|Called when a unit's coords are set manually
|-
!def onUnitCreated()
|self, argsList (unit)
|Called when a unit is created
|-
!def onUnitBuilt()
|self, argsList (city, unit, player)
|Called when a unit is built in a city
|-
!def onUnitKilled()
|self, argsList (unit, iAttacker)
|Called when a unit is killed by another unit
|-
!def onUnitLost()
|self, argsList (unit)
|Called when a unit dies
|-
!def onUnitPromoted()
|self, argsList (pUnit, iPromotion)
|Called when a unit is promoted
|-
!def onUnitSelected()
|self, argsList (unit)
|Called when a unit is selected
|-
!def onUnitRename()
|self, argsList (unit)
|Called when a unit is renamed
|-
!def onUnitPillage()
|self, argsList(pUnit, iImprovement, iRoute, iOwner)
|Called when a unit pillages an improvement or route
|-
!def onUnitSpreadReligionAttempt()
|self, argsList(pUnit, iReligion, bSuccess)
|Called when a unit attempts to spread a religion to a city
|-
!def onUnitGifted()
|self, argsList(pUnit, iGiftingPlayer, pPlotLocation)
|Called when a unit is gifted from a player to another
|-
!def onUnitBuildImprovement()
|self, argsList(pUnit, iBuild, bFinished)
|Called when a unit begins to build an improvement
|-
!def onGoodyReceived()
|self, argsList(iPlayer, pPlot, pUnit, iGoodyType)
|Called when a unit gets something at a goody hut
|-
!def onGreatPersonBorn()
|self, argsList(pUnit, iPlayer, pCity)
|Called when a Great Person is born in a city
|-
!def onTechAcquired()
|self, argsList(iTechType, iTeam, iPlayer, bAnnounce)
|Called when a player acquires a tech
|-
!def onTechSelected()
|self, argsList(iTechType, iPlayer)
|Called when a player selects a tech to research
|-
!def onReligionFounded()
|self, argsList(iReligion, iFounder)
|Called when a player founds a religion
|-
!def onReligionSpread()
|self, argsList(iReligion, iOwner, pSpreadCity)
|Called when a religion spreads to a city
|-
!def onReligionRemove()
|self, argsList(iReligion, iOwner, pRemoveCity)
|Called when a religion is removed from a city
|-
!def onCorporationFounded()
|self, argsList(iCorporation, iFounder)
|Called when a player founds a corporation
|-
!def onCorporatationSpread()
|self, argsList(iCorporation, iOwner, pSpreadCity)
|Called when a corporation spreads to a city
|-
!def onCorporationRemove()
|self, argsList(iCorporation, iOwner, pRemoveCity)
|Called when a corporation is removed from a city
|-
!def onGoldenAge()
|self, argsList(iPlayer)
|Called when a player begins a golden age
|-
!def onEndGoldenAge()
|self, argsList(iPlayer)
|Called when a player ends a golden age
|-
!def onChangeWar()
|self, argsList(bIsWar, iTeam, iRivalTeam)
|Called when either war or peace is declared between two teams
|-
!def onChat()
|self, argsList(chatMessage)
|Called when a chat message is sent
|-
!def onSetPlayerAlive()
|self, argsList(iPlayerID, bNewValue)
|Called when a player's status is set to "alive"
|-
!def onPlayerChangeStateReligion
|self, argsList(iPlayer, iNewReligion, iOldReligion)
|Called when a player changes the state religion
|-
!def onPlayerGoldTrade
|self, argsList(iFromPlayer, iToPlayer, iGoldAmount)
|Called when a player trades gold with another player
|-
!def onCityBuilt
|self, argsList(city)
|Called when a player builds a city
|-
!def onCityRazed
|self, argsList(city, iPlayer)
|Called when a player razes a city
|-
!def onCityAcquired
|self, argsList(iPreviousOwner, iNewOwner, pCity, bConquest, bTrade)
|Called when a player acquires a city through any means
|-
!def onCityAcquiredAndKept
|self, argsList(iOwner, pCity)
|Called when a player acquires a city and keeps it
|-
!def onCityLost
|self, argsList(city, player)
|Called when a player loses a city
|-
!def onCultureExpansion
|self, argsList(pCity, iPlayer)
|Called when a city's culture expands
|-
!def onCityGrowth
|self, argsList(pCity, iPlayer)
|Called when a city grows
|-
!def onCityDoTurn
|self, argsList(pCity, iPlayer)
|Called every turn for every city
|-
!def onCityBuildingUnit
|self, argsList(pCity, iUnitType)
|Called when a city begins building a unit
|-
!def onCityBuildingBuilding
|self, argsList(pCity, iBuildingType)
|Called when a city begins building a building
|-
!def onCityRename
|self, argsList(pCity)
|Called when a city is renamed
|-
!def onCityHurry
|self, argsList(pCity, iHurryType)
|Called when a city hurries production
|-
!def onVictory
|self, argsList(iTeam, iVictory)
|Called when a team wins the game
|-
!def onVassalState
|self, argsList(iMaster, iVassal, bVassal)
|Called when a team is vassalized or gains independence
|-
!def onGameUpdate
|self, argsList(genericArgs[turnSlice])
|Called on every "game turn slice"
|-
!def onMouseEvent
|self, argsList(eventType, mx, my, px, py, interfaceConsumed, screens)
|Not sure
|-
!def _eventEventCityNameBegin
|self, city, bRename
|Creates a popup to name or rename a city
|-
!def _eventEventCityNameApply
|self, playerID, userData(iCityID, bRename), popupReturn
|Changes the name of a city
|-
!def _eventEditCityBegin
|self, argsList(px, py)
|Begins the editing of a city in Worldbuilder
|-
!def _eventEditCityApply
|self, playerID, userData, popupReturn
|The edit city event in Worldbuilder
|-
!def _eventPlaceObjectBegin
|self, argsList
|Begins the place object function in Worldbuilder
|-
!def _eventPlaceObjectApply
|self, playerID, userData, popupReturn
|The place object event in Worldbuilder
|-
!def _eventAwardTechsAndGoldBegin
|self, argsList
|An event that awards gold and technologies
|-
!def _eventAwardTechsAndGoldApply
|self, playerId, netUserData, popupReturn
|An event that awards gold and technologies
|-
!def _eventShowWonderBegin
|self, argsList
|Shows the wonder movie after building a wonder
|-
!def _eventShowWonderApply
|self, playerID, netUserData, popupReturn)
|Shows the wonder movie after building a wonder
|-
!def _eventEditUnitNameBegin
|self, argsList(pUnit)
|Creates a popup to rename a unit
|-
!def _eventEditUnitNameApply
|self, playerID, userData, popupReturn
|The event to let you rename a unit
|-
!def _eventWBAllPlotsPopupBegin
|self, argsList
|An event that reveals all plots in Worldbuilder
|-
!def _eventWBAllPlotsPopupApply
|self, playerID, userData, popupReturn
|An event that reveals all plots in Worldbuilder
|-
!def _eventWBLandmarkPopupBegin
|self, argsList
|Creates a popup to label a plot with a landmark tag
|-
!def _eventWBLandmarkPopupApply
|self, playerID, userData, popupReturn
|Labels a plot with a landmark tag
|-
!def _eventWBScriptPopupBegin
|self, argsList
|Not sure
|-
!def _eventWBScriptPopupApply
|self, playerID, userData, popupReturn
|Not sure
|-
!def _eventWBStartYearPopupBegin
|self, argsList
|Not sure
|-
!def _eventWBStartYearPopupApply
|self, playerID, userData, popupReturn
|Not sure
|-
|}

==Example==

This example is a quick idea of what you can do with functions in this file. It causes the "Do you want to change civics" popup to occur.

def onEndPlayerTurn(self, argsList):
'Called at the end of a players turn'
iGameTurn, iPlayer = argsList

if (gc.getGame().getElapsedGameTurns() == 1):
if (gc.getPlayer(iPlayer).isHuman()):
if (gc.getPlayer(iPlayer).canRevolution(0)):
popupInfo = CyPopupInfo()
popupInfo.setButtonPopupType(ButtonPopupTypes.BUTTONPOPUP_CHANGECIVIC)
popupInfo.addPopup(iPlayer)

{{Civ4_Python_Files}}

Category:Civ4 SDK Files

2009-12-07T23:48:20Z

TC01: Created page with 'Category:Civilization 4'

[[Category:Civilization 4]]

Template:Civ4 SDK Files

2009-12-07T23:47:20Z

TC01: Again, pointing SDK files created with this template to Civ4 SDK Files

CvEventManager

2009-12-07T23:09:13Z

TC01: Adding more info

CvDawnOfMan

2009-12-07T22:05:40Z

TC01: No missing information that I can see.

The '''CvDawnOfMan''' file is a python interface file that controls the appearance of the screen you get after first starting a game, called the "Dawn of Man" screen. It defines the popup screen and everything in it.

The Python files are written in the python programming language. They can be edited in a text editor such as notepad or in a programming editor like Python's IDLE.

==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.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Description
|-
!def _init_
|self, screenID
|Initializes variables, including screen dimensions
|-
!def interfaceScreen
|self
|Creates a popup to display the opening text
|-
!def handleInput
|self, inputClass
|Called when you get input like a button being clicked
|-
!def update
|self, fDelta
|Updates the screen (every frame?)
|-
!def onClose
|self
|Called when you close the screen
|-
!def calculateSizesAndPositions
|self
|Calculates size and position of screen
|}

==Example==

This example is a quick idea of what you can do with functions in this file. It adds your leaderhead art to the screen.

# Leaderhead graphic
szLeaderPanel = "DawnOfManLeaderPanel"
screen.addPanel( szLeaderPanel, "", "", true, false,
self.X_LEADER_ICON - 3, self.Y_LEADER_ICON - 5, self.W_LEADER_ICON + 6, self.H_LEADER_ICON + 8, PanelStyles.PANEL_STYLE_DAWNTOP )
screen.addLeaderheadGFC("LeaderHead", self.player.getLeaderType(), AttitudeTypes.ATTITUDE_PLEASED,
self.X_LEADER_ICON + 5, self.Y_LEADER_ICON + 5, self.W_LEADER_ICON - 10, self.H_LEADER_ICON - 10, WidgetTypes.WIDGET_GENERAL, -1, -1)

{{Civ4_Python_Files}}

Category:Civ4 Python Files

2009-12-07T21:57:18Z

TC01: Oops

[[Category:Civilization 4]]

Template:Civ4 Python Files

2009-12-07T21:55:21Z

TC01: The Python template should not categorize files in the XML Files category, should it?

User:TC01

2009-10-28T02:01:55Z

TC01: Update

I'm [http://forums.civfanatics.com/member.php?u=165196 TC01] on CFC forums, you can PM me in the link I just gave. I mod, and often when I have time, and thus have many projects and ideas for projects. All for Civilization IV, though. Below follows a list of them.

*For '''Civilization IV: Fall from Heaven 2'''
**Blizzards v1.1 (Available for Fall Further [http://forums.civfanatics.com/showthread.php?t=337440 here]): [http://forums.civfanatics.com/downloads.php?do=file&id=13355 Link]
**Frozen v0.8 (Available for Fall Further [http://forums.civfanatics.com/showthread.php?t=334381 here]): [http://forums.civfanatics.com/showthread.php?t=331912 Link]
*For '''Civilization IV: Final Frontier'''
**Final Frontier Worldbuilder v0.9: [http://forums.civfanatics.com/showthread.php?t=335880 Link]
**Wormholes v1.2 (Available for Star Trek Mod [http://forums.civfanatics.com/showthread.php?t=328114 here]): [http://forums.civfanatics.com/showthread.php?t=330307 Link]
**Cloaking Devices v1.2 (Only available for Star Trek): [http://forums.civfanatics.com/showthread.php?t=330947 Link]
*For '''Civilization IV: Colonization'''
**Continents Mapscript: [http://forums.civfanatics.com/showthread.php?t=333396 Link]
**NorthAfrica Mapscript: [http://forums.civfanatics.com/showthread.php?t=332482 Link]
**Westward Ho v0.31: [http://forums.civfanatics.com/showthread.php?t=329909 Link]

User:TC01

2009-10-27T00:57:49Z

TC01:

I'm [http://forums.civfanatics.com/member.php?u=165196 TC01] on CFC forums, you can PM me in the link I just gave. I mod, and often when I have time, and thus have many projects and ideas for projects. All for Civilization IV, though. Below follows a list of them.

*For '''Civilization IV: Fall from Heaven 2'''
**Blizzards v1.0 (Available for Fall Further [http://forums.civfanatics.com/showthread.php?t=337440 here]): [http://forums.civfanatics.com/downloads.php?do=file&id=13355 Link]
**Frozen v0.8 (Available for Fall Further [http://forums.civfanatics.com/showthread.php?t=334381 here]): [http://forums.civfanatics.com/showthread.php?t=331912 Link]
*For '''Civilization IV: Final Frontier'''
**Final Frontier Worldbuilder v0.9: [http://forums.civfanatics.com/showthread.php?t=335880 Link]
**Wormholes v1.2 (Available for Star Trek Mod [http://forums.civfanatics.com/showthread.php?t=328114 here]): [http://forums.civfanatics.com/showthread.php?t=330307 Link]
**Cloaking Devices v1.2 (Only available for Star Trek): [http://forums.civfanatics.com/showthread.php?t=330947 Link]
*For '''Civilization IV: Colonization'''
**Continents Mapscript: [http://forums.civfanatics.com/showthread.php?t=333396 Link]
**NorthAfrica Mapscript: [http://forums.civfanatics.com/showthread.php?t=332482 Link]
**Westward Ho v0.31: [http://forums.civfanatics.com/showthread.php?t=329909 Link]

Civ4CorporationInfo

2009-08-25T21:15:46Z

TC01: Added stuff from template

The '''Civ4CorporationInfos file''' defines all of the game's corporations as well as their effects, like providing extra resources and gold.

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.

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

==Tags==
===Text===

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description

|-
!BonusProduced
|This is the resource that the Corporation produces. Can be "NONE".
|-
!Civilopedia
|Refers to the TXT_KEY files that keeps the civilopedia information for the Corporation.
|-
!Description
|Refers to the TXT_KEY files that keeps the name of the Corporation.
|-
!FreeUnitClass
|Unknown. Is "NONE" for all corporations.
|-
!TechPrereq
|The Tech that is required to found this Corporation.
|-
! Type
|Defines the Corporations number.
|-
|}

===Integers===

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

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!iMaintenance
|The base percent maintenance that the corporation costs. (Default is "100" percent. "0" would make it so that corporation costs no maintenance, "200" would double corporation maintenance.)
|-
!iSpreadCost
|The base cost that a player must pay to spread the Corporation to a new city.
|-
!iSpreadFactor
|Unknown (The rate at which corporations spread?), Is "200" for all Corporations.
|-
|}

===Lists (Multi-line)===

All List tags consist of an opening/closing tag, which is shown here, and then each entry within it is another tag with the same name as the parent tag, minus the "s" (i.e. singular, rather than plural).

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!CommercesProduced
|This defines the extra commerce that the corporation provides, per resource the corporation consumes, using the iCommerceProduced integer tag. (Ex. 100 = one extra beaker, gold, culture. 25 = .25 extra beakers, gold, culture.)
|-
!HeadquarterCommerces
|This defines the changes in commerce that are given to the founding city in the corporation. The tags affect the increases in beakers, gold, culture per turn that the corporation provides, using the iHeadquarterCommerce integer tag.
|-
!PrereqBonuses
|A city must have at least one of these resources for the city to experience the benefits that the corporation provides. The more of the resources the city has, the more bonuses the corporation provides.
|-
!YieldsProduced
|This defines the extra yields that the corporation provides, per resource the corporation consumes, using the iYieldProduced integer tag. iYieldProduced controls the extra changes in food, hammer, and commerce production in each city with the corporation present. (Ex. 100 = one extra Food, Gold, or Hammer. 25 = .25 extra Food, Gold, or Hammer)
|-
|}

==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.

<insert code example from actual XML file>

{{Civ4_XML_Files}}

Talk:Civ3 Expanded Editor Guide

2009-08-22T20:36:40Z

TC01: Undo revision 841 by 194.44.240.74 (Talk)

CvEventManager

2009-08-22T01:11:44Z

TC01: /* Functions */

CvEventManager

2009-08-22T01:09:57Z

TC01:

CvDawnOfMan

2009-08-21T23:57:53Z

TC01: Created page with 'The '''CvDawnOfMan''' file is a python interface file that controls the appearance of the screen you get after first starting a game, called the "Dawn of Man" screen. It defines ...'

The '''CvDawnOfMan''' file is a python interface file that controls the appearance of the screen you get after first starting a game, called the "Dawn of Man" screen. It defines the popup screen and everything in it.

The Python files are written in the python programming language. They can be edited in a text editor such as notepad or in a programming editor like Python's IDLE.

<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.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Description
|-
!def _init_
|self, screenID
|Initializes variables, including screen dimensions
|-
!def interfaceScreen
|self
|Creates a popup to display the opening text
|-
!def handleInput
|self, inputClass
|Called when you get input like a button being clicked
|-
!def update
|self, fDelta
|Updates the screen (every frame?)
|-
!def onClose
|self
|Called when you close the screen
|-
!def calculateSizesAndPositions
|self
|Calculates size and position of screen
|}

==Example==

This example is a quick idea of what you can do with functions in this file. It adds your leaderhead art to the screen.

# Leaderhead graphic
szLeaderPanel = "DawnOfManLeaderPanel"
screen.addPanel( szLeaderPanel, "", "", true, false,
self.X_LEADER_ICON - 3, self.Y_LEADER_ICON - 5, self.W_LEADER_ICON + 6, self.H_LEADER_ICON + 8, PanelStyles.PANEL_STYLE_DAWNTOP )
screen.addLeaderheadGFC("LeaderHead", self.player.getLeaderType(), AttitudeTypes.ATTITUDE_PLEASED,
self.X_LEADER_ICON + 5, self.Y_LEADER_ICON + 5, self.W_LEADER_ICON - 10, self.H_LEADER_ICON - 10, WidgetTypes.WIDGET_GENERAL, -1, -1)

{{Civ4_Python_Files}}

Talk:PythonCallbackDefines

2009-08-21T21:35:23Z

TC01:

We should probably list all of the disabled callbacks here too. Additionally there are a LOT more of them in the default BtS file than the Final Frontier one, and the ones in the Final Frontier one are used in Final Frontier or were planned to be used, so the file might be modular.
--[[User:Deanej|Deanej]] 02:16, 17 August 2009 (UTC)

:That would be a good idea. I've been saying in the Event Manager "(Disabled in BTS with PythonCallbackDefines.xml)", but it's probably easier to list them all here.

:Based on a quick examination of the SDK, the "use ______ python callback" variables are all set to false by default (all booleans are). So I think if you don't have a callback in your mod file, it doesn't matter, since the callback is auto-set to false. But if you want to use it, you need to have it there. [[User:TC01|TC01]] 21:14, 17 August 2009 (UTC)

::Okay, so I've added the list. But what's FINISH_TEXT_CALLBACK? It doesn't seem to appear in any python file. [[User:TC01|TC01]] 21:35, 21 August 2009 (UTC)

PythonCallbackDefines

2009-08-21T21:34:31Z

TC01:

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.

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | Description
|-
!Civ4Defines
|Begins and ends the file. Everything must go between these two tags
|-
!Define
|Begins and ends an individual python callback define
|}

===Text===

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | 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.

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Tag Name
! style="background:#efefef;" | 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

{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Calllback Name
! style="background:#efefef;" | 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}}

Talk:Civ3 Expanded Editor Guide

2009-08-19T00:09:28Z

TC01: Undo revision 828 by 203.86.186.73 (Talk)

Talk:PythonCallbackDefines

2009-08-17T21:14:58Z

TC01:

PythonCallbackDefines

2009-08-16T18:52:42Z

TC01:

PythonCallbackDefines

2009-08-16T18:52:15Z

TC01:

PythonCallbackDefines

2009-08-16T18:51:53Z

TC01: Created page with '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, a...'

CvEventManager

2009-08-16T18:41:11Z

TC01:

The '''CvEventManager''' file controls what happens during events that occur in the game. These aren't events like Beyond the Sword random events but rather events like a unit moving, a turn beginning, or a nuclear explosion occuring.

The Python files are written in the python programming language. They can be edited in a text editor such as notepad or in a programming editor like Python's IDLE.

<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.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Description
|-
!def _init_()
|self
|Initializes variables in file
|-
!def handleEvent()
|self, argsList
|Event Manager entry point
|-
!def beginEvent()
|self, context, argsList=-1
|Begins an event
|-
!def applyEvent()
|self, argsList (context, playerID, netUserData, popupReturn)
|Applies the effects of an event
|-
!def reportEvent()
|self, entry, context, argsList
|Records an event to Events.log
|-
!def onKdbEvent()
|self, argsList (eventType, key, mx, my, px, py)
|Handles the pressing of a key
|-
!def onModNetMessage()
|self, argsList (iData1, iData2, iData3, iData4, iData5)
|Called whenever CyMessageControl().sendModNetMessage is called
|-
!def onInit()
|self, argsList
|Called whenever Civilization starts up
|-
!def onUpdate()
|self, argsList (fDeltaTime)
|Called every frame (disabled in BTS with [[PythonCallbackDefines]].xml)
|-
!def onWindowActivation()
|self, argsList (bActive)
|Called when the game window activates or deactivates
|-
!def onUnInit()
|self, argsList
|Called before Civ shuts down
|-
!def onPreSave()
|self, argsList
|Called before the game is saved
|-
!def onSaveGame()
|self, argsList
|Returns the name of the save game
|-
!def onLoadGame()
|self, argsList
|Called on the loading of the game
|-
!def onGameStart()
|self, argsList
|Called on the start of the game
|-
!def onGameEnd()
|self, argsList
|Called at the end of the game
|-
!def onBeginGameTurn()
|self, argsList (iGameTurn)
|Called at the beginning of the end of each turn
|-
!def onEndGameTurn()
|self, argsList (iGameTurn)
|Called at the end of the end of each turn
|-
!def onBeginPlayerTurn()
|self, argsList (iGameTurn, iPlayer)
|Called at the beginning of a player's turn
|-
!def onEndPlayerTurn()
|self, argsList (iGameTurn, iPlayer)
|Called at the end of a player's turn
|-
!def onEndTurnReady()
|self, argsList (iGameTurn)
|Called when the turn is ready to end
|-
!def onFirstContact()
|self, argsList (iTeamX, iHasMetTeamY)
|Called when one team meets another team
|-
!def onCombatResult()
|self, argsList (iWinner, iLoser)
|Called after combat
|-
!def onCombatLogCalc()
|self, argsList (genericArgs)
|Not sure
|-
!def onCombatLogHit()
|self, argsList (genericArgs)
|Not sure
|-
!def onImprovementBuilt()
|self, argsList (iImprovement, iX, iY)
|Called when an improvement is built
|-
!def onImprovementDestroyed()
|self, argsList (iImprovement, iOwner, iX, iY)
|Called when an improvement is destroyed
|-
!def onRouteBuilt()
|self, argsList (iRoute, iX, iY)
|Called when a route is built
|-
!def onPlotRevealed()
|self, argsList (pPlot, iTeam)
|Called when a plot is revealed to a team
|-
!def onPlotFeatureRemoved()
|self, argsList (pPlot, iFeatureType, pCity)
|Called when a feature is removed on a plot
|-
!def onPlotPicked()
|self, argsList (pPlot)
|Called when a plot is picked
|-
!def onNukeExplosion()
|self, argsList (pPlot, pNukeUnit)
|Called when a nuke explodes or a meltdown occurs
|-
!def onGotoPlotSet()
|self, argsList (pPlot, iPlayer)
|Not sure
|-
!def onBuildingBuilt()
|self, argsList (pCity, iBuildingType)
|Called when a building is built
|-
!def onProjectBuilt()
|self, argsList (pCity, iProjectType)
|Called when a project is completed
|-
!def onSelectionGroupPushMission()
|self, argsList (eOwner, eMission, iNumUnits, listUnitIDs)
|Called when a selection group mission occurs (?)
|-
!def onUnitMove()
|self, argsList (pPlot, pUnit, pOldPlot)
|Called when a unit moves onto a new plot
|-
!def onUnitSetXY()
|self, argsList (pPlot, pUnit)
|Called when a unit's coords are set manually (disabled in BTS with PythonCallbackDefines.xml)
|-
!def onUnitCreated()
|self, argsList (unit)
|Called when a unit is created (disabled in BTS with PythonCallbackDefines.xml)
|-
!def onUnitBuilt()
|self, argsList (city, unit, player)
|Called when a unit is built in a city
|-
!def onUnitKilled()
|self, argsList (unit, iAttacker)
|Called when a unit is killed by another unit
|-
!def onUnitLost()
|self, argsList (unit)
|Called when a unit dies (disabled in BTS with PythonCallbackDefines.xml)
|-
!def onUnitPromoted()
|self, argsList (pUnit, iPromotion)
|Called when a unit is promoted
|}

==Example==

This example is a quick idea of what you can do with functions in this file.

<insert code example from actual Python file>

{{Civ4_Python_Files}}

Talk:Civ3 Expanded Editor Guide

2009-08-16T01:55:15Z

TC01: Undo revision 812 by 196.0.18.163 (Talk)

Talk:Civ3 Expanded Editor Guide

2009-08-16T01:55:06Z

TC01: Undo revision 813 by 190.14.254.162 (Talk)

yofun.neet http://www.daisyanthon.xdir.fr/nasty-stinger-fir.html nasty stinger firwww.verizon.neet http://www.daisyanthon.xdir.fr/schurter-4300.0603.html schurter 4300.0603192.168.168.109 8080 http://www.daisyanthon.xdir.fr/8080.ne.html 8080.nepmi stinger paintballs.com http://www.daisyanthon.xdir.fr/8080.ent.html 8080.entwww.netscape.neet http://www.daisyanthon.xdir.fr/www.-8080.net.html www. 8080.netvil.nai.com stinger http://www.daisyanthon.xdir.fr/8080-purnell-dr.html 8080 purnell drwebmail.att.neet http://www.daisyanthon.xdir.fr/optimun.neet.html optimun.neet195.175.37.8 8080 http://www.daisyanthon.xdir.fr/pussy.org.uk.html pussy.org.ukstinger 3.0.6 download http://www.daisyanthon.xdir.fr/192.168.1.1-8080.html 192.168.1.1 8080stinger v 2.6.0 http://www.daisyanthon.xdir.fr/ww.stinger.com.html ww.stinger.com

Civ4 Modding Tutorials

2009-08-16T01:53:48Z

TC01: Undo revision 816 by 97.74.75.227 (Talk)

== General Tutorials ==
* [http://forums.civfanatics.com/showthread.php?t=262402 How To Create a Mod (Video Demo)]
* [http://forums.civfanatics.com/showthread.php?t=173061 How To Design a Mod]
* [http://forums.civfanatics.com/showthread.php?t=187699 How To Get Your Mod To Load Faster]
* [http://forums.civfanatics.com/showthread.php?t=229557 A Modder's Guide to Beyond the Sword]
* [http://forums.civfanatics.com/showthread.php?t=168876 How To Add Custom Sounds]
* [http://forums.civfanatics.com/showthread.php?t=161442 How To Change the Movies]
* [http://forums.civfanatics.com/showthread.php?t=191978 How To Add an Intro Movie]
* [http://forums.civfanatics.com/showthread.php?t=230567 Guide to Event Modding]
* [http://forums.civfanatics.com/showthread.php?t=236727 Random Events List] (Reference)
* [http://forums.civfanatics.com/showthread.php?t=175005 How To Isolate Crashes]
* [http://forums.civfanatics.com/showthread.php?t=268759 Non-Random Events in Beyond the Sword]
* [http://forums.civfanatics.com/showthread.php?p=7233336 Multiplayer Compatability Guide]
* [http://forums.civfanatics.com/showthread.php?t=132476 The Modder's Guide to Civ4]

== Graphics Tutorials ==
* [http://forums.civfanatics.com/showthread.php?t=183568 Skinning For Beginners]
* [http://forums.civfanatics.com/showthread.php?t=153584 How To Skin and Add Resources and Improvements]
* [http://forums.civfanatics.com/showthread.php?p=5339402#post5339402 Create Noshader Units from Units With Shaders]
* [http://forums.civfanatics.com/showthread.php?t=167335 How To Import a Custom Model (Blender)]
* NifViewer Tutorial: [http://forums.civfanatics.com/showthread.php?t=163585 Part 1], [http://forums.civfanatics.com/showthread.php?t=165689 Part 2], [http://forums.civfanatics.com/showthread.php?t=176106 Part 3]
* [http://forums.civfanatics.com/showthread.php?t=214207 3ds Max Importing/Exporting]
* [http://forums.civfanatics.com/showthread.php?t=179747 Merge Animations With Your Models]
* [http://forums.civfanatics.com/showthread.php?t=184327 How to Create Units with 3ds Max]
* [http://forums.civfanatics.com/showthread.php?t=182779 3ds Max Unit Creation Guide]
* [http://forums.civfanatics.com/showthread.php?t=177468 Import NIF File into 3ds Max]
* [http://forums.civfanatics.com/showthread.php?t=162118 Getting Your Units Into Civilization IV]
* [http://forums.civfanatics.com/showthread.php?t=171934 How To Make .dds Textures for 3ds Max Models]
* [http://forums.civfanatics.com/showthread.php?t=240956 Damage States for Custom Units (3ds Max)]
* [http://forums.civfanatics.com/showthread.php?t=181119 How To Edit GameFont.tga]
* [http://forums.civfanatics.com/showthread.php?t=278946 How To Fix GameFont.tga]
* [http://forums.civfanatics.com/showthread.php?t=150275 How To Create Non-Distorted Flags]
* [http://forums.civfanatics.com/showthread.php?t=237832 How To Make Units Use Different Effects]
* [http://forums.civfanatics.com/showthread.php?t=183742 How To Import/Modify/Export Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=230458 How To Create Shaded Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=267233 How To Create Leaderheads]
* [http://forums.civfanatics.com/showthread.php?t=304100 Working with GameFont.tga in Photoshop]
* [http://forums.civfanatics.com/showthread.php?t=305606 Nifskope]
* [http://forums.civfanatics.com/showthread.php?t=312613 Modifying the Visibility of Weapons/Unit Animations]
* [http://forums.civfanatics.com/showthread.php?t=271331 Making Minor Changes to Unit Animation without 3DS Max]
* [http://forums.civfanatics.com/showthread.php?t=325606 Adding Action Sounds to Unit Animations]

== Tutorials Involving XML ==
* For tutorials on how to use XML, see [[Civ4 XML Reference|the XML section]].
* [http://forums.civfanatics.com/showthread.php?t=148507 How To Add a Civilization]
* [http://forums.civfanatics.com/showthread.php?t=139721 How To Add New Units]
* [http://forums.civfanatics.com/showthread.php?t=176460 Adding Units to Civilizations in 6 Easy Steps]
* [http://forums.civfanatics.com/showthread.php?t=188708 How To Add a New Building]
* [http://forums.civfanatics.com/showthread.php?t=138779 How To Add a Civic]
* [http://forums.civfanatics.com/showthread.php?t=304685 How To Add Diplomacy Text to a Leaderhead]
* [http://forums.civfanatics.com/showthread.php?t=234970 How To Add a Civ/Unit/Building in BtS (Modular XML Loading)]

== Tutorials Involving Python ==
* For tutorials on how to use Python, see [[Civ4 Python|the Python section]].
* [http://forums.civfanatics.com/showthread.php?t=183126 How To Add Popups]
* [http://forums.civfanatics.com/showthread.php?t=142169 How To Save and Load Data in Your Mod]

== Tutorials Involving the SDK ==
* For tutorials on how to use the SDK, see [[Civ4 SDK|the SDK section]].
* [http://forums.civfanatics.com/showthread.php?t=166935 Adding New XML Values]
* [http://forums.civfanatics.com/showthread.php?t=183339 Adding New Missions For Units]
* [[How To Change the Maximum Number of Players]]

[[Category:Civilization 4]]

Talk:Civ4 Python

2009-08-08T18:16:18Z

TC01: Created page with 'Why is this page in the Civ 4 XML Files category? And the SDK page? ~~~~'

Why is this page in the Civ 4 XML Files category? And the SDK page? [[User:TC01|TC01]] 18:16, 8 August 2009 (UTC)

User:TC01

2009-08-08T16:19:52Z

TC01: Created page with 'I'm [http://forums.civfanatics.com/member.php?u=165196 TC01] on CFC forums, you can PM me in the link I just gave.'

I'm [http://forums.civfanatics.com/member.php?u=165196 TC01] on CFC forums, you can PM me in the link I just gave.

CvEventManager

2009-08-08T16:18:25Z

TC01: Started file, added a few functions- from my BTS event manager

The '''CvEventManager''' file controls what happens during events that occur in the game. These aren't events like Beyond the Sword random events but rather events like a unit moving, a turn beginning, or a nuclear explosion occuring.

The Python files are written in the python programming language. They can be edited in a text editor such as notepad or in a programming editor like Python's IDLE.

<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.
{| border="1" style="text-align:left" cellpadding="3" cellspacing="0"
|-
! style="background:#efefef;" | Function
! style="background:#efefef;" | Parameters
! style="background:#efefef;" | Description
|-
!def onUpdate()
|self, argsList (fDeltaTime)
|Called every frame (disabled in BTS with PythonCallbackDefines.xml)
|-
!def onWindowActivation()
|self, argsList (bActive)
|Called when the game window activates or deactivates
|-
!def onUnInit()
|self, argsList
|Called before Civ shuts down
|-
!def onPreSave()
|self, argsList
|Called before the game is saved
|-
!def onSaveGame()
|self, argsList
|Returns the name of the save game
|-
!def onLoadGame()
|self, argsList
|Called on the loading of the game
|-
!def onGameStart()
|self, argsList
|Called on the start of the game
|-
!def onGameEnd()
|self, argsList
|Called at the end of the game
|-
!def onBeginGameTurn()
|self, argsList (iGameTurn)
|Called at the beginning of the end of each turn
|-
!def onEndGameTurn()
|self, argsList (iGameTurn)
|Called at the end of the end of each turn
|-
!def onBeginPlayerTurn()
|self, argsList (iGameTurn, iPlayer)
|Called at the beginning of a player's turn
|-
!def onEndPlayerTurn()
|self, argsList (iGameTurn, iPlayer)
|Called at the end of a player's turn
|-
!def onEndTurnReady()
|self, argsList (iGameTurn)
|Called when the turn is ready to end
|-
!def onFirstContact()
|self, argsList (iTeamX, iHasMetTeamY)
|Called when one team meets another team
|-
!def onCombatResult()
|self, argsList (iWinner, iLoser)
|Called after combat
|}

==Example==

This example is a quick idea of what you can do with functions in this file.

<insert code example from actual Python file>

{{Civ4_Python_Files}}

Civ4 Python

2009-08-08T15:47:12Z

TC01: Added a tutorial I just made

== Template ==
Please use the following template for python files.
* [[Format for new Python pages]]

== Tutorials and Reference ==

* [http://forums.civfanatics.com/showthread.php?t=154130 TGA's Python Tutorial]
* [http://forums.civfanatics.com/showthread.php?t=163848 How to Call a Function at the End of a Turn]
* [http://apolyton.net/forums/showthread.php?s=&threadid=167960 Jon Shafer's Guide to Python in Civ4]
* [http://forums.civfanatics.com/showthread.php?t=152856 Sample Python Code]
* BTS Python API
** [http://civ4bug.sourceforge.net/PythonAPI/index.html View]
** [http://code.google.com/p/civ4-python-api/ Project @ Google Code]
** [http://forums.civfanatics.com/showthread.php?t=238839 Forum Discussion]
* [http://civilization4.net/files/modding/PythonAPI/ Warlords Python API]
* [http://forums.civfanatics.com/showthread.php?t=323805 Modding CvGameUtils]
* [http://forums.civfanatics.com/showthread.php?t=331001 How to Make Python Action Buttons]

== Files ==
'''*''' Warlords/BtS only

'''**''' BtS Only
=== Assets\Python ===
* [[CvAdvisorUtils]]
* [[CvCameraControls]]
* [[CvDebugTools]]
* [[CvDefineEditor]]
* [[CvDiplomacy]]
* [[CvEventManager]]
* [[CvGameUtils]]
* [[CvMagGeneratorUtil]]
* [[CvPerfTest]]
* [[CvQuestManager]]
* [[CvScreenUtils]]
* [[CvUtil]]
* [[DomPyHelpers]]**
* [[PyHelpers]]
* [[ScreenImput]]
* [[vector]]

=== Assets\Python\_DebugTools ===
* [[AudioLogParser]]

=== Assets\Python\EntryPoints ===
* [[CvAppInterface]]
* [[CvDebugInterface]]
* [[CvDiplomacyInterface]]
* [[CvEventInterface]]
* [[CvGameInterface]]
* [[CvGameInterfaceFile]]*
* [[CvMapScriptInterface]]
* [[CvOptionScreenCallbackInterface]]
* [[CvPopupInterface]]
* [[CvRandomEventInterface]]**
* [[CvScreensInterface]]
* [[CvScreenUtilsInterface]]
* [[CvTranslator]]
* [[CvUnitControlInterface]]
* [[CvWBInterface]]
* [[PbMain]]

=== Assets\Python\PitBoss ===
* [[PbAdmin]]
* [[PbWizard]]

=== Assets\Python\pyHelper ===
* [[Popup]]
* [[Unit]]
* [[UnitEntity]]

=== Assets\Python\pyUnit ===
* [[CvUnitController]]

=== Assets\Python\pyWB ===
* [[CvWBDesc]]
* [[CvWBPopups]]

=== Assets\Python\Screens ===
* [[CvAdvisorScreen]]
* [[CvCivicsScreen]]
* [[CvCorporationAdvisor]]**
* [[CvDanQuayle]]
* [[CvDawnOfMan]]
* [[CvDebugInfoScreen]]
* [[CvDomesticAdvisor]]
* [[CvEraMovieScreen]]
* [[CvEspionageAdvisor]]**
* [[CvExoticForeignAdvisor]]**
* [[CvFinanceAdvisor]]
* [[CvForeignAdvisor]]
* [[CvGFCScreen]]
* [[CvHallOfFameScreen]]
* [[CvInfoScreen]]
* [[CvIntroMovieScreen]]
* [[CvMainInterface]]
* [[CvMilitaryAdvisor]]
* [[CvOptionsScreen]]
* [[CvPediaBonus]]
* [[CvPediaBuilding]]
* [[CvPediaCivic]]
* [[CvPediaCivilization]]
* [[CvPediaCorporation]]**
* [[CvPediaFeature]]
* [[CvPediaHistory]]
* [[CvPediaImprovement]]
* [[CvPediaLeader]]
* [[CvPediaMain]]
* [[CvPediaProject]]
* [[CvPediaPromotion]]
* [[CvPediaReligion]]
* [[CvPediaScreen]]
* [[CvPediaSpecialist]]
* [[CvPediaTech]]
* [[CvPediaTerrain]]
* [[CvPediaUnit]]
* [[CvPediaUnitChart]]
* [[CvRelitonScreen]]
* [[CvReplayScreen]]
* [[CvScreen]]
* [[CvScreenEnums]]
* [[CvSpaceShipScreen]]**
* [[CvTechChooser]]
* [[CvTechSplashScreen]]
* [[CvTopCivs]]
* [[CvTutorialQuestScreen]]
* [[CvUNVictoryScreen]]
* [[CvVictoryMovieScreen]]
* [[CvVictoryScreen]]
* [[CvWonderMovieScreen]]
* [[CvWorldBuilderDiplomacyScreen]]
* [[CvWorldBuilderScreen]]
* [[IconGrid]]**
* [[TechTree]]**

=== Assets\Python\System ===
* These files are mostly compiled python files that cannot be modified.

{{Civ4_Python_Files}}

[[Category:Civilization 4]]