Wikibooks

Civ/Civilization IV/Modding/Tutorials/Tips and Tricks

< Civ | Civilization IV | Modding | Tutorials


Getting Python to Generate Documentation

edit

If you're looking for a quick and easy way to get documentation about the Python modules in Civilization IV then here's what you can do:

  • Open up a .py file.
  • Add these lines to the __init__ function:
import pydoc
pydoc.writedoc(<module name>)

So if you want to show all Dll-exported classes do: 

import pydoc
pydoc.writedoc(sys.modules['CvPythonExtensions'])
  • Run Civ4.

This (should) write out an .html file in the Civilization 4 root directory all the information that pydoc can find about the module. While this depends heavily on the programmers leaving lots of descriptive __doc__ strings, you can at least get the function and parameter names out of it.


Making Changes Quickly

edit

Since Python is an interpreted language, you should be able to modify a python file, and then see the results in Civ4 immediately. I've found that this is true in at least one case, but false in certain other cases.

For example, if you modify the Civilopedia pages, and then access this page from Civ4 main menu (when you load up the game), then any changes to the Civilopedia wont be seen until you either restart the game, or actually start a game.

However, if you are in a game, and you alt-tab back to the desktop, make changes to the Python files, then alt-tab back to Civ4, the Python files are reloaded and you see the changes immediately, and more importantly, Civ4 tells you at this point whether there's a problem loading any files.

As always, your mileage may vary, but in most cases development in Python should be fairly quick. No more restarting the whole game to see changes...

Retrieved from "https://en.wikibooks.org/w/index.php?title=Civ/Civilization_IV/Modding/Tutorials/Tips_and_Tricks&oldid=4229208"