ゲームエンジン

require("pico.game"): スプライト・タイルマップ・当たり判定・カメラ・入力・状態

pico.game は2Dゲーム向けの簡易エンジンです(OSに同梱のLuaモジュール)。Canvas を1枚作り、毎フレームの更新・描画・描き直す範囲の管理を引き受けます。アプリは「何がどこにいて、どう動くか」だけを書けば済みます。

• スプライト: 画像(スプライトシートの1コマ)か塗りの四角。速度・重力・アニメーション・左右反転・当たり判定の箱
• タイルマップ: 文字の行("#..P#")で地形を書ける。壁にするタイルを決めれば、スプライトが止まる・床に乗る
• 当たり判定: タグ同士が重なったら呼ばれる関数(g:collide("player", "coin", fn))
• カメラ: スプライトを追いかけ、ワールドの端で止まる
• 入力: コントローラー・画面の操作ボタン(pad = true)・タッチをまとめて g:down("left") で読める
• 状態: タイトル → プレイ → ゲームオーバーのような画面の切り替え
• 描き直し: カメラが動かない間は、動いたスプライトの周りだけを液晶へ送る

実例は「ジャンプアクション」(/lua/apps/ジャンプアクション/。横スクロールのジャンプアクション)と、物理を使う「おしてのぼれ」(/lua/apps/おしてのぼれ/。箱を押す・積む・ばね・動く足場・スイッチで扉を開けるパズルアクション)。盤面をタイルマップで作るゲームは「リバーシ」「マインスイーパー」「テトリス」「ブロック崩し」(サンプル)。

はじめの一歩

local game = require("pico.game")

local g = game.new{ bg = 11, pad = true }        -- 空色の背景、画面下に操作ボタン
local img = g:image(pico.path_join(pico.app_dir(), "sheet.pimg"))

local player
g:tilemap{ image = img, tile = 16, solid = { 1 },
    legend = { ["#"] = 1 },                      -- "#" はタイル1(画像の0番目の絵)
    spawn = { P = function(x, y)                 -- "P" の場所に主人公を置く
        player = g:sprite{ image = img, x = x, y = y, w = 16, h = 16, frame = 4,
                           gravity = 900, solid = true }
        g:follow(player)
    end },
    rows = {
        "................................",
        "..P.............................",
        "########....##########....######",
    } }

function g:on_update(dt)
    player.vx = g:axis() * 100                   -- 左右で歩く
    if player.on_ground and g:pressed("a") then player.vy = -330 end
end

loop() を書く必要はありません(game.new が pico.every(1, ...) で毎フレーム g:step() を呼びます)。

座標: スプライトとタイルマップの x, y はワールド座標(マップの左上が0、ピクセル単位、小数でよい)。描くときにカメラの分だけずらして画面へ置きます。

game.new

主なフィールド: g.canvas(作ったCanvasのID)/ g.vw g.vh(ワールドを見せる幅・高さ)/ g.cam_x g.cam_y / g.time(ゲームの経過秒。一時停止中は止まる)/ g.state_name / g.touch。

毎フレームの呼び出し順: 入力 → ゲーム内タイマー → 状態の update → g:on_update(dt) → 各スプライト(アニメーション → on_update → 加速と移動)→ スプライト同士の押し戻し → 当たりの規則 → カメラ → 描き直す範囲を決める。

スプライト

渡した表そのものがスプライトになります(好きなフィールドを足してよい)。

移動の結果(そのフレームだけ有効): s.on_ground(床に乗った)/ s.hit_ceiling(天井に当たった)/ s.hit_wall(-1=左の壁、1=右の壁、0=当たっていない)。壁に当たった向きの速度は0になります。on_update の中では前のフレームの結果が読めます(敵が壁で折り返す処理など)。

タイルとの当たりは、動いた向きに新しく入ったマスだけを近い順に調べるので、1フレームでタイルより大きく動いてもすり抜けません。坂・回転した当たり判定はありません(すり抜け床はタイルマップの oneway)。

壁で止まったとき、bounce があれば跳ね返り、無ければその向きの速度が0になります。

当たりの規則

タグ tag_a のスプライトとタグ tag_b のスプライトが重なっている間、毎フレーム fn(a, b) を呼びます。1回だけにしたいときは中で b:remove() するか、自分で印を付けてください。

g:collide("player", "coin", function(p, c)
    c:remove()
    score = score + 10
    g:dirty(0, 0, 120, 18)        -- 点数の表示を描き直す
end)

物理

タグ tag_a のスプライトとタグ tag_b のスプライトを重ならないように押し合わせます(g:collide は重なりを知らせるだけで、押し戻しはしません)。同じタグ同士(g:solid("box", "box"))も書けます。

