jpoke 早見表¶
pip install jpoke でインストールしたライブラリ利用者向けに、よく使う公開APIをまとめたもの。
内部実装(data/, handlers/, 各種 *_manager.py など)の詳細は
CLAUDE.md を参照。
外部からの利用(テスト・bot・探索コード)は Battle の公開メソッドを入口にする方針
(CLAUDE.md#開発ルール)のため、
本早見表も battle.<manager>.<method>() のような内部マネージャーへの直接アクセスや、
_ 始まりの非公開属性は載せない。
このドキュメントは よく使う公開APIの見取り図であり、全メソッド・全引数を網羅する
ものではない。詳細な挙動・戻り値・例外条件は各クラスのdocstring(ソースコード:
src/jpoke/core/battle.py, src/jpoke/core/player.py, src/jpoke/model/pokemon.py)を
直接参照すること。全シグネチャ・全メソッド・全属性を網羅した自動生成リファレンスは
APIリファレンスを参照。
対象範囲・アーキテクチャの全体像は README.md を参照。
目次¶
- Battle
- Player
- TreeSearchPlayer
- MinimaxPlayer
- Pokemon
- Command
- Move
- PokeAPIユーティリティ
- テストユーティリティ(jpoke.testing)
Battle¶
src/jpoke/core/battle.py。バトル全体の状態管理・ターン進行を担う中心クラス。
コンストラクタ¶
Battle(
*players: Player,
n_selected: int | None = None,
seed: int | None = None,
mega_evolution: bool = True,
terastal: bool = True,
critical_mode: CriticalMode = "normal", # "normal" / "always"
damage_roll: DamageRollMode = "normal", # "normal" / "average" / "max" / "min"
accuracy_fix_threshold: int | None = None,
effect_chance_threshold: float | None = None,
double_battle: bool = False,
)
*players: 参加プレイヤー(可変長引数、通常2人)。Battle(player1, player2)のように 個別の位置引数で渡す(タプル渡しは不可)n_selected: 選出可能なポケモンの数。省略時はmin(3, 各プレイヤーの手持ち数)が自動設定される。 手持ち数がプレイヤー間で異なる場合も両者に同じ値が適用されるため、片方の手持ちが少ないと 両者とも選出数が絞られる点に注意seed: 乱数シード値。省略時はOSの乱数源から高エントロピーな値を生成するmega_evolution/terastal: メガシンカ/テラスタルを許可するか(既定は両方True)critical_mode: 急所判定モード(既定"normal")damage_roll: ダメージ乱数モード(既定"normal")accuracy_fix_threshold: この値以上の命中率を100%固定にする(Noneなら無効)effect_chance_threshold: この値未満の追加効果確率を0%にする(Noneなら無効)。accuracy_fix_thresholdと併用すると、命中判定・追加効果発動の両方を排除した 完全に決定論的なシナリオを作れる(シナリオ検証・回帰テスト向け)double_battle: ダブルバトル向けのダメージ計算補正を有効にするか(既定False。 対戦進行自体はシングルバトル専用であることに変わりはない)
from jpoke import Battle, Player
player1 = Player("Player 1")
player1.add_pokemon("ピカチュウ", moves=["でんこうせっか"])
player2 = Player("Player 2")
player2.add_pokemon("フシギダネ", moves=["たいあたり"])
battle = Battle(player1, player2, seed=1, damage_roll="max", critical_mode="always")
battle.start()
対戦進行系¶
| API | 概要 |
|---|---|
players (attribute) |
参加プレイヤーのタプル(コンストラクタに渡した順)。start_battle() のように Player を直接受け取れないヘルパーからでも battle.players で取得できる |
start() |
選出と初期繰り出しを完了し、以降の step() を可能にする |
step(commands=None) |
ターンを1つ進める。commands を省略すると各 Player.choose_command() に従う |
play_out(max_turns=100) |
未開始(start() 未呼び出し)なら start() を行い、決着がつくかターン上限に達するまで step() を自動的に繰り返す。戻り値はなく、結果は呼び出し後に winner/finished から取得する |
can_continue(max_turns) |
not battle.finished and battle.turn < max_turns をまとめたもの。step() を呼ぶ過程自体を観察したい手動ループ向け |
finished (property) |
poke-env互換。対戦が終了しているか |
winner (attribute) |
勝者の Player(未決着なら None)。judge_winner() を一度も呼ばないと未更新のままな点に注意(finished/play_out() 経由なら自動更新される) |
judge_winner() |
勝者を判定する(未決着なら None) |
turn (attribute) |
現在のターン数 |
while battle.can_continue(max_turns=100):
battle.step()
print(battle.winner.username if battle.winner else "決着つかず")
play_out() を使うと start() を含めて次の1行にまとめられる:
battle.play_out(max_turns=100)
winner = battle.winner
状態取得系¶
| API | 概要 |
|---|---|
get_active(player) |
指定プレイヤーの現在場に出ているポケモンを取得(交代中などは None) |
get_team(player) |
指定プレイヤーの対戦中のチーム(選出漏れの控えも含む)を取得。player.team は開始前のスナップショットで対戦中は更新されないため、HP・ひんし・状態異常などバトル中の実際の状態を見るにはこちらを使う |
available_commands(player) |
現在使用可能な Command のリストを取得。battle.phase が "action"/"switch" のときしか呼べず、それ以外の局面(例: 対戦開始前)で呼ぶと InvalidPhaseError を送出する。通常は choose_command()/choose_selection() の中(battle.step() 実行中)から呼ぶ形になり、明示的に phase を確認する必要はない |
command_to_move(player, command) |
コマンドから Move オブジェクトを取得。choose_command() の実装で使う |
create_order(player, order, *, terastal=False, megaevol=False) |
poke-env の create_order() 互換。Move/Pokemon オブジェクトから対応する Command を組み立てる(command_to_move() の逆方向)。Move なら技コマンド(terastal/megaevol 指定でテラスタル/メガシンカを伴う技コマンド)、Pokemon なら交代コマンドを返す。poke-envでは Player.choose_move() が create_order(move) で作った BattleOrder を返す仕様である。一方jpokeの Command は技・交代等の選択肢を表す単純な Enum 値なので、battle.create_order(self, move) の戻り値をそのまま choose_command() の戻り値として使える |
is_struggle_only(player) |
わるあがきしか選べない状態かどうかを判定する。available_commands(player)[0] で代用すると、交代コマンドが同時に存在する場合に誤ってそちらを返すことがあるため、判定にはこちらを使う。実際にわるあがきを選ぶ際は Command.STRUGGLE をそのまま使えばよい(SWITCH_i/MOVE_i と異なりインデックス解決が不要なため、取得専用メソッドは無い) |
active = battle.get_active(player1)
team = battle.get_team(player1) # ひんし・HP変化などを反映した実体
commands = battle.available_commands(player1)
move = battle.command_to_move(player1, commands[0])
command = battle.create_order(player1, move) # command_to_move()の逆方向
if battle.is_struggle_only(player1):
command = Command.STRUGGLE
battle.query(PokemonQuery)には他にも判定用メソッドがあるが、そのうち Pokemon/Player
単体の引数で完結するものは以下の通り Battle 直下からも呼べる(AttackContext/EventContext
を要求する内部専用メソッドは委譲していない)。resolve_secondary_chance(ctx, chance, ...) など
AttackContext/EventContext を引数に取る Battle のメソッドは、handlers/*.py のハンドラ
関数が受け取った ctx をそのまま渡す用途を想定した内部専用API。両型は
from jpoke.core import EventContext, AttackContext でインポートできる。
| API | 概要 |
|---|---|
can_switch(player) |
プレイヤーが交代可能かどうかを判定する(場のポケモンがとらわれ状態、または控えが全滅していれば不可) |
has_available_bench(player) |
とらわれ状態を無視して、控えにひんしでないポケモンが残っているかを判定する(だっしゅつパック等の強制交代判定用) |
is_floating(pokemon) |
浮いている状態か判定する(ひこうタイプ・特性・技の効果を考慮) |
is_trapped(pokemon) |
逃げられない状態か判定する(ゴーストタイプは逃げられる) |
is_nervous(pokemon) |
きんちょうかん状態か判定する |
is_hazard_immune(pokemon) |
エントリーハザードへの免疫があるか判定する |
can_use_last_resort(pokemon) |
とっておきの発動条件を満たしているか判定する |
get_forced_move_name(pokemon) |
強制行動中のポケモンが実行すべき技名を返す(固定されていなければNone) |
is_first_actor(player) / is_second_actor(player) |
このターンでplayerが先攻/後攻かどうかを判定する(1vs1想定、行動順未確定ならNone) |
calc_move_priority(attacker, move) |
指定した Pokemon/Move オブジェクトで技を発動したときの優先度(ON_MODIFY_MOVE_PRIORITYイベントによる補正込み)を計算する。jpoke.testing.calc_move_priority(battle, player_idx, move_index=0) はインデックス指定の薄いラッパーで、内部でこちらを呼ぶ |
resolve_speed_order() |
現在の実効素早さでソートしたポケモンのリストを返す(引数なし)。行動順そのものが必要な場合は予約済みコマンドを考慮する resolve_action_order() を使う |
active = battle.get_active(player1)
if battle.can_switch(player1):
...
print(battle.is_floating(active), battle.can_use_last_resort(active))
# 優先度・素早さ順の確認
priority = battle.calc_move_priority(active, active.moves[0])
speed_order = battle.resolve_speed_order()
ダメージ計算系¶
| API | 概要 |
|---|---|
calc_lethal(attacker, moves, critical=False, move_secondary=False, max_attack=10) |
指定した技(列)を最大 max_attack 回撃ち込んだ場合の致死率を計算する(確定数が出た時点で打ち切る)。moves には技名の文字列・Move・(技, ヒット数) のタプル、およびそれらのリストを渡せる。リストで複数の技を渡した場合はその順番通りに1ラウンドとして使用し(例: ["でんこうせっか", "かみなり"] は1発目にでんこうせっか、2発目にかみなり)、max_attack>1 にするとこのラウンド自体を繰り返す。防御側の状態異常・天候ダメージ(どく・やけど・すなあらし等)はダメージに自動的に合算される。critical は急所として計算するかどうか、move_secondary は追加効果ハンドラ(やけど付与等、致死率計算に組み込まれている技に限る)を適用するかどうかで、りゅうせいぐんの自傷効果のように攻撃側自身に必ず発生する効果は move_secondary の指定に関わらず常に加味される。list[LethalHitResult] を返す(各要素が1ヒットに対応し、最終的な致死率は results[-1].lethal_probability)。なお jpoke.testing.calc_lethal() はこの引数を secondary という短縮名で受け取るインデックス指定版なので注意 |
calc_damages(attacker, defender, move, critical=False) |
乱数によるダメージ幅を考慮した、可能な全ダメージ値のリスト(通常16通り)を返す |
roll_damage(attacker, defender, move, critical=False) |
calc_damages() の結果から option.damage_roll に従って1つ選んで返す |
results = battle.calc_lethal(attacker, moves="ドラゴンテール", max_attack=5)
final = results[-1]
print(f"{final.attack_count}回攻撃した時点の致死率: {final.lethal_probability:.2%}")
raw_damages = battle.calc_damages(attacker, defender, "ドラゴンテール")
one_damage = battle.roll_damage(attacker, defender, "ドラゴンテール")
シナリオ構築系¶
Pokemon.hp への直接代入や boosts の直接書き換えは禁止されている。状態を作るときは
必ず以下の Battle 経由のメソッドを使う(Pokemon.hp への直接代入自体は技術的にエラーには
ならないが、対戦シミュレーション中に使うと ON_HP_CHANGE 等のハンドラ発火・ひんし判定が
スキップされ内部状態が不整合になる。対戦を進行させる文脈では必ずこれらのメソッドを通す)。
| API | 概要 |
|---|---|
modify_hp(target, v=0, r=0, source=None, reason="") |
HPを変更する。v(固定量)と r(最大HPに対する割合、-1.0〜1.0)は同時指定不可 |
faint(target, source=None, reason="") |
対象を即座にひんしにする(modify_hp(v=-target.max_hp) の薄いラッパー) |
modify_stats(target, stats, source=None, reason="") |
複数の能力ランクを同時に変更する |
set_ailment(target, name, count=None, source=None, overwrite=True) |
状態異常を直接付与する。既定では既存の状態異常があれば上書きするが、タイプ免疫(ほのおタイプへの「やけど」等)やON_BEFORE_APPLY_AILMENT(不眠等の特性による無効化)の判定は通常の付与と同様に行う(これらで阻まれると戻り値Falseで付与されない)。overwrite=False にすると既に状態異常があるだけで付与に失敗する |
set_volatile(target, name, count=None, source=None) |
揮発性状態(やどりぎのタネ等)を直接付与する(既に同じ揮発性状態がある場合は失敗) |
set_weather(name, count=5) |
天候を直接発動する |
set_terrain(name, count=5) |
地形を直接発動する |
activate_global_field(name, count) |
グローバルフィールド効果(じゅうりょく・トリックルーム等)を直接発動する |
activate_side_field(player, name, count) |
指定プレイヤーのサイドフィールド効果(リフレクター・ステルスロック等)を直接発動する |
gain_item(target, name) |
持ち物を持たないポケモンに新規で持たせる(既に持ち物を持っている場合は失敗) |
set_item(target, name, source=None) |
現在の持ち物に関わらず任意の持ち物に直接差し替える(name="" で取り外し) |
remove_item(target, source=None, track_loss=True) |
持ち物を取り外す |
take_item(target, ignore_sticky_hold=False) |
target(持ち物を奪われる側)の持ち物を、相手(foe)が持ち物を持っていない場合のみ奪う |
swap_items(source=None, ignore_sticky_hold=False) |
場に出ている2体の持ち物を入れ替える。take_item と異なり双方が持ち物を持っていても実行できる。source に交換の発生源となるポケモンを渡すと、source 自身が持つねんちゃくは発動しない(自分から道具を交換するときは防がれない) |
consume_item(target, track_loss=True) |
持ち物を消費する(きのみの場合は食べたフラグを立ててから remove_item を呼ぶ) |
battle.modify_hp(defender, r=-0.6, reason="シナリオ構築用") # 最大HPの60%分ダメージ
battle.modify_stats(defender, {"def": 1}) # ぼうぎょ+1
battle.set_ailment(defender, "どく")
battle.set_volatile(defender, "やどりぎのタネ")
battle.activate_global_field("トリックルーム", 5)
battle.activate_side_field(player1, "ステルスロック", 1)
battle.faint(defender)
battle.gain_item(defender, "たべのこし") # 持ち物なし → 新規で持たせる
battle.set_item(defender, "きあいのタスキ") # 現在の持ち物に関わらず直接差し替える
battle.remove_item(defender) # 取り外す
set_* と activate_* の使い分け¶
上表のメソッド名の動詞が set_ailment/set_volatile/set_weather/set_terrain と
activate_global_field/activate_side_field とで異なるのは意図的な区別であり、リネームの
予定はない。
set_*(状態異常・揮発性状態・天候・地形): 対象(ポケモン、またはバトル全体)に 「単一の状態を直接セットする」メソッド。天候・地形は排他的(同時に有効なのは常に1つ)で、 新しい状態を発動すると既存の状態を置き換える。状態異常・揮発性状態も対象ポケモンに紐づく 個別の状態であり、いずれも「差し替え」のニュアンスが自然activate_*(グローバルフィールド効果・サイドフィールド効果): 複数の効果が 同時にスタックしうる(例: まきびし+どくびし+ステルスロックが同じサイドに共存)ため、 「発動」のニュアンスが強い。内部実装でもStackableFieldManager.activate()を使っており、 天候・地形が使うExclusiveFieldManager.apply()(set_weather/set_terrainの委譲先)とは 別クラスの別メソッドになっている
set_weather/set_terrain の count に既定値5があるのに対し activate_global_field/
activate_side_field に既定値が無いのも整備漏れではなく、前述と同じ理由による意図的な差である。
天候・地形は通常の発動元(技・特性)が例外なく5ターンで発動するため、単一の既定値が安全である。
(強天候〔おおひでり・おおあめ・らんきりゅう〕を発動する特性はcount=1で発動するものの、
ターン経過による自然消滅の仕組み自体を持たず特性保持者が場を離れるまで持続するため、
この既定値の判断には影響しない。詳細はset_weatherのdocstringを参照)
一方、グローバルフィールド効果はフェアリーロックのみ1ターン(他は5ターン)、サイドフィールド効果は
壁技(5ターン)・設置技(1層ずつ)・遅延効果(発動までのターン数)が同じ引数に混在するため、
単一の既定値を設けるとかえって誤ったシナリオを組んでしまう恐れがある。そのため
activate_global_field/activate_side_field では count を必須のまま維持している
(詳細は各メソッドのdocstringを参照)。
ログ系¶
| API | 概要 |
|---|---|
print_logs(turn=None) |
指定ターンのログを整形して出力する。turn="all" で1ターン目から現在までの全ログ |
get_log_lines(turn=None) |
print_logs() と同じ内容を文字列のリストとして返す(出力先を呼び出し側に委ねたい場合) |
get_event_logs(turn=None) |
LogCode 付きの構造化ログ(EventLog)を Player をキーとする辞書で返す。特定の種類のイベント(急所発生など)だけをプログラムで抽出したいときに使う |
battle.print_logs() # 現在ターンのログを表示
from jpoke.enums import LogCode
critical_hits = [
log.pokemon
for logs in battle.get_event_logs().values()
for log in logs
if log.log is LogCode.CRITICAL_HIT
]
複製系¶
| API | 概要 |
|---|---|
copy(reseed=False, copy_logs=True, omniscient=False) |
Battle インスタンスを複製する。reseed=True にすると複製側の random/decision_random を派生シードで再初期化し、木探索で兄弟ノード間の乱数系列が相関するのを避けられる(複製元の乱数系列は消費されない)。copy_logs=False にすると event_logger/command_log(対戦開始からの全履歴)をdeepcopyせず、複製先に空の新規ログを持たせる(複製元のログには影響しない)。木探索の内部シミュレーションのようにログを参照しない用途では、ターン数に比例して増える全履歴コピーのコストを避けられる。omniscient=True にすると複製先の observer を None にする。choose_command() が受け取る battle は情報隠蔽済みの観測(observer が自分自身に設定されたコピー)であることがあり、そのまま copy() すると複製先にも情報隠蔽が引き継がれてしまうため、相手の合法手もライブ計算する全知シミュレーションが前提の木探索(MinimaxPlayer 等)ではこのオプションを使う |
build_observation(observer, copy_logs=True) |
指定した observer 視点で情報を隠蔽した Battle の複製を作る(choose_command()/choose_selection() に渡される盤面)。command_manager.py/turn_controller.py から毎ターンの行動選択フェーズで呼ばれるホットパス。copy_logs の意味は copy() と同じで、既定は True(ログを引き継ぐ)。方策実装がログを参照する可能性がある汎用の呼び出し経路では既定のまま使うこと。ログを参照しないと分かっている用途(木探索の内部シミュレーション等)でのみ明示的に copy_logs=False を指定してコピー負荷を減らせる |
sim = battle.copy(reseed=True, copy_logs=False)
sim.step({player1: command1, player2: command2})
# sim.get_event_logs() は copy() 以降に発生したログのみを返す
# (複製元 battle の履歴は sim には含まれない)
copy() は盤面・ポケモンの状態を複製するが、Player インスタンス自体(battle.players
が参照するオブジェクト)は複製せず元のオブジェクトと共有する。そのため複製後の盤面(sim)
に対しても、元の Battle で使っていた player1/player2 をそのまま sim.step({player1: ...})
のキーに使える(MinimaxPlayer の探索、04_janken_nash_cfr.py のロールアウト評価などが
この性質を利用している)。
poke-env互換プロパティ¶
observer(プレイヤー視点)が設定されている前提のプロパティ群。方策実装(choose_command())に
渡される battle は観測用コピーで、battle.observer が呼び出し元プレイヤー自身に設定されている。
| API | 概要 |
|---|---|
active_pokemon |
observer視点の場のポケモン |
opponent_active_pokemon |
observerから見た相手側の場のポケモン |
available_moves |
observerが選択可能な技(Move)のリスト。わるあがきしか選べない場合はわるあがきを表す要素を1件返す(battle.is_struggle_only(self) で判定できる) |
available_switches |
observerが交代可能なポケモンのリスト |
side_conditions |
observer側のサイドフィールド状態の辞書 |
team |
observer側のチーム(list[Pokemon]。poke-envはDict[str, Pokemon]だが差異あり) |
finished / won(player) / lost(player) |
対戦終了判定・勝敗判定 |
class MyPlayer(Player):
def choose_command(self, battle: Battle) -> Command:
moves = battle.available_moves
if not moves:
return battle.available_commands(self)[0]
# battle.active_pokemon / battle.opponent_active_pokemon なども
# 自分視点の情報としてそのまま使える
...
リプレイ系¶
| API | 概要 |
|---|---|
build_replay_data() |
対戦を再現するためのリプレイデータ(BattleReplayData)を組み立てる。対戦の途中でも呼べる |
replay_battle(data)(jpoke.core.replay のモジュール関数)は BattleReplayData
(チーム+シード+選出+コマンド列)から新しい Battle インスタンスを構築し、記録された
選出・コマンドを ReplayPlayer(方策判断は一切行わず記録済みの選出・コマンドを発生順に
払い出すだけのプレイヤー)で順に払い出しながら決着まで自動的に進める(手動で step() を
呼ぶ必要はない)。内部的には元のリプレイデータと同じ乱数シードを使うため、決着後の対戦は
元の対戦とまったく同じ展開になる。
from jpoke.core.replay import replay_battle
replay_data = battle.build_replay_data()
serialized = replay_data.to_dict() # json.dumps() 可能な辞書へ
restored = type(replay_data).from_dict(serialized)
replayed_battle = replay_battle(restored) # 同じ展開の対戦を再生
Player¶
src/jpoke/core/player.py。バトルに参加するプレイヤー(人間・AI方策どちらの土台にもなる)。
Player(username: str = "")
add_pokemon()¶
add_pokemon(
name: PokemonName,
gender: Gender = "",
nature: Nature = "まじめ",
level: int = 50,
ability: AbilityName = "",
item: ItemName = "",
moves: list[MoveName] | None = None,
tera_type: Type | None = None,
evs: dict[Stat, int] | None = None,
ivs: dict[Stat, int] | None = None,
) -> Pokemon
ポケモンを1体作成し team に追加する。from jpoke import Pokemon を使わずにチームを
組める正規の追加ルート。evs/ivs 以外の引数はそのまま Pokemon.__init__ に渡される。
戻り値の Pokemon は交代先の参照などに使える。
evs/ivs はステータス名をキーとする辞書で、指定したステータスのみ生成後に
set_evs() / set_ivs() に委譲して設定する(未指定のステータスは Pokemon の既定値の
まま)。None(既定)の場合はどちらも呼ばれない。
from jpoke import Player
player = Player("Player 1")
attacker = player.add_pokemon(
"ガブリアス", nature="いじっぱり", ability="さめはだ",
item="こだわりスカーフ", moves=["じしん", "げきりん"],
evs={"atk": 32, "spe": 32}, ivs={"spa": 0},
)
team 属性の注意点¶
player.team は コンストラクタ〜対戦開始前のスナップショットであり、Battle 開始後の
対戦中はここに反映されるHP・ひんし・状態異常・ランク変化などは更新されない。対戦中の実際の
状態を見たい場合は battle.get_active(player)(場に出ているポケモン)や
battle.get_team(player)(チーム全体の実体)を使う。
choose_command() のオーバーライド¶
方策(AI)を実装するには Player を継承し choose_command() をオーバーライドする。
既定実装は「利用可能な行動コマンドの最初の1つを返す」だけの決定的な実装。
from jpoke import Battle, Player
from jpoke.enums import Command
class StrongestMovePlayer(Player):
"""毎ターン、利用可能な技の中から最も威力の高い技を選ぶプレイヤー。"""
def choose_command(self, battle: Battle) -> Command:
commands = battle.available_commands(self)
def move_power(command: Command) -> int:
if not command.is_regular_move:
return -1
move = battle.command_to_move(self, command)
return move.base_power if move.is_attack else 0
return max(commands, key=move_power)
選出番号を決める choose_selection(battle)(既定は先頭から順に選出)も同様の要領で
オーバーライドできる。
choose_command()/choose_selection() の中で確率的な判断をしたい場合は battle.decision_random
(RandomPlayer 等の既存プレイヤーが行動選択に使っているのと同じ乱数源)を使う。ダメージ・
命中判定など対戦進行そのものに使われる battle.random とは独立な系列なので、Battle(seed=...)
で固定した対戦全体の再現性を壊さずに方策側の乱数だけを扱える。
battle_against()¶
poke-env互換: 各対戦相手と n_battles 回ずつ対戦し、双方の戦績(n_finished_battles /
n_won_battles など)を更新する。ネットワークI/Oがないため同期メソッド。seed を
指定すると、対戦ごとに seed + 対戦通番から自動的に派生させたシードを使うため、
n_battles 回すべてが同一の展開になることはない。
player1.battle_against(player2, n_battles=100, seed=1)
print(f"{player1.username} 勝率: {player1.win_rate:.1%}")
on_battle_end を指定すると、各対戦の play_out() 完了直後にその対戦の Battle インスタンスを
受け取れる(poke-envにはないjpoke独自の拡張)。自己対戦のリプレイ・観測データ収集(強化学習用
など)に使う。battle_against() 自身は各対戦の Battle をループ内で使い捨てるため、これを
指定しない限り対戦後の Battle にアクセスする手段はない。ターン上限で決着がつかず戦績に
数えられなかった対戦でも呼び出される点に注意する。
replays = []
player1.battle_against(player2, n_battles=100, seed=1, on_battle_end=replays.append)
対戦成績¶
battle_against() が対戦のたびに自動更新する戦績カウンタ。手動で Battle.play_out() を
呼んだ場合は自動更新されないため、必要なら呼び出し側でインクリメントする。
| API | 概要 |
|---|---|
n_finished_battles (int) |
成立した対戦数。ターン上限で未決着だった対戦は含まない |
n_won_battles (int) |
勝利数 |
n_lost_battles (property, int) |
poke-env互換。敗北数(n_finished_battles - n_won_battles - n_tied_battles) |
n_tied_battles (property, int) |
poke-env互換。引き分け数。jpokeに引き分けは存在しないため常に0 |
win_rate (property, float) |
poke-env互換。勝率(n_won_battles / n_finished_battles)。poke-envと異なり対戦数0のときはゼロ除算を避け0.0を返す |
player1.battle_against(player2, n_battles=100, seed=1)
print(f"{player1.n_won_battles}勝{player1.n_lost_battles}敗/{player1.n_finished_battles}戦")
print(f"勝率: {player1.win_rate:.1%}")
対戦実行系メソッドの戻り値一覧¶
対戦を進めるメソッド(step() / play_out() / battle_against())はいずれも戻り値を持たず、
結果は呼び出し後に対象から取得する統一的な設計にしている。
| メソッド | 対戦結果へのアクセス手段 |
|---|---|
Battle.step(commands=None) |
呼び出し側が保持する battle から battle.winner / battle.finished を見る |
Battle.play_out(max_turns=100) |
同上。ログ等が必要なら battle.print_logs() / battle.get_event_logs() などをそのまま使う |
Player.battle_against(...) |
戦績カウンタ(n_won_battles 等)を自動更新するだけで、各対戦の Battle はループ内で使い捨てる。個々の対戦の Battle インスタンスにアクセスしたい場合は on_battle_end コールバックを使う |
battle_against() は対戦ごとに Battle を新規生成・破棄するループを内包するため、個々の
Battle を(リストとして蓄積するのではなく)on_battle_end コールバックで都度受け取る設計に
している。各対戦の event_logger の履歴等を保持し続けるリストを返す設計は、
対戦数に比例してメモリ使用量が線形に増えるため採用していない。
TreeSearchPlayer¶
src/jpoke/players/tree_search_player.py。合法手を総当たりで評価する木探索プレイヤーの
抽象度の高い基底クラス(Player のサブクラス)。合法手の列挙・ノード数管理・複数ターン先
までの再帰などの探索インフラのみを提供し、自分の合法手をどう評価するか(_score_command)
は具体的なアルゴリズムを実装するサブクラスに委ねる。TreeSearchPlayer 単体はインスタンス化
できるが、choose_command() 実行時に _score_command が呼ばれると NotImplementedError
になるため、実際に利用する際は具体的な評価アルゴリズムを持つ MinimaxPlayer
などのサブクラスを使う。
利用者は MinimaxPlayer 等を継承し、下記のフックメソッドを必要な分だけオーバーライドする
(いずれも既定実装があり、オーバーライド不要ならそのまま使える)。
コンストラクタ¶
TreeSearchPlayer(
username: str,
max_plies: int = 1,
max_nodes: int | None = None,
)
MinimaxPlayer 等のサブクラスもこのコンストラクタをそのまま継承する。
max_plies: 探索する手数(1以上)。2にすると相手の応手まで読むが、1手ごとに 分岐が「自分の合法手数×相手の合法手数」倍に増えるため、2以上を指定する場合は 評価関数の呼び出し回数に注意するmax_nodes: 展開してよいノード数(sim.step()の呼び出し回数)の上限。Noneなら無制限。到達すると以降の展開を打ち切り、その時点で見つかっている最善手を返すnodes_expanded(attribute): 直近の探索で展開したノード数(診断用)
オーバーライド可能なフック¶
| API | 概要 |
|---|---|
evaluate(battle) |
葉ノードの盤面評価。値が大きいほど自分に有利。既定は自分と相手の残りHP割合の差(決着がついている場合は勝敗を最優先し ±inf を返す) |
fallback(battle) |
(1) 相手の合法手が未公開で estimate_opponent でも推定できない局面(実対戦の初手など)、(2) 探索中に発生した割り込み交代(ひんし交代等)による choose_command() の再入時、の2箇所で使われる代替方策。既定は battle.decision_random.choice() による完全ランダム選択(Battle(seed=...) で固定した対戦全体の再現性を壊さないよう、行動選択専用の乱数系列を使う) |
estimate_opponent(battle) |
探索の最上位(choose_command/evaluate_commands)のたびに呼ばれる推定フック(相手は battle.opponent(self) で取得する。evaluate/fallback と同じ規約)。既定実装は項目別フック estimate_opponent_team(battle) を呼んだ後、estimate_opponent_selection(battle) の返り値(None でなければ)を公開済みの selected_indexes に未包含分だけマージするテンプレートメソッド。項目を横断する推定をしたい場合はこのメソッド自体をオーバーライドしてもよい |
estimate_opponent_team(battle) |
相手ポケモンのモデル(battle.get_active(battle.opponent(self)) の moves/item 等)に技・特性・アイテムの推定値を書き込むフック。既定は何もしない。書き込んだ推定情報から実際に選べるコマンドの列挙は CommandManager に任せられ、利用者は Move/Item など見慣れたドメインオブジェクトを推定するだけでよく Command 自体を組み立てる必要はない |
estimate_opponent_selection(battle) -> list[int] \| None |
相手の選出インデックス(state.team 基準、0始まり)の推定を返り値で返すフック。None なら推定しない(既定)。返したリストは estimate_opponent の既定実装が公開済みの選出とマージするため、書き込み先を利用者が直接触る必要はない |
configure_sim(sim) |
battle.copy() 直後・sim.step() 実行前に呼ばれるフック。既定は何もしない。オーバーライドして、探索中だけ有効にしたい BattleOption(命中率固定・ダメージ平均値化など)を sim に設定する。実際の battle 本体には影響しない |
いずれのフックも、観測(battle)は毎ターン再構築されるため推定は毎回書き込む・返す
必要があるが、公開済みの情報(revealed な技・選出)を上書きせず未公開分のみ補うこと
(べき等性ガイドライン)。estimate_opponent 系フック(3つのいずれか)をオーバーライド
すると、相手の合法手の有無に関わらず探索の最上位のたびに毎回呼ばれ、相手候補は
「観測スナップショット由来のコマンド」と「推定情報を CommandManager に列挙させた
コマンド」の和集合になる(公開済み候補が失われることはなく、推定由来の候補だけが
追加される。実対戦の型推定に相当)。
デバッグ用メソッド¶
| API | 概要 |
|---|---|
evaluate_commands(battle) |
現在の盤面での自分の各合法手の評価値一覧(dict[Command, float])を返す(デバッグ・読み筋確認用)。呼び出しても choose_command() の内部状態に影響しない、副作用のないメソッド。相手の合法手が未公開で空(estimate_opponent で推定してもなお空)の場合は空の辞書を返す。呼び出し中は max_nodes によるノード数上限を一時的に無効化し、自分の全合法手×相手の全合法手を max_plies の深さまで打ち切りなく評価するため、choose_command() の探索とは異なりノード数では打ち切られない点に注意(毎ターンの choose_command() 呼び出しごとにこのメソッドも呼ぶデバッグ表示に組み込む場合、探索コストが max_nodes で抑えられない) |
table = ai_player.evaluate_commands(battle)
if table:
print("評価値:", {str(cmd): round(v, 2) for cmd, v in table.items()})
MinimaxPlayer¶
src/jpoke/players/minimax_player.py。TreeSearchPlayer を継承し、
自分の各合法手について、相手が最善(自分にとって最悪)の手を選ぶと仮定したミニマックスで
評価する具体的な実装。TreeSearchPlayer の全フック(evaluate/fallback/
estimate_opponent/estimate_opponent_team/estimate_opponent_selection/
configure_sim)・コンストラクタ・デバッグ用メソッドをそのまま継承する。
実際に木探索プレイヤーを使う場合は、TreeSearchPlayer ではなく本クラス(またはその
サブクラス)をインスタンス化する。
from jpoke.players import MinimaxPlayer
class KOFocusedPlayer(MinimaxPlayer):
"""相手をひんしにできる手を優先する簡易AI(evaluate()の拡張例)。"""
def evaluate(self, battle: Battle) -> float:
base = super().evaluate(battle)
opponent_team = battle.get_team(battle.opponent(self))
n_fainted = sum(1 for mon in opponent_team if mon.fainted)
return base + n_fainted
ai_player = KOFocusedPlayer("TreeSearchAI", max_plies=1, max_nodes=50)
その他の標準実装(jpoke.players)¶
木探索系(TreeSearchPlayer/MinimaxPlayer)以外に、比較対象・ベースラインとして
すぐ使える Player 実装が jpoke.players に同梱されている。
| クラス | 概要 |
|---|---|
RandomPlayer |
合法手から battle.decision_random でランダムに1つ選ぶ。選出もランダム。既定の Player.choose_command()(常に先頭のコマンドを選ぶ決定的挙動)では battle_against() による統計比較の分散が潰れてしまう問題への対応 |
MaxDamagePlayer |
相手の場のポケモンに与える最低保証ダメージ(乱数下振れ)が最大になる技を選ぶ。技以外のコマンド(交代等)は候補にしない |
CLIPlayer |
標準入出力で人間が対話的に操作する(src/jpoke/players/cli_player.py。手動対戦・デバッグ用) |
from jpoke.players import RandomPlayer, MaxDamagePlayer
baseline = RandomPlayer("Baseline")
challenger = MaxDamagePlayer("Challenger")
baseline.battle_against(challenger, n_battles=100, seed=1)
Pokemon¶
src/jpoke/model/pokemon.py。ポケモン1体の全状態(種族値・技・特性・アイテム・状態異常など)を
管理するクラス。
コンストラクタ¶
Pokemon(
name: PokemonName,
gender: Gender = "",
nature: Nature = "まじめ", # 既定はステータス補正なし
level: int = 50,
ability_name: AbilityName = "", # 省略時は特性なし扱い
item_name: ItemName = "", # 省略時はアイテムなし
move_names: list[MoveName] | None = None, # 省略時は["はねる"]の1技のみ
tera_type: Type | None = None, # 省略時はそのポケモンの第1タイプを引き継ぐ
)
個体値・努力値はコンストラクタの引数ではなく、初期状態は個体値31・努力値0固定で
生成される。変更する場合は生成後に set_ivs() / set_evs() を呼ぶ。
from jpoke import Pokemon
mon = Pokemon(
"ガブリアス", nature="いじっぱり", ability_name="さめはだ",
item_name="こだわりスカーフ", move_names=["じしん", "げきりん"],
)
mon.set_evs([0, 32, 0, 0, 0, 0]) # こうげき努力値をChampions形式(0〜32)で最大まで振る
mon.set_ivs([31, 31, 31, 31, 31, 0])
# dict指定も可能。指定したステータスのみ更新し、未指定分は既存値を維持する
mon.set_evs({"atk": 32, "spe": 32})
mon.set_ivs({"spa": 0})
set_evs() / set_ivs()¶
set_evs(evs: list[int] | dict[Stat, int], hp_policy: HpPolicy = "keep_absolute")
set_ivs(ivs: list[int] | dict[Stat, int], hp_policy: HpPolicy = "keep_absolute")
set_evs(): 努力値をChampions形式(各値0〜32)で設定する。poke-envの努力値 (各値0〜252)とはスケールが異なるため、poke-env形式の値をそのまま渡さないこと (types/poke_env.pyのevs_from_poke_envで変換する)set_ivs(): 個体値を設定するevs/ivsはlist[int](HP・攻撃・防御・特攻・特防・素早さの順、6要素で全体を置き換え) とdict[Stat, int](指定したステータスのみ更新し、未指定のステータスは既存値を維持)の どちらでも指定できる- どちらも設定後にステータスを自動再計算する。
hp_policyは最大HPが変化したときの現在HPの 追従方法を指定する引数(Pokemon.set_levelなど他のステータス変更系メソッドにも共通)
show()¶
mon.show() # 実数値・性格・特性・持ち物・テラスタイプ・技構成をまとめて表示
出力先を選びたい場合は render_info()(文字列を返すだけで print しない)を使う。
状態読み取り系¶
| API | 概要 |
|---|---|
status (property) |
poke-env互換。状態異常名(ailment.name のエイリアス) |
has_ailment(*ailment_names) |
指定した状態異常のいずれかを持っているか |
has_volatile(volatile_name) |
指定した揮発性状態を持っているか |
fainted (property) |
HPが0(ひんし)かどうか |
alive (property) |
HPが0より大きいかどうか |
hp / max_hp / hp_fraction |
現在HP/最大HP/HP割合 |
has_item(name=None, consider_enabled=False) |
アイテムを持っているか |
has_move(move) |
指定した技を持っているか |
print(mon.status, mon.has_ailment("どく"), mon.has_volatile("こんらん"))
print(mon.fainted, mon.hp, mon.max_hp)
シナリオ構築系(フォルム変化)¶
| API | 概要 |
|---|---|
set_form(name, hp_policy="keep_absolute", set_default_ability=False) |
フォルムをエイリアス(図鑑上の別名)指定で切り替える。種族値・タイプ・特性候補が変更先のものに差し替わる(ロトムの姿、ザシアン/ザマゼンタの剣王/盾王、ディアルガ等のオリジンフォルムなど)。既に同じフォルムなら何もせず False を返す。hp_policy は最大HPが変化したときの現在HPの追従方法(set_evs/set_ivsと共通)。set_default_ability=True の場合、特性を変更先の先頭特性にリセットする |
mon = Pokemon("ロトム") # でんき/ゴースト
mon.set_form("ヒートロトム") # でんき/ほのお に切り替わる(種族値・タイプ込み)
print(mon.types, mon.stats)
Battle の「シナリオ構築系」(modify_hp/set_ailment等、上記参照)と
同じく対戦を進行させずに状態を直接組み立てるためのメソッドだが、set_form は Pokemon
自身のメソッドである点に注意(Battle 側に委譲ラッパーは無く、mon.set_form(...) の形で
直接呼ぶ)。
POKEDEX(図鑑データ)¶
jpoke.data.POKEDEX。バトルを実行せず、ポケモンごとの静的なデータ(持てる特性・
覚えられる技)だけを調べたい場合に使う。
| API | 概要 |
|---|---|
POKEDEX[name].abilities |
そのポケモンが持てる特性のリスト(通常特性1・2・隠れ特性の順)。持てる特性が1つや2つしかないポケモンでは、存在しない枠は含まれず短いリストになる |
POKEDEX[name].learnset |
そのポケモンが覚えられる技のリスト(list[MoveName]、五十音順にソート済み) |
POKEDEX[name].regulations |
そのポケモンが使用可能なレギュレーションの集合(set[Regulation]) |
from jpoke.data import POKEDEX
print(POKEDEX["ピカチュウ"].abilities) # 持てる特性(通常特性1・2・隠れ特性の順)
print(len(POKEDEX["ピカチュウ"].learnset)) # 覚えられる技の総数
print(POKEDEX["ピカチュウ"].regulations) # 使用可能なレギュレーション
レギュレーション別の一覧取得¶
jpoke.get_pokemon_by_regulation() / jpoke.get_items_by_regulation()。指定した
レギュレーション(Regulation)で使用可能なポケモン名・アイテム名の一覧を、
POKEDEX / ITEMS 全件から逆引きで取得する。戻り値はいずれも五十音順にソート済みの
list。
from jpoke import get_pokemon_by_regulation, get_items_by_regulation
pokemon_list = get_pokemon_by_regulation("M-A") # -> list[PokemonName](五十音順)
item_list = get_items_by_regulation("M-A") # -> list[ItemName](五十音順)
Command¶
src/jpoke/enums/command.py。プレイヤーの1回の行動(技使用・交代・テラスタル等)を表す
Enum。Player.choose_command() の戻り値、Battle.step(commands=...) の値として使う。
from jpoke import Command(トップレベルパッケージからの再エクスポート)でも
from jpoke.enums import Command と同じものが取得できる。
定数¶
命名規則は {種別}_{インデックス}(インデックスは0〜9、手持ち・技のスロット番号に対応)。
| 定数 | 概要 |
|---|---|
Command.MOVE_0 〜 Command.MOVE_9 |
技コマンド(インデックスは Pokemon.moves の順) |
Command.SWITCH_0 〜 Command.SWITCH_9 |
交代コマンド(インデックスは Player.team の順) |
Command.TERASTAL_0 〜 Command.TERASTAL_9 |
テラスタル+技使用コマンド |
Command.MEGAEVOL_0 〜 Command.MEGAEVOL_9 |
メガシンカ+技使用コマンド |
Command.GIGAMAX_0 〜 Command.GIGAMAX_9 |
ダイマックス+技使用コマンド(未実装、下記注記参照) |
Command.ZMOVE_0 〜 Command.ZMOVE_9 |
Zワザ使用コマンド(未実装、下記注記参照) |
Command.STRUGGLE |
わるあがき(技のPPが全て0の場合に強制される) |
Command.FORCED |
強制再行動(きゅうしょにあたる等、選択の余地がない行動) |
注記:
GIGAMAX_*/ZMOVE_*はダイマックス・Zワザに対応するための定義だが、本プロジェクトの 対象範囲(README.md 対象範囲参照)であるポケモンチャンピオンズの シングルバトルにダイマックス・Zワザは存在しないため未実装。available_commands()が これらのコマンドを選択肢として返すことはなく、battle.step()に明示的に渡した場合も常に わるあがき扱いになる(command_manager.pyのresolve_move_from_command()を参照)。将来的な 拡張やAPIとしての完全性のためにCommandの定義自体は残しているが、現時点では使用しないこと。
from jpoke.enums import Command
battle.step({player1: Command.MOVE_0, player2: Command.SWITCH_1})
クラスメソッド¶
インデックスから対応するコマンドを組み立てる際に使う。available_commands() の結果を
手作業で組み立てたい場合や、決まったインデックスの技・交代先を指定したい場合に使う。
| API | 概要 |
|---|---|
Command.get_move_command(index) |
指定インデックスの技コマンドを取得 |
Command.get_switch_command(index) |
指定インデックスの交代コマンドを取得 |
Command.get_terastal_command(index) |
指定インデックスのテラスタルコマンドを取得 |
Command.get_megaevol_command(index) |
指定インデックスのメガシンカコマンドを取得 |
Command.get_gigamax_command(index) |
指定インデックスのダイマックスコマンドを取得(未実装、上記注記参照) |
Command.get_zmove_command(index) |
指定インデックスのZワザコマンドを取得(未実装、上記注記参照) |
from jpoke.enums import Command
# battle.get_team(player) 内でのインデックスから交代コマンドを組み立てる
bench_index = battle.get_team(player).index(bench_pokemon)
switch_command = Command.get_switch_command(bench_index)
battle.step({player: switch_command, opponent: Command.MOVE_0})
インスタンスプロパティ・メソッド¶
battle.available_commands(player) で取得した Command の種別判定に使う。
| API | 概要 |
|---|---|
is_type(command_type) |
指定した種別("any" / "move" / "switch")かどうか。"move" は通常技コマンドに加え、テラスタル・メガシンカ・ダイマックス・Zワザを伴う技コマンドも含む(is_regular_move は通常技コマンドのみ) |
is_regular_move (property) |
技コマンド(MOVE_*)かどうか |
is_switch (property) |
交代コマンド(SWITCH_*)かどうか |
is_terastal (property) |
テラスタルコマンドかどうか |
is_megaevol (property) |
メガシンカコマンドかどうか |
is_gigamax (property) |
ダイマックスコマンドかどうか(未実装、上記注記参照) |
is_zmove (property) |
Zワザコマンドかどうか(未実装、上記注記参照) |
index (property) |
コマンドのインデックス(特殊コマンドは0) |
def choose_command(self, battle: Battle) -> Command:
commands = battle.available_commands(self)
move_commands = [c for c in commands if c.is_regular_move]
return move_commands[0] if move_commands else commands[0]
Move¶
src/jpoke/model/move.py。技1つ分のデータと現在のPPを保持するクラス。
Pokemon.moves の要素、battle.command_to_move(player, command) の戻り値、
battle.available_moves の要素として得られる。
Move(name: MoveName)
通常は Pokemon のコンストラクタ(move_names=[...])経由で生成されるため、直接
インスタンス化する機会は少ない。
主要属性¶
| API | 概要 |
|---|---|
name (property) |
技名 |
pp / current_pp |
現在のPP(current_pp はpoke-env互換のエイリアス) |
max_pp (property) |
最大PP |
type |
技のタイプ(一部の効果で戦闘中に変化しうる) |
base_power |
技の威力。変化技は None |
category |
"physical" / "special" / "status" |
priority (property) |
技の優先度 |
accuracy (property) |
命中率。None の場合は必中 |
target (property) |
技の対象("foe" / "self" など) |
crit_ratio (property) |
急所ランク補正値 |
move = battle.command_to_move(player1, Command.MOVE_0)
print(move.name, move.type, move.category, move.base_power, move.pp)
判定系プロパティ¶
| API | 概要 |
|---|---|
is_attack (property) |
物理・特殊技(攻撃技)かどうか。変化技は False |
is_blocked_by_protect (property) |
「まもる」で防がれる技かどうか |
is_reflectable (property) |
マジックコート・マジックミラーで跳ね返される技かどうか |
has_flag(flag) |
指定した技フラグ(MoveFlag)を持つか。リストを渡すといずれか1つ持てば True |
if move.is_attack:
print(f"{move.name} の威力: {move.base_power}")
print(move.has_flag("sound")) # 音技かどうか
print(move.has_flag(["punch", "bite"])) # パンチ技かかみつき技のどちらか
連続技系¶
| API | 概要 |
|---|---|
min_hits (property) |
最小ヒット数(連続技でなければ1) |
max_hits (property) |
最大ヒット数(連続技でなければ1) |
expected_hits (property) |
poke-env互換の期待ヒット数(2〜5回技は分布 2:3:4:5=35:35:15:15 に基づく3.1固定) |
print(f"{move.name}: {move.min_hits}〜{move.max_hits}回技、期待ヒット数 {move.expected_hits:.1f}")
PP操作¶
| API | 概要 |
|---|---|
modify_pp(v) |
PPを v 分だけ増減する(0〜最大PPの範囲でクリップ) |
move.modify_pp(-1) # 技を1回使用した分PPを減らす
move.modify_pp(-99) # PPを0にする(わるあがきを誘発させたい場合など)
PokeAPIユーティリティ¶
src/jpoke/utils/pokeapi.py。ポケモン・アイテム・タイプの和名から
PokeAPI のエンドポイントURL・画像URLを組み立てる。
ネットワークアクセスは行わず、リポジトリ同梱の対応表(和名→PokeAPI ID)を
参照してURL文字列を返すだけの薄いユーティリティ。
| API | 概要 |
|---|---|
get_pokeapi_url(name_ja, category="pokemon") |
ポケモン/アイテムの和名からPokeAPIエンドポイントURL(https://pokeapi.co/api/v2/{category}/{id}/)を返す |
get_pokemon_image_url(name_ja, image_type="official-artwork") |
ポケモンの和名から画像URLを返す。image_type で front-shiny/home/showdown-front-default など20種類の見た目を選べる |
get_item_image_url(name_ja) |
アイテムの和名から画像URLを返す |
get_type_image_url(type_name) |
タイプの和名(Type、19種)から通常タイプバッジ画像URLを返す |
get_tera_type_image_url(type_name) |
タイプの和名からテラスタルタイプアイコン画像URLを返す |
download_pokemon_image(name_ja, dest, image_type="official-artwork") |
ポケモンの和名から画像を取得し dest に保存する(Path を返す) |
download_item_image(name_ja, dest) |
アイテムの和名から画像を取得し dest に保存する(Path を返す) |
いずれも和名が解決できない場合(対応表に存在しない、Type の ""=タイプなしを渡した場合など)
PokeApiResolveError(jpoke.exceptions)を送出する。download_* はこれに加えてネットワーク
アクセスを伴うため、保存先ディレクトリが無ければ自動作成した上でファイルに書き込む。
from jpoke import get_pokemon_image_url, get_item_image_url, get_type_image_url, get_tera_type_image_url
print(get_pokemon_image_url("ピカチュウ", image_type="home-shiny"))
print(get_item_image_url("たべのこし"))
print(get_type_image_url("でんき"))
print(get_tera_type_image_url("でんき"))
和名とPokeAPI側ID/名前の対応が取れないポケモン・アイテムが一部存在する
(非公式アイテム名など)。全件の名前解決可否・URL到達性を確認したい場合は
scripts/pokeapi/validate_urls.py を手動実行する(PokeAPI/GitHubへの
アクセスが多数発生するため、テストスイートには含めていない)。
テストユーティリティ(jpoke.testing)¶
src/jpoke/testing.py。上記の Battle / Player / Pokemon を毎回組み立てる代わりに、
状態異常・揮発性状態・天候・場の効果などを指定してバトルを一発でセットアップできる
薄いヘルパー集。tests/test_utils.py にあった内部テスト専用ヘルパーが本体パッケージへ
昇格したもので、pip install jpoke だけで(jpoke リポジトリを clone せずに)
ピンポイントな状態検証・技の実行・行動順の確認などができる。
対戦オブジェクトの内部属性を直接差し替えるモンキーパッチ(ダメージ・乱数固定用の
fix_damage() / fix_random() など)はAPI安定性の対象外とするため含めていない。
リポジトリ内のテストで使う場合は tests/test_utils.py を参照。
from jpoke import Pokemon
from jpoke.testing import start_battle, run_move, calc_lethal
# start_battle() は Battle(...).start() に加えて、状態異常・揮発性状態・天候・
# 場の効果・命中率固定などをまとめて指定できる
battle = start_battle(
team0=[Pokemon("ピカチュウ", move_names=["でんこうせっか"])],
team1=[Pokemon("フシギダネ", move_names=["たいあたり"])],
weather=("はれ", 5),
accuracy=100, # 命中率を固定
secondary_chance=1.0, # 追加効果を必ず発動
)
# run_move() は指定インデックスのポケモンが指定インデックスの技を使い、ログを出力する
run_move(battle, player_idx=0, move_idx=0)
# calc_lethal() は Battle.calc_lethal() のインデックス指定版
results = calc_lethal(battle, player_idx=0, moves="でんこうせっか", max_attack=3)
print(results[-1].lethal_probability)
| API | 概要 |
|---|---|
start_battle(team0, team1, ...) |
チーム・状態異常・揮発性状態・天候・地形・場の効果・命中率固定などを指定して Battle を初期化し start() まで済ませる |
run_move(battle, player_idx, move_idx=0) |
指定インデックスのポケモンに指定インデックスの技を使わせ、ログを出力する |
run_switch(battle, player_idx, new_idx) |
指定インデックスのポケモンに交代させる |
can_switch(battle, player_idx) |
指定プレイヤーが交代可能か判定する |
apply_ailment(battle, player_idx, ailment_name, count=1, by_foe=False, overwrite=False) |
指定インデックスのポケモンに状態異常を直接付与する |
change_item(battle, mon, item_name, source=None) |
ポケモンのアイテムを変更する |
get_action_order(battle, command0=None, command1=None) |
コマンドを予約し、そのターンの行動順を取得する |
reserve_command(battle, command0=None, command1=None) |
step() を介さずコマンド予約状態だけを作る(行動順・優先度だけを検証したい場合) |
build_context(battle, player_idx, move_idx=0) |
AttackContext を組み立てる |
calc_lethal(battle, player_idx, moves, critical=False, secondary=False, max_attack=10) |
Battle.calc_lethal() のインデックス指定版 |
calc_move_priority(battle, player_idx, move_index=0) |
指定インデックスの技を使ったときの優先度を返す。Battle.calc_move_priority(pokemon, move) のインデックス指定版 |
end_turn(battle) |
Battle.end_turn() のラッパー |
CustomPlayer |
常に利用可能な最初のコマンドを選択する Player 実装。上記ヘルパーの内部で使われる |