はじめてのPythonMOD 2

はじめに

  • その1のつづき
  • 条件分岐を使ってみる

準備

前回のkujiraMODをフォルダごとコピーしてリネーム、kujira_ifというMODを作ります。

└─kujira_if
    └─Assets
        └─Python
            │─KujiraEventManager.py
            │
            └─Entrypoints
                 └─CvEventInterface.py

このようにフォルダごとコピーすることで、
あるMODをもとにした派生MODを作成することができます。

選り好みする図書館

前回は《都市が建設されたとき、その都市に図書館を建設するMOD》をつくりました。
しばらくプレイするとわかりますが、このMODは誰の都市か、首都かどうか、
などを区別せず、全都市に無差別に図書館を建設します。
それもそのはず、「都市が建設されたとき」以外の条件を付けていないからです。
これだと創造志向があまりにもかわいそうですし、
せめて自動建設は首都だけにして少しマイルドにできないでしょうか。

この制限を考慮に入れて、
《都市が建設されたとき、その都市が首都であれば、その都市に図書館を建設するMOD》
をつくっていきます。

Pythonのプログラムは1行で1つの処理を表すことになっています。
そのひとつひとつの処理を(statement)と呼びます。
基本的に1行で文になるので、pCity = argsList[0]
iLib = gc.getInfoTypeForString('BUILDING_LIBRARY')も文です。
複数の処理を記述するときは、上から順番に文を並べます。

a = 4       # aを4にする
b = 8       # bを8にする
c = a + b   # cをa+bの計算結果の値にする
print c     # cの値を出力する
# 12が出力される

if文

ただ順番に実行するだけではない特殊な文がいくつかあります。
そのうちのひとつがif文です。

if 条件:
    中身の文1
    中身の文2
    中身の文3
    ...

条件を満たした場合に限り、”中身”が上から順番に実行されます。
この”中身”のことをブロック(block)と呼びます。

a = 2           # aを2にする
b = 3           # bを3にする
c = a * b       # cをa*bの計算結果の値にする
if c > 20:      # cが20より大き...くないので中身は実行されない
    a = 4
    b = 5
    c = a * b
print c         # cの値を出力する
# 6が出力される

if文は自分が従えているブロックを含めて大きいひとつのです。
他の文と混ぜることができ、順番通りに実行されます。

どこからどこまでがブロックなのかは、
空白文字を使って字下げ(indent)することで表します。
書き出しが揃えられている行どうしが同じブロックとして認識されます。

ブロック内の文どうしで揃ってさえいればいいので、
Pythonのルールとしては何文字分字下げしても構いません。
ただ、基本的には自分ルールで何文字分インデントするか
あらかじめ決めておくのがよいでしょう。
「半角スペース4つ」が一般的に推奨されており、
Kujiraでも半角スペース4つで統一しています。1

なお、空白文字として認識されるのは半角スペースまたはタブ文字です。
全角スペースではだめなことにだけ注意しておきましょう。

KujiraEventManager.py

というわけで、KujiraEventManager.pyをこうしてみました…

from CvPythonExtensions import *
import CvEventManager
import CvUtil

gc = CyGlobalContext()

class MyEventManager(CvEventManager.CvEventManager, object):

    def onCityBuilt(self, argsList):
        'Called when a player builds a city'
        super(self.__class__, self).onCityBuilt(argsList)
        ##########
        pCity = argsList[0]
        if pCity.isCapital():
            iLib = gc.getInfoTypeForString('BUILDING_LIBRARY')
            pCity.setNumRealBuilding(iLib, 1)

前回から変わったのはこの部分ですね。

<<<<<<<<<<
        if pCity.isCapital():
            iLib = gc.getInfoTypeForString('BUILDING_LIBRARY')
            pCity.setNumRealBuilding(iLib, 1)
>>>>>>>>>>

BUILDING_LIBRARYの内部数値を取得して/それを建設する
という処理をまるごとブロックにして、
pCity.isCapital()(pCityは首都か?)の答えが「はい」であるときに限り、
実行されるようにしています。

ためす

これで《都市が建設されたとき、その都市が首都であれば、その都市に図書館を建設するMOD》になったはずです。



できました!

もう少し進める

これまでは図書館は公平に与えられてきましたが、
対象を限定するこの力を使えばちょっとずるしたバージョンもつくれます。
《都市が建設されたとき、その都市の所有者の文明がマリならば、その都市に図書館を建設するMOD》
を目指してみましょう。

その都市の所有者

Playerという概念があります。
これは、実際にシド星に登場している指導者ひとりひとりのことです。
このとき、操作しているのが人間であるかAIであるかは問いません。
もちろん、Playerの状態(ビーカーはどれだけ出ているか・国庫はどれくらいあるか・どんな技術を持っているか・などなど他にもたくさん)は
ターンごとに刻々と変わっていきます。こういった変わっていくものにも干渉できるというのが
XMLではできないPythonでのMODの楽しみのひとつです。

所有者←都市

リファレンスでCyCityをクリックしてから”player”で検索すると…

