Civilization Modding Wiki - User contributions [en]

Civ4 Python

2010-07-17T12:57:32Z

Duha: /* Tutorials and Reference */

== 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]
* [http://modiki.civfanatics.com/index.php/Civ4_Python/import Import guide]

== Files ==

=== 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]]
* [[CvReligionScreen]]
* [[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]]

Civ4 Python/import

2010-07-17T12:55:54Z

Duha:

'''Import guide.'''

import allow you to add python files to you mod.

'''Example:'''

How to add popup to the event:
:'''Bad way:'''
* Insert popup code to CvEventManager.py in event. 
'''Result:''' 
Big files is hard to read and edit. It is not easy to customize this code and merge to others mod. 
:'''Good way:''' 
* Create file mymod.py 
* Create function that runs popup (for example: run_popup) 
* edit CvEventManager.py: 
** add string after imports: import mymod.py 
** and string in event: mymod.run_popup(*args) 
'''Result:''' 
It is easy to add / remove this function from mod (just uncomment lines). 
It is easy to share this function. 
It is easy to call this function in other place. (if yon need it on some event). 

import executes script in file (if you have only functions and classes loads them to memory.)

=='''import sintax:'''==
* ''import mymod'' 
to access functions use: 
''mymod.foo()'' 

* ''from mymod import *'' 
to access functions use: 
''foo()'' 

* ''from mymod import foo, goo'' 
to access functions use: 
''foo()'' or ''goo()'' 
(some IDE has autocomplite feature and in this way shows only foo and goo.)

* ''from mymod import this_is_long_name_function as foo'' 
to access functions use: 
''foo()'' 
(It is good idea to have functions with understandable name)

== '''Import folders''' ==
* Create folder (mymodule)
* Create __init__.py (leave it blank)
* Create file: myscript.py

'''Usage''' 
from mymodule import myscript 
or 
from mymodule.myscript import * 

=='''Import rules:'''==
Use imports at the file beginning!

== References ==
[http://forums.civfanatics.com/showpost.php?p=2495872 Lesson 09 - 'Borrowing' other people's stuff (with modules)]

Civ4 Python/import

2010-07-17T12:39:02Z

Duha:

import allow you to add python files to you mod.

'''Example:'''

How to add popup to the event:
:'''Bad way:'''
* Insert popup code to CvEventManager.py in event. 
'''Result:''' 
Big files is hard to read and edit. It is not easy to customize this code and merge to others mod. 
:'''Good way:''' 
* Create file mymod.py 
* Create function that runs popup (for example: run_popup) 
* edit CvEventManager.py: 
** add string after imports: import mymod.py 
** and string in event: mymod.run_popup(*args) 
'''Result:''' 
It is easy to add / remove this function from mod (just uncomment lines). 
It is easy to share this function. 
It is easy to call this function in other place. (if yon need it on some event). 

import executes script in file (if you have only functions and classes loads them to memory.)

=='''import sintax:'''==
* ''import mymod'' 
to access functions use: 
''mymod.foo()'' 

* ''from mymod import *'' 
to access functions use: 
''foo()'' 

* ''from mymod import foo, goo'' 
to access functions use: 
''foo()'' or ''goo()'' 
(some IDE has autocomplite feature and in this way shows only foo and goo.)

* ''from mymod import this_is_long_name_function as foo'' 
to access functions use: 
''foo()'' 
(It is good idea to have functions with understandable name)

=='''Import rules:'''==
Use imports at the file beginning!

== References ==
[http://forums.civfanatics.com/showpost.php?p=2495872|Lesson 09 - 'Borrowing' other people's stuff (with modules)]

Civ4 Python/import

2010-07-17T12:21:09Z

Duha:

Civ4 Python/import

2010-07-17T10:03:45Z

Duha: Created page with 'import allow you to add python files to you mod. Example: adding popup to the start of turn: '''Bad way:''' Insert popup code to CvEventManager.py Big files is hard to read....'

import allow you to add python files to you mod.

Example:

adding popup to the start of turn:

'''Bad way:'''
Insert popup code to CvEventManager.py

Big files is hard to read. It is not easy to customize this code and merge to others mod.

'''good way'''
Create file mymod.py
Create function that runs popup (run_popup)
edit CvEventManager.py:

add string after imports:
import mymod.py

and string:
mymod.run_popup() there it needs.

It is easy to add / remove this function (just uncomment lines)
It is easy to share.
It is easy to call this function in other place.

'''import sintax:'''

import executes file (if you have only functions and classes loads them to memory.)

import mymod
to access functions use: mymod.foo()

from mymod import *
to access functions use: foo()

from mymod import foo, goo
to access functions use: foo()
(some IDE has autocomplite feature and in this way shows only foo and goo. if you don use IDE use *)

from mymod import this_is_long_name_function as foo
to access functions us: foo()
(It is good idea to have functions with understandable name)

Import rules:
Use imports at the file beginning.