API リファレンス

komaba/array ライブラリ
komaba/mini_star ライブラリ

komaba/array ライブラリ

checkpoint_a()

実行中にスペースキーを押すと、 chekcpoint_a 呼び出し箇所がある時点で一時停止します。

一時停止状態でさらにスペースキーを押すと、実行が再開されますが、再び checkpoint_a 呼び出し箇所で一時停止します。

一時停止状態でエンターキーを押すと、実行が通常通り再開します。

show(array)

配列 array を表示します。

1 から 3 次元配列に対応しています。

各要素は 0 から 1 の実数です。 1、 2 次元配列の場合は、白黒の度合いを表します。 3 次元配列の場合は 3 次元目がそれぞれ R、 G、 B を表します。

要素数がそろっていないとエラーになります。

関数名_CS(args, ...)

関数名の関数を実行し、コールスタックを表示します。

args に、関数実行時に渡す引数を指定します。

def fib(x)
  if x < 2
    1
  else
    fib(x - 1) + fib(x - 2)
  end
end

fib_CS(10)

show_call_stack(func_name, args ...) (deprecated)

(このメソッドは互換性のために残されています。)

関数 func_name を実行し、コールスタックを表示します。 関数名_CS と効果は同じです。

args に、関数実行時に渡す引数を指定します。

func_name は文字列 (またはシンボル) でなければなりません。関数名をそのまま書いても正しく動きません。

def fib(x)
  if x < 2
    1
  else
    fib(x - 1) + fib(x - 2)
  end
end

show_call_stack(fib, 10) # fib を引数なしで実行してしまうことになり、エラーになる。
show_call_stack("fib", 10) # 正しくコールスタックが表示される。

実行時に表示される白い四角の中の文字列は、それぞれ引数、戻り値を表します。

show_object(obj)

任意のオブジェクト obj を可視化します。

配列の場合は (2 次元配列までですが) 箱状に表示します。その他のオブジェクトは文字列として表示されます。

text(text, x, y)

文字列 text を座標 (x,y) に描画します。

最後に表示されたウィンドウに描画されます。

komaba/mini_star ライブラリ

(今のところ) 人を表示したり動かしたりすることができる、 komaba/array とは独立したライブラリです。

Ruby プログラムの先頭行に以下を加えると使用できます。

require "komaba/mini_star"
include(Komaba::MiniStar)

関数

checkpoint()

実行中にスペースキーを押すと、 chekcpoint 呼び出し箇所がある時点で一時停止します。

一時停止状態でさらにスペースキーを押すと、実行が再開されますが、再び checkpoint 呼び出し箇所で一時停止します。

一時停止状態でエンターキーを押すと、実行が通常通り再開します。

halt()

画面を更新しつづける無限ループを実行します。

irb (isrb) ではなく ruby (rsdl) コマンドで実行する場合、スクリプトの最後に書いておかないと、プログラム終了時に画面が自動的に閉じられてしまいます。

is_pressed(key)

関数が呼ばれた時点でキーボードのキー key が押されていたら true、それ以外の場合は false を返します。

key は文字列を指定します。指定できるキーは以下の通り。

"up" (上キー)
"left" (左キー)
"right" (右キー)
"down" (下キー)
"enter" (エンターキー)
"a" .. "z" (アルファベットキー)

Person クラスと組み合わせた使用例:

person = Person.new()

while true
  if is_pressed("up")
    person.y = person.y - 8
  end
  if is_pressed("down")
    person.y = person.y + 8
  end
  if is_pressed("left")
    person.x = person.x - 8
  end
  if is_pressed("right")
    person.x = person.x + 8
  end
  if is_pressed("enter")
    if person.is_raising_hand()
      person.lower_hand()
    else
      person.raise_hand()
    end
  end
  redisplay_all_objects()
end

show_classes()

hide_classes()

クラス図 (定義されているクラスのツリーおよびメソッド一覧) を表示、非表示にします。

クラス図が表示されている間、呼ばれるメソッドはフラッシュします。

start() (deprecated)

(このメソッドは互換性のために残されています。)

画面を表示します。

Sprite クラス

display()

「何をどう描画するか」の処理が書かれるメソッドです。 Sprite クラスを継承したクラス側で再定義 (オーバーライド) する必要があります。

このメソッドは内容が定義されていればいいのであって、プログラマーが明示的に呼ぶ必要はありません。

paint_out(x, y, color)