PICO-8 API 早見表

オーディオ制御

music([n, [fade_len, [channel_mask]]]) -- 音楽を再生する. -1: 再生停止
sfx(n, [channel, [offset]]) -- SFXを再生する. -1: 再生停止, -2: ループ再生解除

カートリッジデータ制御

cartdata(id) -- 名前がidのカートリッジデータを開く(実行時に1回だけ!)
dget(idx) -- 指定番号のデータの値を取得する
dset(idx, val) -- 指定番号のデータに値を設定する

コルーチン :: コルーチン解説ページを読む

cocreate(f) -- 関数fを実行するコルーチンを作成する
coresume(c) -- コルーチンcの実行を再開する
costatus(c) -- コルーチンcが実行中ならtrueを, それ以外ならfalseを返す
yield() -- コルーチンの中で使用する. コルーチンの実行を再開命令が呼ばれるまで停止する

描画制御

camera([x, y]) -- カメラ位置を設定する
circ(x, y, r, [col]) -- 円を描画する
circfill(x, y, r, [col]) -- 塗りつぶされた円を描画する
clip([x, y, w, h]) -- 描画範囲を設定する
cls([col]) -- 画面をクリアする. col=クリア色
color(col) -- デフォルトの描画色を設定する
cursor(x, y) -- カーソル位置を設定する
fget(n, [f]) -- スプライトフラグの値を取得する
flip() -- バックバッファを画面に表示する(30fps)
fset(n, [f], v) -- スプライトフラグの値を設定する
line(x0, y0, x1, y1, [col]) -- 直線を描画する
pal(c0, c1, [p]) -- 色0を色1に置き換える. p=0: 描画パレット, p=1: 画面パレット
palt(col, t) -- 指定した色の透過処理をt(ブール値)に設定する
pget(x, y) -- ピクセルの色を取得する
print(str, [x, y, [col]]) -- 文字列を出力する
pset(x, y, [col]) -- ピクセルの色を設定する
rect(x0, y0, x1, y1, [col]) -- 矩形を描画する
rectfill(x0, y0, x1, y1, [col]) -- 塗りつぶされた矩形を描画する
sget(x, y) -- スプライトシートのピクセルの色を取得する
spr(n, x, y, [w, h], [flip_x], [flip_y]) -- スプライトを描画する
sset(x, y, [col]) -- スプライトシートのピクセルの色を設定する
sspr(sx, sy, sw, sh, dx, dy, [dw, dh], [flip_x], [flip_y]) -- スプライトシートから指定範囲を描画する

入力制御

btn([i, [p]]) -- プレイヤーpのボタンiの状態を取得する
btnp([i, [p]]) -- 前回のフレームで押されていなかった時のみtrueになる. 15フレーム押され続けると4フレーム毎に繰り返す

マップ制御

map(cel_x, cel_y, sx, sy, cel_w, cel_h, [layer]) -- マップを描画する. layer指定時はスプライトフラグと一致した時のみ描画される. スプライト0番は描画されない
mapdraw(cel_x, cel_y, sx, sy, cel_w, cel_h, [layer]) -- マップを描画する. 'map()'と同じ
mget(x, y) -- マップのセルの値を取得する
mset(x, y, v) -- マップのセルの値を設定する

数学関数

-32768.0 .. 32767.99 -- 値の範囲
abs(x) -- xの絶対値
atan2(dx, dy) -- (dx, dy)を0から1の角度に変換する
band(x, y) -- ビット単位の論理積
bnot(x) -- ビット単位の否定
bor(x, y) -- ビット単位の論理和
bxor(x, y) -- ビット単位の排他的論理和
cos(x) -- xの余弦, 1周期は0から1の範囲
flr(x) -- 切り捨て
-flr(-x) -- 関数ではないが, 切り上げとして使える
max(x, y) -- x,yの最大値
mid(x, y, z) -- x,y,zの中間の値
min(x, y) -- x,yの最小値
rnd(x) -- 0以上x未満の乱数
sgn(x) -- 引数の符号を-1か1で返す. sgn(0)の時は1になる
shl(x, y) -- 左シフト
shr(x, y) -- 右シフト
sin(x) -- xの正弦, 1周期は0から1の範囲, 正負は反転している
sqrt(x) -- xの平方根
srand(x) -- 乱数のシードを設定する

演算子

a = b -- 代入
a + b -- 和
a - b -- 差
a * b -- 積
a / b -- 商
a % b -- 余り
a ^ b -- べき乗
a += b -- 値に加算する
a -= b -- 値から引く
a *= b -- 値に掛ける
a /= b -- 値を割る
a %= b -- 値を割った余りにする
a ^= b -- 値をべき乗する
a == b -- 等しいか
a ~= b -- 等しくないか
a != b -- 等しくないか
a > b -- aがbより大きいか比較する
a < b -- aがbより小さいか比較する
a >= b -- aがb以上か比較する
a <= b -- aがb未満か比較する
not a -- 論理否定
a and b -- 論理積
a or b -- 論理和
(a) -- 演算の区切り

