フェーズ 5 クリア判定と、やり直し

トップページ ／ step2 概要 ／ フェーズ 5

ゴール

いまは荷物をゴールに乗せても何も起こりません。壁ぎわに押しつけて詰んだら、 ウィンドウを閉じるしかありません。ここでゲームとして成立させます。 すべての荷物がゴールに乗ったらクリア、R キーでいつでも最初から——の 2 つです。 フェーズ 4 のコードに 26 行ほど書き足して、できあがりは 218 行になります。

その前に：主人公の透過色を変えました

フェーズ 4 を動かしたあと、主人公の目を黒くしたいという話になりました。 ところが黒は描いても出てきません。透過色（colkey）に黒を指定していたからです。

pyxel.blt() の最後の引数は「この 1 色だけは描かない」という指定です。 主人公の絵は背景を黒で塗っていたので、黒＝背景として抜いていました。 目も同じ黒で描いたので、目も背景と区別されずに抜けてしまうわけです。

直し方は 2 段階です。リソースエディタで、絵の背景をグレー（色番号 13）に塗り替える。 そしてコード側の pyxel.COLOR_BLACK を pyxel.COLOR_GRAY に変える—— 主人公を描いている blt の 1 か所だけです。

        pyxel.blt(px, py, 0, self.player_dir * TILE, v, TILE, TILE, pyxel.COLOR_GRAY)

1. 考え方

1-1. クリアとは「荷物の下が、ぜんぶゴールだった」こと

ゴールの位置は tiles に残っています。 地図の O は、荷物や主人公とちがってどこへも動きません。 だから調べることは 1 つだけです。

荷物のいるマスの地形が "O" かどうか。 これを荷物 1 つずつについて調べて、全部そろっていればクリアです。

1-2. どこでクリアを調べるか——見た目が変わります

調べる中身は決まりました。次はいつ調べるかです。これで画面の印象が変わります。 候補は 2 つあります。

フェーズ 4 で作った「盤面の位置」と「見た目の位置」の差が、そのまま出てくる話です。 盤面の判定はキーを押した瞬間、見せ方は着いた瞬間——この使い分けを覚えておいてください。

1-3. やり直しは「控えを戻す」より「作り直す」

R でステージの最初に戻したい。まず思いつくのは、 始めの状態を控えておいて、それを戻すやり方です。

# 最初に控えを取っておいて……
self.backup = self.boxes

# R が押されたら、戻す
self.boxes = self.backup

ところが、これは 1 文字も動きません。
フェーズ 3 の 6-2「リストは中身が共有される」で見た話が、 今度は困る側で出てきます。

2. このフェーズで使う機能

3. 手順

6 段階です。3-2 から 3-6 は続きものなので、最後まで書いてから実行してください。

3-1. 「ゴールに乗った荷物」の絵を 1 枚描く

リソースエディタ（pyxel edit sokoban.pyxres）を開き、 イメージバンク 0 の u = 32, v = 0 に 1 枚描きます。 場所は フェーズ 1 の配置図のとおり、タイルの段のいちばん右です。

3-2. 定数を 1 つ足す

U_FLOOR = 0
U_WALL = 8
U_GOAL = 16
U_BOX = 24
U_BOX_ON_GOAL = 32      # ゴールに乗っている荷物      ← 足す

3-3. load_stage() に、クリアの旗を足す

self.pushing = False のうしろに 1 行です。

        self.walk_timer = 0             # 0 なら止まっている。1〜8 は歩いている途中
        self.pushing = False            # いまの一歩で、荷物を押しているか
        self.cleared = False            # このステージをクリアしたか      ← 足す

3-4. 調べるメソッドを 2 つ足す

move_box() と try_move() のあいだに書きます。 どちらも調べて答えるだけで、盤面を変えません。

    def on_goal(self, box):
        """その荷物が、ゴールのマスに乗っているか"""
        return self.tiles[box[1]][box[0]] == "O"

    def is_cleared(self):
        """すべての荷物がゴールに乗ったか"""
        return all(self.on_goal(box) for box in self.boxes)

