Cocos2d のイベント,キーコード,イベントハンドラ,アクション

目次

1. エグゼクティブサマリー

Cocos2d は2次元ゲームのフレームワークである.Python で動作する. (Cocos2d から派生した Cocos2d-x は iOS や Android でも動き,普及している.)

このページでは,次の事項を見本プログラムで演習する.

関連する資料:Cocos2d の概要 [PDF], [パワーポイント]

関連する資料:ゲームエンジン[PDF], [パワーポイント]

関連する外部ページhttps://www.cocos.com/endoc.html

謝辞:Cocos2d の作者に感謝します.https://github.com/liamrahav/cocos2d-python-tutorials/blob/master/basics/ で公開されているサンプルプログラムを参考にした.

2. Python 3.12 のインストール

本章では、Pythonのインストールを行い、Pythonのプログラムを実行する環境を整える。扱う環境は、Windows搭載パソコンである。金子研究室では、Python 3.12.10を推奨する。

[Windows での Python 3.12 のインストール手順を見るには、ここをクリック]

Windows での Python 3.12 のインストール

以下のいずれかの方法でPython 3.12をインストールする。Pythonがインストール済みの場合、この手順は不要である。

方法 1:winget によるインストール

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして、コマンド全体をコマンドプロンプトにコピー&ペーストする。

--scope machine を指定することで、システム全体(全ユーザー向け)にインストールされる。このオプションの実行には管理者権限が必要である。インストール完了後、コマンドプロンプトを再起動するとPATHが反映される。

REM Python 3.12 をシステム領域にインストール
winget install --id Python.Python.3.12 -e --scope machine --silent --accept-source-agreements --accept-package-agreements --override "/quiet InstallAllUsers=1 PrependPath=1 Include_test=0 Include_pip=1 Include_launcher=1 InstallLauncherAllUsers=1 TargetDir=\"C:\Program Files\Python312\""

REM Python と Scripts を PATH 先頭に追加
powershell -NoProfile -Command "$p='C:\Program Files\Python312'; $s=\"$p\Scripts\"; $c=[Environment]::GetEnvironmentVariable('Path','Machine'); if((Test-Path $p) -and (';'+$c+';' -notlike \"*;$p;*\") -and (';'+$c+';' -notlike \"*;$s;*\")){[Environment]::SetEnvironmentVariable('Path',\"$p;$s;$c\",'Machine')}"