• 押し戻しは mass の比で分けます。static は押されません。押される向きが既に塞がっている(壁に当たっている・床に乗っている)ものも動かないものとして扱うので、「主人公 → 箱 → 壁」や箱の積み重ねが崩れません
• 近づく向きの速度だけを撃力で交換します(bounce の大きいほうで跳ね返る。0なら速度を分け合って一緒に動く)
• 上に乗ったものは on_ground になり、乗っている足場が動くと一緒に運ばれます(static で vx vy を持つスプライトがそのまま動く足場になる)
• opt が関数なら fn(a, b, nx, ny) を押し戻したときに呼びます(nx ny は b から a への向き。ny == -1 なら a が上に乗った)。触れている間は毎フレーム呼ばれます
• opt = {oneway = true, on_hit = fn} なら、a が上から乗るときだけ押し戻します(すり抜けられる動く足場)

local g = game.new{ pad = true, gravity = 900 }
g:solid("player", "box")
g:solid("box", "box")
g:solid("player", "lift", { oneway = true })
local p = g:sprite{ image = sheet, w = 16, h = 16, solid = true, tag = "player", friction = 1200 }
g:sprite{ x = 80, y = 0, w = 16, h = 16, color = 4, solid = true, tag = "box", mass = 2, friction = 800 }
local lift = g:sprite{ x = 160, y = 96, w = 32, h = 6, color = 13, static = true, tag = "lift", vx = 30 }
g:every(2, function() lift.vx = -lift.vx end)

軽さを優先した近似です: 当たり判定は軸に沿った箱だけ・回転しない・1フレームに iterations 周しか解かないので、たくさん積むと少し沈み込むことがあります。重なりの判定は規則ごとの総当たり(タグAの数 × タグBの数)なので、押し合うスプライトは数十体までにしてください。

タイルマップ

マスの値は1バイト(0〜255)。0は空、1以上は画像の (値-1) 番目の絵です(画像は tile_w x tile_h の絵を左上から右へ並べたもの)。

フィールド: m.cols m.rows m.tw m.th m.data(文字列)、m.visible = false で描かない。タイルマップはいくつでも重ねられます(作った順に描く。壁の判定は solid を持つもの全部)。

カメラとワールド

入力

コントローラーと画面ボタンはどちらで押しても同じに読めます。画面ボタンは押したまま隣へ滑らせると切り替わります。タッチパネルは1点しか取れないので、画面ボタンでは「歩きながらジャンプ」のような同時押しはできません(コントローラーならできる)。

g.touch: ボタン以外の場所のタッチ。down pressed released、x y(キャンバスの中の座標)、wx wy(ワールド座標)。1フレームより短いタップも取りこぼしません。

状態

g:go は今の状態の exit(g) → 新しい状態の enter(g, ...) を呼び、画面全体を描き直します。update(g, dt) は毎フレーム、draw(g, ox, oy) は描くときに(ox, oy はキャンバスの左上の画面座標)呼ばれます。g.state_name が今の状態の名前です。

g:state("title", {
    update = function() if g:pressed("a") or g.touch.pressed then g:go("play") end end,
    draw = function(_, ox, oy) pico.draw_text(ox + 40, oy + 100, "Aで始める", 15) end,
})
g:go("title")

ゲーム内タイマー

ゲームの時間(g.time)で進むので、一時停止中は止まります。g:clear() で全部消えます。数は無制限(pico.after の16個の枠を使いません)。

描画

ふだんは何もしなくてよく、エンジンが「タイルマップ → g:on_draw_world(ox, oy) → スプライト(layer 順)→ 状態の draw → g:on_draw(ox, oy) → 画面ボタン」の順に描きます。

描き直す範囲: カメラが動いた・状態が変わった・スプライトの重なり順が変わったときはワールドの見える範囲(画面ボタンの帯は除く)を、それ以外は動いた(コマや反転が変わった)スプライトの前後の位置だけを描き直します(液晶へ送る量が減って速い)。on_draw で描く中身(点数など)を変えたら、その範囲を g:dirty で知らせてください(知らせないと前の絵が残ります)。

pico.draw_tilemap

pico.game が使っている、タイルマップを描く関数です(エンジンを使わずに直接描くこともできます)。data は1バイト1マスの文字列(行優先、cols 列で折り返す)、0は空、1以上は画像の (値-1) 番目のタイル。(x, y) はマップの左上の画面座標(画面の外でもよい)。今の描き直す範囲にかかるマスだけを描くので、大きいマップでも全部を回しません。Canvas の render コールバックの中で使います。タイルの大きさは1〜128、列数は1〜4096。

制限と注意

• メモリ: require("pico.game") だけでLuaのメモリを約55KB使います。アプリの上限(200KB)の残りで画像・スプライトを持ちます。スプライト1体は数百バイトです。
• 画像は pico.image_load と同じ枠(8枚・合計96KiB)。スプライトとタイルは1枚のシートにまとめるのが得です。
• 左右反転・上下反転したスプライトは1画素ずつ描くので、反転しないものより遅くなります(16x16程度なら気にならない)。
• エンジンの中で起きたエラーは行番号が「?」になります(同梱モジュールはデバッグ情報を落としてメモリを節約しているため)。引数の誤りはアプリの行を指します。
• 重い処理(同じタグのスプライトが数十体いる当たりの規則など)は、毎フレームのLuaの命令数を食います。