3-5. update() を書き換える

先頭に 4 行、到着したところに 2 行、そして最後の if の条件を書き換えます。

    def update(self):
        """フレーム毎の更新処理"""
        if pyxel.btnp(pyxel.KEY_R):             # いつでも、最初からやり直せる      ← 足す
            self.load_stage(STAGE1)
            return

        if self.walk_timer > 0:                 # 歩いている途中
            self.walk_timer += 1
            if self.walk_timer > MOVE_FRAMES:   # 隣のマスに着いた
                self.walk_timer = 0
                self.from_x = self.player_x     # 見た目を、いまいるマスに合わせる
                self.from_y = self.player_y
                self.pushing = False
                if self.is_cleared():           # 着いた、その瞬間に調べる      ← 足す
                    self.cleared = True

        # 止まっていて、まだクリアしていないときだけ、キーを見る      ← 条件を足す
        if self.walk_timer == 0 and not self.cleared:
            self.handle_key()

3-6. draw() を 2 か所書き換える

荷物の blt を 3 行ぶんふくらませ、draw() のいちばん下に 5 行足します。

            u = U_BOX
            if self.on_goal(box):               # ゴールに乗っているあいだは別の絵      ← 足す
                u = U_BOX_ON_GOAL
            pyxel.blt(bx, by, 0, u, V_TILE, TILE, TILE, pyxel.COLOR_BLACK)

U_BOX と直接書いていたところが u に変わっている点に注意してください。 そして、いちばん下です。

        # クリアしたら、画面の上に知らせる
        if self.cleared:
            msg = "STAGE CLEAR!"
            x = (SCREEN_WIDTH - len(msg) * 4) // 2
            pyxel.text(x, 3, msg, pyxel.COLOR_YELLOW)

4. できあがりのコード

書き足したのは定数 1 つ、load_stage() の 1 行、update() の 6 行、 新しい on_goal() と is_cleared()、そして draw() の 2 か所です。

# sokoban.py
# step2 フェーズ5：クリア判定と、やり直し

import pyxel

SCREEN_WIDTH = 160
SCREEN_HEIGHT = 120
TILE = 8                # 1 マスの大きさ（ドット）
HUD_HEIGHT = 12         # 画面の上、手数などを出すために空けておく高さ
MOVE_FRAMES = 8         # 隣のマスへ移りきるまでにかけるフレーム数

# イメージバンク 0 の、切り出し位置
V_TILE = 0              # タイルの段
V_PLAYER_A = 8          # 主人公の段（コマ A）
V_PLAYER_B = 16         # 主人公の段（コマ B・足を入れ替えた絵）
U_FLOOR = 0
U_WALL = 8
U_GOAL = 16
U_BOX = 24
U_BOX_ON_GOAL = 32      # ゴールに乗っている荷物

# 向き。この番号がそのまま主人公の絵の切り出し位置になる
DIR_DOWN = 0
DIR_UP = 1
DIR_LEFT = 2
DIR_RIGHT = 3

# 向きごとの、1 歩ぶんのずれ（x のずれ, y のずれ）
MOVES = [
    (0, 1),         # 下
    (0, -1),        # 上
    (-1, 0),        # 左
    (1, 0),         # 右
]

# ステージの地図
# # 壁  . 床  O ゴール  $ 荷物  @ 主人公
STAGE1 = [
    "########",
    "#......#",
    "#..O.O.#",
    "#..$.$.#",
    "#..@...#",
    "########",
]