flow control

::label:: -- label
goto label -- ラベルにジャンプする

if (<condition>) -- 1行版if

if <condition> then
 -- ifブロック
elseif <condition> then
 -- elseifブロック
else
 -- elseブロック
end

while <condition> do
 -- whileブロック
end

for <var> = <first>, <last>, <step> do
 -- forブロック
end

メモリ操作

cstore(dest_addr, src_addr, len, [filename]) -- RAMまたは指定されたファイルからROMにバイト列をコピーする. マルチカートリッジ対応
memcpy(dest_addr, src_addr, len) -- バイト列をコピーする
memset(dest_addr, val, len) -- lenバイトにvalを設定する
peek(addr) -- RAMの指定アドレスのバイトを取得する
poke(addr, val) -- RAMの指定アドレスにvalを書き込む
reload(dest_addr, src_addr, len, [filename]) -- ROMまたは指定されたファイルからRAMにバイト列をコピーする. マルチカートリッジ対応

種類

1. ベースRAM(32kB)
2. カートリッジROM
3. Lua RAM(1MB)

RAM配置

0x0    - グラフィックス
0x1000 - グラフィックス2/マップ2(共有)
0x2000 - マップ
0x3000 - グラフィックス属性
0x3100 - 音楽
0x3200 - SFX
0x4300 - ユーザーデータ
0x5e00 - 永続カートリッジデータ(256byte)
0x5f00 - 描画状態
0x5f40 - ハードウェア状態
0x5f80 - GPIOピン(128byte)
0x6000 - 画面(8kB)

マウス

poke(0x5f2d, 1) -- マウスリスナーを初期化する
stat(32) -- x座標を取得する
stat(33) -- y座標を取得する
stat(34) -- ボタン状態をビット列で取得する(1=左ボタン, 2=右ボタン, 4=中央ボタン)

拡張描画モード

poke(0x5f2c, 0) -- 標準, 128x128
poke(0x5f2c, 1) -- 水平方向に引き伸ばし, 64x128
poke(0x5f2c, 2) -- 垂直方向に引き伸ばし, 128x64
poke(0x5f2c, 3) -- 拡大, 64x64
poke(0x5f2c, 4) -- 標準, 128x128
poke(0x5f2c, 5) -- 左半分の鏡像
poke(0x5f2c, 6) -- 右半分の鏡像
poke(0x5f2c, 7) -- 左上4分の1の鏡像

raspberry pi / pocketchip gpio

-- ルート権限でpico-8を実行する("sudo pico-8")
-- 値は0-255の範囲
poke(0x5f80, val) -- 値をgpio0に送る
poke(0x5f81, val) -- 値をgpio1に送る
-- 等々

実行制御

_draw() -- 画面の描画タイミング毎に呼ばれる
_init() -- プログラム開始時に一度だけ呼ばれる
_update() -- 30fpsの更新タイミング毎に呼ばれる
_update60() -- 60fpsの更新タイミング毎に呼ばれる

コマンドライン

assert(condition) -- conditionがtrueか確認する
cd .. -- 親ディレクトリに移動する
cd [dirname] -- 現在のディレクトリを変更する
dir() -- 現在のディレクトリの要素一覧を表示する
exit() -- PICO-8アプリを終了する
export(filename.html, [cart1.p8, cart2.p8 ... cart15]) -- htmlでゲームを書き出す. 15までの拡張カートリッジの指定が可能
export(filename.png) -- スプライトシートを書き出す
export(filename.wav) -- 現在のSFX/音楽を書き出す
export(filename%d.wav) -- すべてのSFXを通し番号つきのファイルとして書き出す
extcmd(cmd) -- スクリーンショットを制御する; "label"でカートリッジ用; "screen"でスクリーンショット; "rec"でgifアニメ録画開始; "video"でgifアニメを保存
folder() -- ホストOSでカートリッジフォルダーを開く
help() -- システムコマンドの要約を表示する
import(filename.png) -- スプライトシートを読み込む. 128x128のpngで色がPICO-8のパレットに一致することが前提
info() -- カートリッジ情報を表示する
install_demos() -- デモカートリッジをインストールする
install_games() -- 代表的なBBSカートリッジをインストールする
keyconfig() -- プレイヤーボタンのキーボード割り当てを設定する
load("@clip") -- カートリッジをクリップボードから読み込む(BBS対応)
load(filename) -- カートリッジを読み込む(マルチカートリッジ対応)
ls() -- 現在のディレクトリの要素一覧を表示する
menuitem(index, [label, callback]) -- ポーズメニューに要素(1-5)を追加する. ラベルとコールバックが指定されないと要素を削除する
mkdir(dirname) -- ディレクトリを作成する
printh(str, [filename, overwrite]) -- 文字列をターミナルに出力する. 指定したファイルへの追記や上書きが可能
reboot() -- PICO-8を再起動する
resume() -- カートリッジの実行を再開する
run() -- カートリッジを実行する
save("@clip") -- カートリッジをクリップボードに保存する(BBS対応)
save(filename) -- カートリッジを保存する
shutdown() -- PICO-8アプリを終了する
splore() -- カートリッジを閲覧する
stat(x) -- システムの状態を取得する. 下記参照
time() -- 最後に起動してからの経過秒を返す
type(v) -- vの型(数値, 文字列, テーブル)を返す