243. PlayerType getOwner()
     int /* PlayerTypes*/ ()

それっぽいのがありました。
PlayerTypeとあるので、ip = pCity.getOwner()とすると
ipにはPlayerを表す数値が入ります。
(覚えていますか?Typeとあるときはその種類に対応する数値を表すのでした)
私たちはこのPlayerに対してさらに操作(今回は所属文明という情報の取得)したいので
Player本体が欲しいです。
そこで、pPlayer = gc.getPlayer(ip)とすると、pPlayerにPlayer本体がぎゅっと入ります。

ip = pCity.getOwner()
pPlayer = gc.getPlayer(ip)

pCity.getOwner()で取れた数値をいったんipに代入していますが、
直接その番号をgc.getPlayer()することもできます。

そうする場合はこうなります。

pPlayer = gc.getPlayer( pCity.getOwner() )

所有者→文明

あらためてリファレンスでCyPlayerの中から”Civilization”で探すと…

161. CivilizationType getCivilizationType ()
     int ()

ありました。これでic = pPlayer.getCivilizationType()とすれば、
icに文明の種類に対応する数値が代入できるのですが、
ここでいう「文明の種類」とは、マリとは何か、カルタゴとは何か、という定義です。
MODではXMLであってもPythonであっても、そのような定義をInfoと呼びます。

文明Player都市とちがい、ゲーム中に状態が変化したりはしません。
(私たちがプレイしてるときによく言う「プレイヤー文明」や「AI文明」という概念は
ここではPlayerになることに注意してください。)
都市の出力や建造物なんかはどんどん増えていきますが、
ゲーム中にマリの指導者が突然徳川家康になったり
マリのUBがヒッポドロームになったりはしません。
もしそうなるようなMODを(XMLで)作るのだとしても、
マリのUBが最初からヒッポドロームになるのであって、
マリのUBがゲームの途中でヒッポドロームに変わるのではないはずです。

ですから、この数値によって取得できるのは「文明のInfo」、
すなわちCivilizationInfoです。
(ここでいうCivilizationInfoというのはXML編集した時の
<CivilizationInfo>タグと同じものです!世界がつながってきました。)
というわけでcivinfo = gc.getCivilizationInfo(ic)として
pPlayerが所属している文明のInfoになったはずです。

長かった道のりもそろそろ終わり、
知りたいのはその文明がマリかどうか、なのでした。
civinfo.getType()として<Type>タグが
CIVILIZATION_MALIになっているかどうかで判断しましょう。

ip = pCity.getOwner()
pPlayer = gc.getPlayer(ip)
ic = pPlayer.getCivilizationType()
civinfo = gc.getCivilizationInfo(ic)
if civinfo.getType() == 'CIVILIZATION_MALI':
    # 図書館を建設する

まとめてこうなります。
Pythonを含め、多くのプログラミング言語では
=は右辺を左辺に代入する機能しかありません。
「等しいかどうかの比較」には==を使います。

あるいは

CyCity->PlayerType->CyPlayer->CivilizatonType->CivilizationInfo->キー
と一直線につないでいってキーで比較する方法を見てきましたが、
マリのXMLキーCIVILIZATION_MALIからマリを表す数値はたしか
gc.getInfoTypeForString('CIVILIZATION_MALI')で取得できたはず、
数値同士が等しいかどうかで判断してはどうか?
という発想を試すこともできます。その場合こうなります…

if pCity.getCivilizationType() == gc.getInfoTypeForString('CIVILIZATION_MALI'):
    # 図書館を建設する

if文の条件式の左辺はpCityから直接文明IDを取得しています。
じつはこのような方法もあるのでした。
右辺はマリの文明IDになっていますから、
もしこれらが等しければpCityはマリ所属のはずです。

くみこむ

どちらの書き方でも意味は同じなのですが、後者の方が短くすっきり書けるので、
その方式をKujiraEventManager.pyonCityBuilt()に組み込むと、

from CvPythonExtensions import *
import CvEventManager
import CvUtil

gc = CyGlobalContext()

class MyEventManager(CvEventManager.CvEventManager, object):

    def onCityBuilt(self, argsList):
        'Called when a player builds a city'
        super(self.__class__, self).onCityBuilt(argsList)
        ##########
        pCity = argsList[0]
        if pCity.getCivilizationType() == gc.getInfoTypeForString('CIVILIZATION_MALI'):
            iLib = gc.getInfoTypeForString('BUILDING_LIBRARY')
            pCity.setNumRealBuilding(iLib, 1)

こうなります。

ためす


AIマリの都市には最初から図書館が建っていて、

ケルトの都市にはありません。

動きました!

その3へ続く

余談

今回は結局PlayerInfoも使わずに書ける例も紹介してしまいましたが、
どちらの概念も極めて重要なので、ぜひ使わなかった方でも書いて試してみてください。
後の理解度が違ってくるはずです。


  1. Civ4のAssetsにあるPythonファイルの多くは「タブ文字1つ」でインデントしてあります。どうしてもPythonファイルを改変する場合は、郷に入っては郷に従いましょう。
    [return]