class App:
    def __init__(self):
        """起動時の設定"""
        pyxel.init(SCREEN_WIDTH, SCREEN_HEIGHT, title="Sokoban")
        pyxel.load("sokoban.pyxres")
        self.load_stage(STAGE1)
        pyxel.run(self.update, self.draw)

    def load_stage(self, rows):
        """文字の地図を読んで、壁・主人公・荷物に分ける"""
        self.tiles = []
        self.boxes = []
        self.player_dir = DIR_DOWN      # はじめは下を向いている
        self.walk_timer = 0             # 0 なら止まっている。1〜8 は歩いている途中
        self.pushing = False            # いまの一歩で、荷物を押しているか
        self.cleared = False            # このステージをクリアしたか

        for y in range(len(rows)):
            line = []
            for x in range(len(rows[y])):
                mark = rows[y][x]
                if mark == "@":
                    self.player_x = x
                    self.player_y = y
                    mark = "."          # 主人公の足元は床
                elif mark == "$":
                    self.boxes.append([x, y])
                    mark = "."          # 荷物の下も床
                line.append(mark)
            self.tiles.append(line)

        self.from_x = self.player_x     # 見た目の出発マス
        self.from_y = self.player_y

        # 盤面を画面の中央に置くための、ずらし幅
        board_w = len(self.tiles[0]) * TILE
        board_h = len(self.tiles) * TILE
        self.ox = (SCREEN_WIDTH - board_w) // 2
        self.oy = HUD_HEIGHT + (SCREEN_HEIGHT - HUD_HEIGHT - board_h) // 2

    def update(self):
        """フレーム毎の更新処理"""
        if pyxel.btnp(pyxel.KEY_R):             # いつでも、最初からやり直せる
            self.load_stage(STAGE1)
            return

        if self.walk_timer > 0:                 # 歩いている途中
            self.walk_timer += 1
            if self.walk_timer > MOVE_FRAMES:   # 隣のマスに着いた
                self.walk_timer = 0
                self.from_x = self.player_x     # 見た目を、いまいるマスに合わせる
                self.from_y = self.player_y
                self.pushing = False
                if self.is_cleared():           # 着いた、その瞬間に調べる
                    self.cleared = True

        # 止まっていて、まだクリアしていないときだけ、キーを見る
        if self.walk_timer == 0 and not self.cleared:
            self.handle_key()

    def handle_key(self):
        """矢印キーを見て、押された向きへ 1 歩進もうとする"""
        if pyxel.btn(pyxel.KEY_DOWN):
            self.try_move(DIR_DOWN)
        elif pyxel.btn(pyxel.KEY_UP):
            self.try_move(DIR_UP)
        elif pyxel.btn(pyxel.KEY_LEFT):
            self.try_move(DIR_LEFT)
        elif pyxel.btn(pyxel.KEY_RIGHT):
            self.try_move(DIR_RIGHT)

    def has_box(self, x, y):
        """そのマスに荷物があるかどうかを答える"""
        for box in self.boxes:
            if box[0] == x and box[1] == y:
                return True
        return False

    def move_box(self, x, y, dx, dy):
        """(x, y) にある荷物を、(dx, dy) だけ動かす"""
        for box in self.boxes:
            if box[0] == x and box[1] == y:
                box[0] += dx
                box[1] += dy
                return

    def on_goal(self, box):
        """その荷物が、ゴールのマスに乗っているか"""
        return self.tiles[box[1]][box[0]] == "O"

    def is_cleared(self):
        """すべての荷物がゴールに乗ったか"""
        return all(self.on_goal(box) for box in self.boxes)

    def try_move(self, direction):
        """その向きへ動けるか調べて、動けるときだけ 1 マス進む"""
        self.player_dir = direction     # 動けなくても、向きだけは変える

        dx, dy = MOVES[direction]
        next_x = self.player_x + dx
        next_y = self.player_y + dy

        if self.tiles[next_y][next_x] == "#":   # 行き先が壁なら
            return                              # 何もしないで戻る

        if self.has_box(next_x, next_y):        # 行き先に荷物があるなら
            far_x = next_x + dx                 # 荷物の、1 つ先のマス
            far_y = next_y + dy
            if self.tiles[far_y][far_x] == "#": # その先が壁なら押せない
                return
            if self.has_box(far_x, far_y):      # その先に別の荷物があっても押せない
                return
            self.move_box(next_x, next_y, dx, dy)
            self.pushing = True                 # この一歩は、荷物を押している

        self.player_x = next_x
        self.player_y = next_y
        self.walk_timer = 1                     # ここから 8 フレームかけて歩く

    def slide_pos(self, origin, from_cell, to_cell):
        """出発マスから到着マスへ、いまどこまで来たかをドットで返す"""
        moved = (to_cell - from_cell) * TILE * self.walk_timer // MOVE_FRAMES
        return origin + from_cell * TILE + moved

    def draw(self):
        """描画処理"""
        pyxel.cls(pyxel.COLOR_BLACK)

        # 壁を、上の行から 1 マスずつ描く
        for y in range(len(self.tiles)):
            for x in range(len(self.tiles[y])):
                mark = self.tiles[y][x]
                if mark == "#":
                    u = U_WALL
                elif mark == "O":
                    u = U_GOAL
                else:
                    u = U_FLOOR
                pyxel.blt(self.ox + x * TILE, self.oy + y * TILE,
                            0, u, V_TILE, TILE, TILE)

        # 荷物。押している 1 つだけは、主人公といっしょにすべる
        dx, dy = MOVES[self.player_dir]
        push_x = self.player_x + dx             # 押した荷物は、主人公の目の前にいる
        push_y = self.player_y + dy
        for box in self.boxes:
            if self.pushing and box[0] == push_x and box[1] == push_y:
                bx = self.slide_pos(self.ox, box[0] - dx, box[0])
                by = self.slide_pos(self.oy, box[1] - dy, box[1])
            else:
                bx = self.ox + box[0] * TILE
                by = self.oy + box[1] * TILE
            u = U_BOX
            if self.on_goal(box):               # ゴールに乗っているあいだは別の絵
                u = U_BOX_ON_GOAL
            pyxel.blt(bx, by, 0, u, V_TILE, TILE, TILE, pyxel.COLOR_BLACK)

        # 主人公
        px = self.slide_pos(self.ox, self.from_x, self.player_x)
        py = self.slide_pos(self.oy, self.from_y, self.player_y)
        v = V_PLAYER_A
        if self.walk_timer >= MOVE_FRAMES // 2:     # 歩きの後半は、足を入れ替える
            v = V_PLAYER_B
        pyxel.blt(px, py, 0, self.player_dir * TILE, v, TILE, TILE, pyxel.COLOR_GRAY)

        # クリアしたら、画面の上に知らせる
        if self.cleared:
            msg = "STAGE CLEAR!"
            x = (SCREEN_WIDTH - len(msg) * 4) // 2
            pyxel.text(x, 3, msg, pyxel.COLOR_YELLOW)