方法 2:インストーラーによるインストール

  1. Python公式サイト(https://www.python.org/downloads/)にアクセスし、「Download Python 3.x.x」ボタンからWindows用インストーラーをダウンロードする。
  2. ダウンロードしたインストーラーを実行する。
  3. 初期画面の下部に表示される「Add python.exe to PATH」にチェックを入れてから「Customize installation」を選択する。このチェックを入れ忘れると、コマンドプロンプトから python コマンドを実行できない。
  4. 「Install Python 3.xx for all users」にチェックを入れ、「Install」をクリックする。

インストールの確認

コマンドプロンプトで以下を実行する。

python --version

バージョン番号(例:Python 3.12.x)が表示されればインストール成功である。「'python' は、内部コマンドまたは外部コマンドとして認識されていません。」と表示される場合は、インストールが正常に完了していない。

以降の章では、必要に応じて題材に応じたソフトウェアを追加する。

3. Python の開発環境 Visual Studio Code のインストールと Python 用の設定

本章では、Python の開発環境Visual Studio Code(プログラムを編集するソフトウェア。以下、VS Code)を整える。

[Windows での Visual Studio Code のインストールと Python 用の設定手順を見るには、ここをクリック]

Windows での Visual Studio Code のインストールと Python 用の設定手順

1. VS Code と拡張機能のインストール

以下のコマンドにより,既存の VS Code を削除し,全ユーザー共有の設定で再インストールしたうえで,拡張機能(VS Code に機能を追加するソフトウェア)をまとめて導入する.

インストールコマンドの実行方法

管理者権限コマンドプロンプトを起動する(手順:Windows キーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。そして,コマンド全体をコマンドプロンプトにコピー&ペーストする。

インストールコマンド


REM ============================================================
REM Microsoft Visual Studio Code
REM ============================================================
winget uninstall -e --id Microsoft.VisualStudioCode --silent --disable-interactivity --accept-source-agreements
rmdir /s /q C:\ProgramData\vscode-extensions 2>nul
rmdir /s /q "%APPDATA%\Code" 2>nul
rmdir /s /q "%USERPROFILE%\.vscode" 2>nul
rmdir /s /q "%LOCALAPPDATA%\Microsoft\vscode-update" 2>nul

REM VS Code をシステム領域に新規インストール
winget install --scope machine --id Microsoft.VisualStudioCode -e --silent --accept-source-agreements --accept-package-agreements

REM 全ユーザー共有の拡張機能フォルダ
mkdir C:\ProgramData\vscode-extensions 2>nul
icacls "C:\ProgramData\vscode-extensions" /grant "Everyone:(OI)(CI)M" /T

REM スタートメニューのショートカットを --extensions-dir 付きで再作成
rmdir /s /q "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code" 2>nul
del "C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk" 2>nul
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); $lnk.TargetPath='C:\Program Files\Microsoft VS Code\Code.exe'; $lnk.Arguments='--extensions-dir \"C:\ProgramData\vscode-extensions\"'; $lnk.Save()"
REM ショートカットの検証
powershell -NoProfile -Command "$s=New-Object -ComObject WScript.Shell; $lnk=$s.CreateShortcut('C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Visual Studio Code.lnk'); Write-Host 'TargetPath:' $lnk.TargetPath; Write-Host 'Arguments:' $lnk.Arguments"

REM ファイル / フォルダ右クリックの「Code で開く」を登録
reg add "HKLM\SOFTWARE\Classes\*\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%1\"" /f
reg add "HKLM\SOFTWARE\Classes\Directory\Background\shell\VSCode\command" /ve /d "\"C:\Program Files\Microsoft VS Code\Code.exe\" --extensions-dir \"C:\ProgramData\vscode-extensions\" \"%V\"" /f

REM --extensions-dir 付きで起動する code.cmd ラッパを作成
REM (%* を echo で書くと対話的 cmd で失われるため、PowerShell で [char]37+'*' を書き出す)
powershell -NoProfile -Command "$pct=[char]37; $q=[char]34; $c='@echo off'+[char]13+[char]10+$q+'C:\Program Files\Microsoft VS Code\bin\code.cmd'+$q+' --extensions-dir '+$q+'C:\ProgramData\vscode-extensions'+$q+' '+$pct+'*'+[char]13+[char]10; [IO.File]::WriteAllText('C:\ProgramData\vscode-extensions\vscode.cmd',$c,[Text.Encoding]::ASCII)"

REM 拡張機能のインストール
set "CODE=C:\Program Files\Microsoft VS Code\bin\code.cmd"
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --uninstall-extension GitHub.copilot-chat
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.python
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.vscode-pylance
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension ms-python.debugpy
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension MS-CEINTL.vscode-language-pack-ja
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension saoudrizwan.claude-dev
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension rust-lang.rust-analyzer
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension tamasfe.even-better-toml
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension anthropic.claude-code
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --install-extension almenon.arepl
"%CODE%" --extensions-dir "C:\ProgramData\vscode-extensions" --list-extensions --show-versions
echo === セットアップ完了 ===

2. Python インタプリタの選択

同一マシンに複数の Python がインストールされている場合,VS Code で使用する Python 本体(インタプリタ:Python プログラムを解釈・実行するソフトウェア)を選択する必要がある.

  1. コマンドパレット(コマンド名で機能を呼び出す VS Code の入力欄)を開く(Ctrl+Shift+P
  2. Python: Select Interpreter と入力する
  3. 表示される一覧から,使用する Python(例:C:\Program Files\Python312\python.exe)を選択する.

以降の章では、必要に応じて題材に応じた必要なソフトウェアを追加する。

4. Python プログラム実行手順

[Windows での Python プログラム実行手順を見るには、ここをクリック]

Windows での Python 実行手順(Visual Studio Codeを使用)

プログラムファイルの作成と保存

  1. 左サイドバーの「エクスプローラー」アイコン(Ctrl+Shift+E)をクリックする
  2. 「NO FOLDER OPENED」(作業対象フォルダが未選択の状態)と表示される場合は,「Open Folder」をクリックし,プログラムを保存するフォルダを選択する

    続いて「フォルダを信用するか」を確認する画面(フォルダ内のコードを実行してよいか確認する VS Code の仕組み)が表示されるので,チェックして Yes を選択する

  3. フォルダ名の右側に表示される「新しいファイル」アイコンをクリックする
  4. ファイル名(例:aitask.py.ファイル名は何でも良い)を入力し Enter を押す.拡張子は .py(Python ファイルを示す拡張子)とする
  5. 実行したいコードを選択し,Ctrl+C でコピーする.VS Code のエディタ領域に Ctrl+V で貼り付ける
  6. Ctrl+S で保存する

プログラムの実行

  1. エディタ右上の三角形「▷」アイコン(Run Python File:現在開いている Python ファイルを実行するボタン)をクリックする.または,エディタ上で右クリックし「ターミナルで Python ファイルを実行」を選択する
  2. VS Code 下部のターミナル(コマンドの入出力を表示する画面)に,実行結果(print 関数の出力等)が表示される
  3. tkinter(Python 標準の GUI ライブラリ)のファイル選択ダイアログを使うプログラムを実行した場合は,ダイアログが開くので対象画像を選択する
  4. VS Code 下部のターミナルで実行結果を確認する.OpenCV ウィンドウ(OpenCV が画像を表示するために開く専用ウィンドウ)が開いた場合はそちらも確認する.OpenCV ウィンドウは,マウスクリックでウィンドウをアクティブ(操作対象の状態)にしてからキーを押すと終了する

5. cocos2d と pyglet のインストール

管理者権限コマンドプロンプトを起動する (手順:Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」)。

起動したコマンドプロンプトで次を実行する。cocos2d(最新版 0.6.10)は pyglet 2.0 では動作しないため,pyglet のバージョンを 2.0 未満に指定する(cocos2d の動作要件は pyglet 1.4.10 以上 2.0 未満である)。

pip install -U --no-user cocos2d "pyglet<2.0"

Windows での cocos2d, pyglet のインストールの詳細は,別ページ »で説明している.

6. イベント,キーコード,イベントハンドラ,アクションの基礎

イベント,キーコード,イベントハンドラ

アクションの基礎

関連する外部ページhttps://www.cocos.com/endoc/api/cocos.actions.interval_actions.html

7. 演習1:マウス操作でオブジェクトを移動する

テーマ:マウスのボタンが押されたイベント(on_mouse_press)を使い,クリックした位置にオブジェクトを移動する.

手順

  1. 次のコードを実行する(メモ帳を用いる場合は a.py のようなファイル名で保存して実行).
  2. 640×480 のウインドウが現れ,画面内に「Hello,World!」のラベルが表示されることを確認する.
  3. 画面内をクリックすると,クリックした座標にオブジェクトが移動する.
  4. 結果を確認したら,ウインドウ右上の「x」をクリックして終了する.
import cocos
from cocos import scene
from cocos.layer import Layer
from cocos.director import director
from pyglet.window import key

class MyActor(cocos.text.Label):
    def __init__(self, text, x, y, size, rgba):
        super(MyActor, self).__init__(
            text, font_name="Times New Roman", font_size=size,
            anchor_x='center', anchor_y='center', color=rgba)
        self.position = cocos.euclid.Vector2(x, y)

class Layer00(Layer):
    is_event_handler = True
    def __init__(self):
        super(Layer00, self).__init__()
        self.myactor = MyActor("Hello,World!", 0, 0, 32, (0, 200, 255, 255))
        self.add(self.myactor)
    def on_mouse_press(self, x, y, buttons, modifiers):
        self.myactor.x = x
        self.myactor.y = y

director.init(width=640, height=480)
director.run(scene.Scene(Layer00()))

ヒント

考察ポイント

* 発展課題: 「Hello,World!」を別の文字列に変えて変化を見なさい.画面内をクリックし,結果を確認したら右上の「x」をクリックして終了すること.

8. 演習2:キーボード操作でオブジェクトを移動する

テーマ:キーが押されたイベント(on_key_press)を使い,矢印キーでオブジェクトを移動する.

手順

  1. 次のコードを実行する(メモ帳を用いる場合は a.py のようなファイル名で保存して実行).
  2. ウインドウが現れることを確認する.
  3. 画面内を1回クリックしたあと,キーボードの矢印キーを連打する.矢印キーは4つある.方向に応じてラベルが10画素ずつ移動する.
  4. 結果を確認したら,ウインドウ右上の「x」をクリックして終了する.
import cocos
from cocos import scene
from cocos.layer import Layer
from cocos.director import director
from pyglet.window import key

class MyActor(cocos.text.Label):
    def __init__(self, text, x, y, size, rgba):
        super(MyActor, self).__init__(
            text, font_name="Times New Roman", font_size=size,
            anchor_x='center', anchor_y='center', color=rgba)
        self.position = cocos.euclid.Vector2(x, y)

class Layer00(Layer):
    is_event_handler = True
    def __init__(self):
        super(Layer00, self).__init__()
        self.myactor = MyActor("Hello,World!", 0, 0, 32, (0, 200, 255, 255))
        self.add(self.myactor)
    def on_key_press(self, symbol, modifiers):
        if symbol == key.RIGHT:
            self.myactor.x += 10
        elif symbol == key.LEFT:
            self.myactor.x -= 10
        elif symbol == key.UP:
            self.myactor.y += 10
        elif symbol == key.DOWN:
            self.myactor.y -= 10

director.init(width=640, height=480)
director.run(scene.Scene(Layer00()))

ヒント

考察ポイント

* 発展課題: 「+= 10」「-= 10」の「10」を別の数値に変えて変化を見なさい.全部で4か所ある.結果を確認したら右上の「x」をクリックして終了すること.


9. 演習3:移動アクション(MoveBy, MoveTo, RotateBy)

テーマ:キーが押されたイベントで MoveBy(相対移動)と RotateBy(回転)のアクションを実行する.

手順

  1. 次のコードを実行する(メモ帳を用いる場合は a.py のようなファイル名で保存して実行).
  2. ウインドウが現れることを確認する.
  3. 画面内を1回クリックしたあと,スペースキーR キーをゆっくり何度か押す.key.SPACE はスペースキー,key.R は R キーを表す.スペースキーで2秒かけて右に200画素・上に100画素移動し(MoveBy),R キーで2秒かけて360度回転する(RotateBy).
  4. 結果を確認したら,ウインドウ右上の「x」をクリックして終了する.
import cocos
from cocos import scene
from cocos.layer import Layer
from cocos.director import director
from pyglet.window import key

class MyActor(cocos.text.Label):
    def __init__(self, text, x, y, size, rgba):
        super(MyActor, self).__init__(
            text, font_name="Times New Roman", font_size=size,
            anchor_x='center', anchor_y='center', color=rgba)
        self.position = cocos.euclid.Vector2(x, y)

class Layer00(Layer):
    is_event_handler = True
    def __init__(self):
        super(Layer00, self).__init__()
        self.myactor = MyActor("Hello,World!", 0, 0, 32, (0, 200, 255, 255))
        self.add(self.myactor)
    def on_key_press(self, symbol, modifiers):
        if symbol == key.RIGHT:
            self.myactor.x += 10
        elif symbol == key.LEFT:
            self.myactor.x -= 10
        elif symbol == key.UP:
            self.myactor.y += 10
        elif symbol == key.DOWN:
            self.myactor.y -= 10
        elif symbol == key.SPACE:
            self.myactor.do(cocos.actions.MoveBy((200, 100), 2))
        elif symbol == key.R:
            self.myactor.do(cocos.actions.RotateBy(360, 2))

director.init(width=640, height=480)
director.run(scene.Scene(Layer00()))

ヒント

考察ポイント

* 発展課題: 「MoveBy((200, 100), 2)」を下のように MoveTo へ変えて変化を見なさい.スペースキーを押して1度移動したら,何度押しても動かないことを確認する.結果を確認したら右上の「x」をクリックして終了すること.

MoveTo((300, 400), duration=5) ・・・ 5秒かけて,(300, 400)の場所に移動する.

* 発展課題: 次を追加しなさい.字下げにも注意し,下の図の通り字下げすること.画面内でクリックするとオブジェクトが動くので確認すること.結果を確認したら右上の「x」をクリックして終了すること.

    def on_mouse_press(self, x, y, buttons, modifiers):
        self.myactor.do(cocos.actions.MoveTo((x, y), 2))

10. 演習4:ジャンプアクション(JumpBy, JumpTo, ScaleBy)

テーマ:キーが押されたイベントで JumpBy(ジャンプ移動)と ScaleBy(拡大)のアクションを実行する.

手順

  1. 次のコードを実行する(メモ帳を用いる場合は a.py のようなファイル名で保存して実行).
  2. ウインドウが現れることを確認する.
  3. 画面内を1回クリックしたあと,スペースキーS キーをゆっくり何度か押す.key.SPACE はスペースキー,key.S は S キーを表す.スペースキーで5秒かけて右に300画素・上に100画素を5回ジャンプしながら移動し(JumpBy),S キーで1秒かけて2倍に拡大する(ScaleBy).
    JumpBy((300, 100), 100, 5, duration=5) ・・・ 5秒かけて,現在位置から右に300画素・上に100画素ジャンプ移動する.ジャンプの回数は5回で,1回の高さは100画素である.
  4. 結果を確認したら,ウインドウ右上の「x」をクリックして終了する.
import cocos
from cocos import scene
from cocos.layer import Layer
from cocos.director import director
from pyglet.window import key

class MyActor(cocos.text.Label):
    def __init__(self, text, x, y, size, rgba):
        super(MyActor, self).__init__(
            text, font_name="Times New Roman", font_size=size,
            anchor_x='center', anchor_y='center', color=rgba)
        self.position = cocos.euclid.Vector2(x, y)

class Layer00(Layer):
    is_event_handler = True
    def __init__(self):
        super(Layer00, self).__init__()
        self.myactor = MyActor("Hello,World!", 0, 0, 32, (0, 200, 255, 255))
        self.add(self.myactor)
    def on_key_press(self, symbol, modifiers):
        if symbol == key.RIGHT:
            self.myactor.x += 10
        elif symbol == key.LEFT:
            self.myactor.x -= 10
        elif symbol == key.UP:
            self.myactor.y += 10
        elif symbol == key.DOWN:
            self.myactor.y -= 10
        elif symbol == key.SPACE:
            self.myactor.do(cocos.actions.JumpBy((300, 100), 100, 5, duration=5))
        elif symbol == key.S:
            self.myactor.do(cocos.actions.ScaleBy(2, duration=1))

director.init(width=640, height=480)
director.run(scene.Scene(Layer00()))

ヒント

考察ポイント

* 発展課題: 「JumpBy((300, 100), 100, 5, duration=5)」を下のように JumpTo へ変えて変化を見なさい.スペースキーを押して1度移動したら,何度押しても動かないことを確認する.結果を確認したら右上の「x」をクリックして終了すること.

JumpTo((100, 100), 100, 5, duration=5) ・・・ 5秒かけて,(100, 100)の場所にジャンプする.


* 発展課題: 次を追加しなさい.字下げにも注意し,下の図の通り字下げすること.画面内でクリックするとオブジェクトが動くので確認すること.結果を確認したら右上の「x」をクリックして終了すること.

    def on_mouse_press(self, x, y, buttons, modifiers):
        self.myactor.do(cocos.actions.JumpTo((x, y), 100, 5, duration=5))

11. まとめ

イベント

イベントとは,ユーザの入力(キーボード操作,マウス操作,ウインドウ操作など)によって発生するものである.Cocos2d では on_key_press,on_mouse_press,on_mouse_motion などのイベントが用意されている.

キーコード

キーコードとは,キーボードの各キーに割り当てられたコード(符号)である.pyglet では key.RIGHT,key.SPACE,key.A などの定数として定義されている.

イベントハンドラ

イベントハンドラとは,特定のイベントが発生したときに実行されるプログラムである.Layer クラスに is_event_handler = True を設定し,on_key_press や on_mouse_press などのメソッドを定義することで実装する.

アクション

アクションとは,オブジェクトの属性を変化させる操作である.即時(InstantAction),インターバル(IntervalAction),その他(Action)の3種類がある.MoveBy,MoveTo,JumpBy,JumpTo,RotateBy,ScaleBy などが代表的である.

do メソッド

オブジェクトにアクションを実行するには do メソッドを使用する.self.myactor.do(cocos.actions.MoveBy((200, 100), 2)) のように記述することで,移動や回転などのアクションを適用できる.

ことで,移動や回転などのアクションを適用できる.