統計データ

stat(0) -- メモリ使用状態(0-1024)
stat(1) -- CPU使用率; 1.0で30fps時に100%
stat(4) -- クリップボード; ctrl-vを押した後に有効
stat([16..19]) -- 指定チャネル(0-3)で再生中のサウンド番号
stat([20..23]) -- 指定チャネル(0-3)で最低中のノート番号(0-31)
stat(32) -- マウスのx座標; "拡張設定"タブを参照のこと
stat(33) -- マウスのy座標; "拡張設定"タブを参照のこと
stat(34) -- マウスボタンのビットマスク; "拡張設定"タブを参照のこと

JavaScript

pico8_gpio[] // GPIOピンの読み書きをする

プライベート関数 (慎重に使用すること)

_get_frames_skipped() -- _mainloop()が自動で使用する
_get_menu_item_selected(n) -- n番目のメニューアイテムが選択されているかをtrueまたはfalseで返す; nは(1-5)の範囲; _mainloop()が自動で使用する
_mainloop() -- pico-8'の"while true"ループ
_pausemenu[n].callback() -- n番目のメニューアイテムのコールバックを実行する; nは(1-5)の範囲; _mainloop()が自動で使用する
_set_mainloop_exists(n) -- ?
_update_buttons() -- _mainloop()が自動で使用する
holdframe() -- _draw(), _update()が自動で使用する

文字列操作

#s -- 文字列の長さ
"three " .. 4 -- 文字列の結合
sub(str, from, [to]) -- 部分文字列
"123.45" + 0 -- 解釈可能な文字列を数値に変換する; "0xAF"形式で16進数になる

特殊文字

print("l:\x8b r:\x91 u:\x94 d:\x83 o:\x8e x:\x97")

テーブル操作

add(t, v) -- 値vをテーブルに追加する
all(t) -- ループ処理'for v in all(t)'で使用する
count(t) -- テーブルの要素数を返す
del(t, v) -- 値がvの最初の要素を削除する
foreach(t, f) -- 各要素について関数fを呼ぶ
pairs(t) -- ループ処理'for k,v in pairs(t)'で使用する

メタテーブル :: メタテーブル解説ページを読む

mt = {} -- メタテーブルを初期化する
setmetatable(t, mt) -- テーブルtにメタテーブルmtを設定する

メタテーブル :: 特殊キー

-- オブジェクト指向プログラミング; 't:foo()'または't:bar()'で実行される
fun = {}
function fun.foo(t) dosomething() end
function fun.bar(t) dosomethingmore() end
mt.__index = fun

-- プロパティの代入; 't[k] = v'で実行される
function mt.__newindex(t, k, v) rawset(t, k, v) end

-- 弱い参照; キーと(または)値
mt.__mode = "k" or "v" or "kv"

-- テーブルを関数のように使用する; 't()'が実行されると呼ばれる
function mt.__call(t) dosomething() end

-- メタテーブルを隠す; 'getmetatable(t)'が返る
public_mt = {}
mt.__metatable = public_mt

-- 文字列への変換; 'tostring(t)'で返る
function mt.__tostring(t) return tostring(t) end

-- テーブルのサイズ; '#t'で返る
function mt.__len(t) return #t end

メタテーブル :: 算術演算子

-- 単項マイナス; '-t'で返る
function mt.__unm(t) return -t end

-- 加算; 'a + b'が返る
function mt.__add(a, b) return a + b end

-- 減算; 'a - b'が返る
function mt.__sub(a, b) return a - b end

-- 乗算; 'a * b'が返る
function mt.__mul(a, b) return a * b end

-- 除算; 'a / b'が返る
function mt.__div(a, b) return a / b end

-- 剰余; 'a % b'が返る
function mt.__mod(a, b) return a % b end

-- べき乗; 'a ^ b'が返る
function mt.__pow(a, b) return a ^ b end

-- 連結; 'a .. b'が返る
function mt.__concat(a, b) return a .. b end

メタテーブル :: 比較演算子

-- aがbと等しいか判定する; 'a == b'が返る
function mt.__eq(a, b) return a == b end

-- aがb未満か判定する; 'a < b'が返る
function mt.__lt(a, b) return a < b end

-- aがb以下か判定する; 'a <= b'が返る
function mt.__le(a, b) return a <= b end