App()

5. 実行する

cd step2
python sokoban.py

6. コードの解説

6-1. all() と、for を後ろに書く書き方

        return all(self.on_goal(box) for box in self.boxes)

はじめて見ると、for が後ろにあるのが不思議に見えると思います。 これは「リストの全員について、この値を出す」を 1 行で書く書き方です。 いつもの for で書くと、こうなります。

# ぜんぶ書き出した版（同じ意味）
    def is_cleared(self):
        for box in self.boxes:
            if not self.on_goal(box):
                return False        # 1 つでも乗っていなければ、その場でおしまい
        return True                 # 最後まで来たなら、ぜんぶ乗っていた

どちらでも正しく動きます。 今回 all() を選んだのは、読んだとおりの意味になるからです。 「all（すべて）が on_goal（ゴールに乗っている）」と、 英語の文のように読めます。

6-2. クリアした同じフレームに、もう一歩進んでしまう話

and not self.cleared を書かないと何が起きるか、 実際に走らせて 1 フレームずつ記録しました。 最後の一歩を ↑ を押しっぱなしで決めたときの動きです。

9 フレーム目を見てください。cleared が True になった、その同じフレームで リンゴが [5,2] から [5,1] へ動いています。 ゴールから押し出してしまったのです。結果はこうなります。

STAGE CLEAR! と出ているのに、リンゴはゴールの上にない
（is_cleared() は False なのに、cleared は True のまま）

理由は、フェーズ 4 でわざとそう作ったところにあります。 update() の 2 つの if は else ではないので、 「着いた」と「次のキーを見る」が同じフレームに起きます。 なめらかに歩かせるための仕組みが、そのままここへ効いてきます。

        if self.walk_timer > 0:
            ...
                self.walk_timer = 0            # ← 0 になる
                if self.is_cleared():
                    self.cleared = True        # ← 同じフレームで True になる

        if self.walk_timer == 0 and not self.cleared:   # ← だからここで止める
            self.handle_key()

6-3. リストのコピーは、どこまでが「別もの」か

1-3 の図を、実際に動かして確かめた結果です。すべて実測です。

>>> boxes = [[3, 3], [5, 3]]
>>> backup = boxes          # 名札を増やすだけ
>>> backup is boxes
True
>>> boxes[0][1] -= 1        # リンゴを 1 マス押した
>>> backup
[[3, 2], [5, 3]]            # 控えも動いている

>>> boxes = [[3, 3], [5, 3]]
>>> backup = boxes[:]       # 外側だけ新しく作る（浅いコピー）
>>> backup is boxes
False                       # 外側は別もの
>>> backup[0] is boxes[0]
True                        # でも中身は同じもの
>>> boxes[0][1] -= 1
>>> backup
[[3, 2], [5, 3]]            # やはり控えも動いている

boxes[:] のほかに list(boxes) と boxes.copy() も ありますが、3 つとも同じ「浅いコピー」です。中の [x, y] は共有されます。

ちゃんと控えを取るなら、中身まで作り直します。

>>> boxes = [[3, 3], [5, 3]]
>>> backup = [box[:] for box in boxes]    # 1 つずつコピーして、新しいリストに
>>> backup[0] is boxes[0]
False                                    # 中身も別もの
>>> boxes[0][1] -= 1
>>> backup
[[3, 3], [5, 3]]                         # 控えは無事

import copy して copy.deepcopy(boxes) と書く方法もあり、結果は同じです。

>>> STAGE1[1][3] = "."
TypeError: 'str' object does not support item assignment

6-4. R だけ btnp にする理由

フェーズ 4 で矢印キーを btnp から btn に変えました。 なのに R は btnp です。これは矛盾ではありません。

もし R を btn にすると、押しているあいだずっと初期状態に戻され続けます。 R を押しながら矢印を押しても1 歩も進めません——毎フレーム return で 引き返してしまうからです。btnp なら 1 フレーム目だけ効き、 2 フレーム目からは矢印が通ります（これも実測で確認しました）。

6-5. 荷物の絵は、毎フレーム選び直しています

            u = U_BOX
            if self.on_goal(box):
                u = U_BOX_ON_GOAL

ここで大事なのは、「乗った」「外した」を覚えていないことです。 毎フレーム、いまの位置を見て、その場で絵を決めています。

だからゴールから押し出したときに「絵を戻す」処理がいりません。 覚えていないものは、戻し忘れることもありません。 これはフェーズ 1 で「地形と荷物を分けて持つ」と決めたことの、そのままの成果です。

7. うまくいかないときは

8. 次のフェーズ

これで1 ステージぶんのゲームが完成しました。解ける、勝てる、やり直せる—— ゲームとして必要なものは、ぜんぶそろっています。

次はステージを 10 個にします。 ここでうれしいのは、ほとんど書き足すものがないことです。 load_stage() が「文字の地図をもらって、遊べる状態を作る」形になっているので、 地図を並べたリストを用意して、番号で渡すだけです。