Skip to content

Latest commit

 

History

History
919 lines (728 loc) · 52.4 KB

smalruby-language-spec.ja.md

File metadata and controls

919 lines (728 loc) · 52.4 KB

Smalruby 言語仕様

このドキュメントは、smalrubyで対応しているRuby構文とメソッドを定義します。 ソースコードの packages/scratch-gui/src/lib/ruby-to-blocks-converter/(Ruby→ブロック変換)と packages/scratch-gui/src/lib/ruby-generator/(ブロック→Ruby生成)に基づいています。

注意: このドキュメントは Version 2 API をベースに記載しています。Version 1 との差分は v1 差分 を参照してください。

1. 概要

smalrubyはRubyのサブセットで、MIT Scratch 3.0のビジュアルプログラミングブロックに対応したメソッドを持つ言語です。

重要: smalrubyのRubyコードは内部的にScratchブロックに変換されて実行されます。そのため、対応していないRuby構文やメソッドは使用できません。

標準Rubyとの主な違い

  • クラス定義は限定的(スプライトの設定にのみ使用)
  • module と include に対応 — def メソッドを複数のスプライトで共有可能
  • ループは loop do...end、N.times do...end、while...end、until...end、配列・ハッシュの変数の each do |x|...end(for は不可)
  • 変数: インスタンス変数(@score)、グローバル変数($score)、ローカル変数(score)
  • 文字列の式展開("#{var}")は不可
  • require、例外処理(begin/rescue)は不可
  • puts/print/p は「(値)と 1 秒言う」ブロックになる
  • 複合代入演算子 +=, -=, *=, /=, %= に対応
  • 再帰呼び出しは不可

Ruby との違い(注意)

上の「標準Rubyとの主な違い」は書けない構文の一覧です。ここには、書けるが計算の結果が Ruby と違うものを並べます。コードはブロックに変換され、Scratch のブロックの計算で値が決まるためです。

書き方 スモウルビー Ruby 理由
整数どうしの / 7 / 2 → 3.5、-7 / 2 → -3.5 3、-4(整数の割り算) 「( ) / ( )」のブロックになり、ふつうの割り算になる。整数の商がほしいときは (7 / 2).to_i と書く
負の数の .to_i (-3.5).to_i → -4、(-7 / 2.0).to_i → -4 -3、-3(0 のほうへ切り捨て) 「切り下げ」のブロックになり、小さいほうの整数になる
数として読めない文字を含む文字列の .to_i "12abc".to_i → 0 12(先頭の数字を読む) 文字列全体を数として読めないと 0 になる
負の数のちょうど半分の .round (-2.5).round → -2 -3(0 から遠いほうへ) 「四捨五入」のブロックは大きいほうへ丸める(2.5.round は Ruby と同じ 3)
Math.sin / Math.cos / Math.tan と Math.asin / Math.acos / Math.atan 角度は度(Math.sin(90) → 1、Math.atan(1) → 45) ラジアン(Math.sin(90) → 0.893...、Math.atan(1) → 0.785...) Scratch の「sin」などのブロックは度で計算する
文字列どうしの == / < / > "a" == "A" → true、"10" < "9" → false false、true 「=」「<」「>」のブロックは大文字・小文字を区別せず、数として読める文字列は数として比べる("1" == 1 も true)
0 で割る / 1 / 0 → Infinity エラー(ZeroDivisionError) 「( ) / ( )」のブロックはエラーにならない

% は負の数でも Ruby と同じ値になる(-7 % 2 → 1、7 % -2 → -1)。

2. プログラム構造

トップレベル構造

smalrubyのプログラムは、以下の2つの形式で記述できます。

形式1: classなし(推奨・簡易形式)

# イベントハンドラとメソッド定義をトップレベルに記述する
# 内部的には class Sprite1 ... end でラップされて処理される

self.rotation_style = "left-right"

when_flag_clicked do
  loop do
    move(10)
    bounce_if_on_edge
  end
end

def my_method(a, b)
  a + b
end

形式2: class定義あり

class Cat
  # class定義内でのみ使用可能な設定メソッド
  set_name "ネコ"
  set_x 100
  set_y -50

  when_flag_clicked do
    move(10)
  end
end

class定義の制限

  • クラス名に名前空間は指定できません(Foo::Bar は不可)
  • クラス継承 (class Foo < Bar) は構文上は許容されますが、親クラスは無視されます
  • class定義のトップレベルに置けるのは、イベントハンドラ(when_xxx)、メソッド定義(def)、include、attr_accessor / attr_reader / attr_writer、set_xxx(「class定義のみで使えるメソッド」)のみです

ブロックの中に書けないもの

次のものは書けません。書くと、その行を示すエラーになります(黙って消えることはありません)。

  • イベントハンドラ(when_xxx do ... end)は、do ... end・if・loop などのブロックの中にも、メソッド定義(def)の中にも書けません。ブロックの外(トップレベルやclass定義の直下)に出して、そこから始まるスクリプトにします
  • 値だけの行(x だけ・1 + 2 だけ)は、do ... end・if・loop などのブロックの中には書けません。say(x) のように命令の中で使うか、変数に入れます。メソッド定義(def)の直下でも、最後の行より前には書けません(最後の行に書いた値は戻り値になります。戻り値)
  • シンボルだけの行(:a だけ)は命令ではないので、ブロックの中にもメソッド定義の中(最後の行より前)にも書けません
  • ブロックにできない値だけの行(self・ハッシュ {a: 1}・定数 Foo・正規表現 /a/・"#{x}" のような式展開のある文字列だけ)も命令ではないので、ブロックの中にも、トップレベルにも、メソッド定義の中(最後の行より前)にも書けません(配列 [1] だけの行は、ブロックの中とトップレベルではこれまでどおり書けます)
  • メソッド定義(def ... end)は、do ... end・if・loop などのブロックの中にも、ほかのメソッド定義の中にも、何行目であっても書けません。def から対応する end までをまとめて、ブロックの外(トップレベルや、class定義・module定義の直下)に出します。class定義・module定義の直下には、これまでどおりメソッド(def initialize を含む)やイベントを書けます
when_flag_clicked do
  move(10)
  when_clicked do   # エラー: イベントなので、ほかのブロックの中には書けません
    move(5)
  end
  def my_proc       # エラー: メソッドの定義なので、ブロックの中には書けません
    move(1)
  end
end

module定義とinclude

module を定義し、include でクラスに取り込むことで、メソッドを複数のスプライトで共有できます。

module Utils
  def add(a, b)
    a + b
  end

  def greet
    say("hello")
  end
end

class Sprite1
  include Utils

  when_flag_clicked do
    say(add(1, 5))
  end
end

別のスプライトでも同じモジュールを include して、メソッドを再利用できます。

class Sprite2
  include Utils

  when_flag_clicked do
    say(add(10, 20))
  end
end

制限事項:

  • module 内に置けるのは メソッド定義(def)のみ です(変数代入やネストした module は不可)
  • module_function や extend は使用できません
  • ステージ(class Stage)では module 定義や include は使用できません

class定義のみで使えるメソッド

以下の set_xxx メソッドは class定義のトップレベルでのみ 使用できます(イベントハンドラの中では使用できません)。

スプライト用(class Sprite1 / class Cat など)

メソッド 説明 デフォルト値
set_name "名前" スプライト名を設定 -
set_sprite "名前" スプライトライブラリから読み込み -
set_x 数値 X座標を設定 0
set_y 数値 Y座標を設定 0
set_direction 数値 向きを設定 90
set_visible true/false 表示/非表示を設定 true
set_size 数値 大きさ(%)を設定 100
set_current_costume 数値 コスチューム番号を設定 0
set_rotation_style "スタイル" 回転スタイルを設定 "all around"
set_costumes ["名前1", "名前2"] コスチュームをライブラリから設定 -
set_sounds ["名前1", "名前2"] 音をライブラリから設定 -

ステージ用(class Stage)

メソッド 説明 デフォルト値
set_name "名前" ステージ名を設定 -
set_current_backdrop 数値 現在の背景番号を設定 0
set_backdrops ["名前1", "名前2"] 背景をライブラリから設定 -
set_sounds ["名前1", "名前2"] 音をライブラリから設定 -

注意:

  • スプライト用メソッド(set_x, set_y など)は class Stage では使えません。
  • ステージ用メソッド(set_current_backdrop, set_backdrops)はスプライトクラスでは使えません。
  • トップレベル(classなし形式)では set_xxx は使えませんが、代わりに self.属性 = 値 形式で設定を変更できます(例: self.rotation_style = "left-right")。

ステージのclass定義

ステージは class Stage で設定を記述できます。

class Stage
  set_current_backdrop 1
  set_backdrops ["Arctic", "Blue Sky"]
  set_sounds ["pop"]

  when_flag_clicked do
    switch_backdrop("Blue Sky")
  end
end

注意: ステージの class Stage が省略された場合、ファイル保存時に自動的に class Stage ... end で補完されます。

3. 対応しているRuby構文

リテラル

構文 例 備考
整数 42, -5, 0
浮動小数点数 3.14, 1.0
文字列 "hello", "ネコ" ダブルクォートのみ。式展開(#{})は不可
シンボル :symbol 限定的な用途(ハッシュのキー等)
配列 [1, 2, 3], [x, y] go_to の座標指定、変数への格納に使用
ハッシュ {key: val} キーワード引数、ハッシュ変数の格納に使用。{a: 1}.keys / {a: 1}.values / {a: 1}.each do |k, v| のように、ハッシュ {...} に直接メソッドを使うと、ブロックに変えるときにどの行かがわかるエラーになる。先にハッシュを変数に入れる: @h = {a: 1} → @h.keys。ハッシュの変数には @h.keys / @h.values / @h[:a] / @h[:a] = 1 / @h.length / @h.empty? / @h.key?(:a) / @h.each do |k, v| が使える。キーはシンボルか文字列、値は数・文字列・シンボル・式(@x や 1 + 2)にする。値にハッシュ・配列・nil を入れる(@h = {a: {b: 1}}・@h = {a: [1, 2]})と、ブロックに変えるときにどの行かがわかるエラーになる
範囲 1..10, 1...10 rand() の引数等に使用
true / false true, false ブロックでは true は「(1) = (1)」、false は「(0) < (0)」になる。ただし条件の穴(if / unless / until / while / wait until の条件、&& / || / ! の中、自作ブロックの真偽値の引数)に入る false は空の穴になる(ブロック → Ruby は空の穴を false と書くので、往復しても変わらない)
nil nil
正規表現 /^hello/i =~/!~ 演算子の引数、変数への代入に使用

変数

種類 記法 説明
インスタンス変数 @score スプライトの変数(各スプライト固有)
グローバル変数 $global_score ステージの変数(全スプライト共有)
ローカル変数 score ローカルスコープの変数
# インスタンス変数(スプライトの変数)
@score = 0
@score += 1
@score -= 1
@score *= 2
@score /= 2
@score %= 3

# グローバル変数(ステージの変数)
$high_score = 100

# ローカル変数
count = 0
count += 1

# 文字列変数の結合
@name = "He"
@name += "llo"  # @name は "Hello" になる

代入演算子

演算子 例 備考
= @score = 10 変数に値を代入
+= @score += 1 数値の場合は増加、文字列の場合は結合
-= @score -= 1 変数の値を減少
*= @score *= 2 変数の値を乗算
/= @score /= 2 変数の値を除算
%= @score %= 3 変数の値の剰余

多重代入は、= の右に数・文字列・true / false を変数と同じ数だけ書いた形(@a, @b = 1, "x")だけが使える。ブロックにすると、1 つずつの代入(@a = 1 と @b = "x")になり、Ruby に戻しても 1 つずつの代入のまま。入れかえ(@a, @b = @b, @a)のように右に変数・式・メソッドの呼び出しがある形や、数が合わない形・* を使う形・配列([1, 2])を書いた形は、ブロックに変えるときにどの行かがわかるエラーになる(Ruby は右の値をすべて求めてから入れるので、1 つずつ入れると結果が変わることがあるため)。

条件分岐

# if文
if x > 10
  say("大きい")
end

# if-else文
if touching?("_edge_")
  bounce_if_on_edge
else
  move(10)
end

# if-elsif-else文
if x > 100
  say("とても大きい")
elsif x > 50
  say("大きい")
else
  say("小さい")
end

# unless文
unless touching?("_edge_")
  move(10)
end

# case-when文
case @direction
when 1
  move(10)
when 2
  turn_right(90)
else
  say("不明")
end

# 修飾子if / unless
move(10) if keyboard.pressed?("space")
say("セーフ") unless touching?("_edge_")

case の式と when の値には、値を書きます(値を返すメソッドの呼び出し when foo(1) も書けます)。代入(when (@a = "abc"))や命令(when move(1))は値ではないので、その行の「命令がまちがっています」のエラーになります。when に 2 つ以上の値を書く形(when 1, 2)も使えません。

条件には変数だけを書くこともできます(if @flag・while a < 3 && @x・until @done || a > 3・!@x など)。Ruby と同じく、変数が false のときだけ偽で、0 や空の文字列は真です(ただし Scratch の = は文字を大文字・小文字を区別せずに比べるので、文字の "false" / "FALSE" も偽になります)。ブロックでは「(変数) = (false)」ではない、になり、この「ではない」ブロックにはコメントの印(@ruby:variable_condition)が付きます。ブロック → Ruby では変数だけに戻すので、往復しても書いたとおりに戻ります。

ループ

# 永久ループ
loop do
  move(1)
end

# 回数指定ループ
10.times do
  move(10)
  turn_right(36)
end

# 配列・ハッシュの変数の項目ごとのループ
@items = ["りんご", "バナナ"]
@items.each do |item|
  say(item)
end

@scores = {a: 1, b: 2}
@scores.each do |key, value|
  say(key)
end

# 条件ループ(条件が真である限り繰り返す)
i = 0
while i < 5
  move(5)
  i += 1
end

# 条件ループ(条件が真になるまで繰り返す)
until touching?("_edge_")
  move(5)
end

先に 1 回実行してから条件を確かめる begin ... end while 条件 / begin ... end until 条件 も使えます。ブロックでは、中の命令をループの前に 1 回置いてから「〜まで繰り返す」で繰り返します(Ruby と同じく、最初の 1 回は条件にかかわらず動きます)。ループの前の命令にはコメントの印(@ruby:begin_loop_body)、ループには @ruby:syntax:begin_end が付き、ブロック → Ruby ではループの前の命令を書き出さずに begin ... end while 条件 に戻します。ブロックの画面でループの前とループの中の命令が違うものになったときは、ループの前の命令をそのまま書き、ループはふつうの while / until として書きます。中の命令が、あとに何も続けられない命令(loop do ... end・return など)で終わるときは、条件の行がわかるエラーになります。

中が空のループ: wait until 条件 と do の無い until 条件 / end は「〜まで待つ」になります。until 条件 do / end(または中が with_screen_refresh do / end だけの until 条件)は中が空の「〜まで繰り返す」になり、ブロック → Ruby でも中が空の「〜まで繰り返す」はこの形で書くので、往復してもブロックの種類は変わりません。while も同じです。until / while ... end の中(with_screen_refresh do ... end の中も)の wait は消えません。ループにコメントの印 @ruby:method:wait(両方書いたときは @ruby:method:with_screen_refresh も)が付き、ブロック → Ruby で中の最後に wait を書き戻します。

注意: for ループはサポートされていません。each は配列・ハッシュを入れた変数に使えます([1, 2].each のように配列 [...] に直接使うとエラーになります。先に変数に入れてください)。ループの途中で抜ける break・残りを飛ばす next も使えません(エラーになります)。条件ループの条件で止めてください。

重要 — ループの自動1フレーム待機: loop do...end、N.times do...end、while...end、until...end はすべて、毎ループ終端で自動的に1フレーム(約33ms、30fps相当)待機します。 これはScratchのブロック実行モデルに由来する仕様で、CPUを占有しないよう設計されています。

  • FPS調整のために sleep(0.05) のような小さな値を入れる必要はありません(むしろ動作が遅くなります)
  • sleep は sleep(1) のように意図的に長い待機が必要な場合のみ使ってください

論理演算子

演算子 例 備考
&& / and a && b かつ
|| / or a || b または
! !touching?("_edge_") でない

正規表現マッチ演算子

演算子 例 備考
=~ "hello" =~ /^he/ マッチする場合は真
!~ "hello" !~ /world/ マッチしない場合は真

正規表現リテラルは変数に代入することもできます。

r = /^hello/i
if @name =~ r
  say("マッチ!")
end

対応するフラグ: i(大文字小文字を無視)、m(複数行モード)、x(拡張モード)

注意: 正規表現の内部的な仕組みとして、=~/!~ は「〇〇に△△が含まれる」ブロック(operator_contains)に変換されます。STRING2 に /pattern/ 形式の文字列が設定された場合、VMが正規表現として解釈します。

比較演算子

演算子 例
== @score == 10
!= @score != 0
> x > 100
< x < -100
>= @score >= 100
<= timer.value <= 0

算術演算子

演算子 例
+ @score + 1
- x - 10
* @speed * 2
/ 360 / 10(整数どうしでも小数になる。Ruby との違い(注意))
% @count % 2
** 10 ** 2(10のn乗)
-(単項) -@x、-(@x + 1)(「(0) - (X)」のブロックになる。-1 のような数はそのまま数)

メソッド定義

# メソッド定義
def greet(name)
  say(name)
end

# メソッド呼び出し
greet("こんにちは")

制限事項:

  • 引数はふつうの引数(def foo(a, b))だけです。キーワード引数(def foo(name:))・既定値(def foo(a = 1))・*args・**opts・&blk・... はエラーになります(どの行かがわかるエラー)
  • 引数には代入できません(name = "x" や name += 1 はエラー。ほかの変数に写してから変えてください)
  • クラスメソッド(def self.method)は定義できません
  • attr_accessor/attr_reader/attr_writer は class 定義の中で使えます(attr_accessor :hp のあと、hp で読み、self.hp = 1 で入れる)
  • メソッドのオーバーロードはできません
  • 再帰呼び出しはできません

画面を再描画せずに実行する: 定義ブロックの「画面を再描画せずに実行する」は、def の前に without_screen_refresh を書きます(private def foo と同じ形)。def の前に書かなければ、ふつうの定義ブロック(画面を再描画する)になります。

without_screen_refresh def 学習する(n)
  n.times do
    @見る長さ += 1
  end
end

メソッドにできない名前の定義ブロック: 数字で始まる名前(「1 文字えらぶ」)や Ruby の予約語(end・if など)の名前は、Ruby では前に _ を付けて書きます(def _1_文字えらぶ / 呼び出しも _1_文字えらぶ)。ブロックに戻すと _ は取れます(「1_文字えらぶ」)。_1 から _9 は Ruby のブロックの番号指定パラメータで名前にできないので、1 けたの数字だけの名前は __ を付けます(「1」は __1)。もとから _ で始まる同じ形の名前(「_1x」「_end」)は、もう 1 つ _ を付けます(__1x・__end)。名前の中の空白は _ になります(ブロックに戻しても _ のまま)。

戻り値

def add(a, b)
  a + b  # 最後の式が戻り値になる(暗黙の戻り値)
end

def check(x)
  return true if x > 0  # 明示的なreturn
  false
end

最後の true / false は、return true と同じく「(1) = (1)」/「(0) < (0)」のブロックで返すので、往復しても true / false のまま(文字列の "true" にはならない)。

nil とシンボル(:a)は形にできるブロックが無いので、ブロックでは文字列の "" / "a" として返します。ブロックのコメントに元の形(@ruby:nil / @ruby:symbol:a)を覚えておくので、最後の値でも return nil / return :a でも、往復すると nil / :a に戻ります(ブロックで文字列を書きかえると、書きかえた文字列になります)。

値の無い return も、ブロックでは文字列の "" を返します。コメントの印(@ruby:return-bare)で、往復すると return に戻ります(return "" にはなりません)。

ブロックにできない値(self、配列 [1, 2]、ハッシュ、定数、正規表現、"#{x}" のような式展開のある文字列)は、return でも最後の行でも返せないので、その行がエラーになります(数値・文字列・true / false・変数を返してください)。メソッドの途中の行にそれだけを書いても、命令ではないのでエラーになります。return "a", "b" のように値を 2 つ以上返すこともできないので、エラーになります(返す値を 1 つにしてください)。

リスト(@a = [] の @a など)も、リストのまま返せるブロックが無いので、return @a でも最後の行の @a でもエラーになります(return @a[0] のようにリストの中の値を返してください)。

値を返すメソッドの呼び出し(return bar・return bar(1) + 1・return fact(n - 1) * n)は、say(bar) と同じく「メソッドを呼ぶ」ブロックのあとで戻り値を返すので、往復しても書いたとおりに戻ります。値を返さないメソッド(最後の行が命令だけのもの)や、return より後ろで定義したメソッドの呼び出しは返せないので、エラーになります。

while bar(a) < 3・until bar(a) == 0・wait until bar(a) == 0 のようにループの条件で値を返すメソッドを呼ぶと、ブロックでは「メソッドを呼ぶ」ブロックをループの前と、ループの中の最後の両方に置きます。Ruby と同じく、条件を確かめる前に毎回メソッドが呼ばれます。ループの中の最後の呼び出しにはコメントの印(@ruby:loop_condition_call)が付き、ブロック → Ruby では書き出さないので、往復しても書いたとおりに戻ります。

メソッドの中で、同じ行のほかのメソッドの呼び出しのあとにそのメソッド自身を呼ぶ(return fib(n - 1) + fib(n - 2))と、エラーになります。ブロックでは先に呼んだメソッドの戻り値をスプライトの変数に取っておくので、自分自身の呼び出しの中で同じ行が実行されると、その値が上書きされて Ruby と違う値になるためです(return fact(n - 1) * n のように 1 回だけなら書けます)。

文字列・配列・ハッシュのメソッド("ab".reverse・"ab" * 3・@a.sort など)の値は、ブロックでは「メソッド」のブロックのあとに置く「戻り値」のブロックで読みます。「戻り値」のブロックは最後に動いたメソッドの値なので、1 つの文で 2 つ以上のメソッドの値を使うと(say(("ab" * 3).length + "cd".reverse.length))、それぞれの値をスプライトの変数 @_ret1・@_ret2… に入れてから使います。Ruby に戻すと、次のように変数に入れる形で書き出します(while / until の条件では、ループの中でも毎回入れ直します)。

say(("ab" * 3).length + "cd".reverse.length)
# ブロックにして Ruby に戻すと
@_ret1 = "ab" * 3
@_ret2 = "cd".reverse
say(@_ret1.length + @_ret2.length)

1 つだけ使う形(say("ab".reverse)・say("ab".reverse.upcase))は、書いたとおりに戻ります。プログラムの中で使っている @_retN の名前は使わずに、次の番号を使います。ステージでは、ステージの変数はすべてのスプライトの変数なので、スプライトの変数と同じ名前を使わずに次の番号を使います(スプライトでも、ステージにある名前は使いません)。同じ文の中で、値を入れたあとにプログラムのメソッドを呼ぶとき(say("ab".reverse.length + foo))は、そのメソッドの中の文が同じ変数を上書きしないように、ほかの文と重ならない番号を使います。その文でメソッド自身を呼ぶと(return "ab".reverse.length + f(n - 1))、エラーになります。

return (x + 1) のように値をかっこで囲むと、かっこの中の値を返します。コメントの印(@ruby:return-paren)で、往復するとかっこ付きの return (x + 1) に戻ります(return(1) は return (1) に、return ((1)) は return (1) になります)。かっこの中に 2 行以上((move(10); 1))や何も書かないもの(())はエラーになります。

super

module で定義したメソッドを class で include し、同名のメソッドでオーバーライドしている場合、super でモジュール側のメソッドを呼び出せます。

module Utils
  def greet
    say("こんにちは")
  end
end

class Sprite1
  include Utils

  def greet
    super        # Utils の greet を呼ぶ(引数をそのまま渡す)
    say("さようなら")
  end

  when_flag_clicked do
    greet
  end
end

super(引数) で明示的に引数を渡すこともできます。

module Utils
  def add(a, b)
    a + b
  end
end

class Sprite1
  include Utils

  def add(a, b)
    result = super(a, b)  # Utils の add を呼ぶ
    result * 2
  end
end

super の値は、return super・return super + 1・say(super(a)) のように、ほかの値と同じように使えます。ブロックでは、モジュール側のメソッドを呼ぶブロックのあとで、その戻り値を使います(return bar + 1 と同じ形です)。

制限事項:

  • super は def メソッド内でのみ使用できます
  • include したモジュールに同名メソッドが存在する必要があります
  • super を値として使うときは、モジュール側のメソッドが値を返す必要があります
  • 1 行の中で super の値を使えるのは 1 回だけです(return super + super はエラー。先に x = super のように変数に入れてください)
  • ステージ(class Stage)では使用できません

4. 対応しているメソッド一覧

動き(Motion)

メソッド 説明 例
move(歩数) 向いている方向に移動 move(10)
turn_right(度数) 右に回転 turn_right(15)
turn_left(度数) 左に回転 turn_left(15)
go_to("場所") 指定の場所に移動 go_to("_mouse_"), go_to("_random_")
go_to([x, y]) 指定の座標に移動 go_to([0, 0])
glide("場所", secs: 秒数) 場所に滑らかに移動 glide("_mouse_", secs: 1)
glide([x, y], secs: 秒数) 座標に滑らかに移動 glide([100, 50], secs: 2)
point_towards("対象") 対象の方向を向く point_towards("_mouse_")
bounce_if_on_edge 端に触れたら跳ね返る bounce_if_on_edge
self.direction = 度数 向きを設定 self.direction = 90
self.x = 数値 X座標を設定 self.x = 0
self.y = 数値 Y座標を設定 self.y = 0
self.x += 数値 X座標を変化させる self.x += 10
self.y += 数値 Y座標を変化させる self.y += -10
self.rotation_style = "スタイル" 回転スタイルを設定 self.rotation_style = "left-right"
x 現在のX座標を取得 x
y 現在のY座標を取得 y
direction 現在の向きを取得 direction

go_to / point_towards の対象名:

  • "_mouse_" — マウスポインター
  • "_random_" — ランダムな位置

rotation_style の値:

  • "all around" — 自由に回転
  • "left-right" — 左右のみ
  • "don't rotate" — 回転しない

見た目(Looks)

メソッド 説明 例
say(メッセージ) 吹き出しでメッセージを表示 say("こんにちは")
say(メッセージ, 秒数) 秒数だけ吹き出しを表示 say("やあ", 2)
puts(値) / print(値) / p(値) 「(値)と 1 秒言う」と同じ。Ruby に戻すと元のメソッド名に戻る puts(1)
think(メッセージ) 考え中の吹き出しを表示 think("うーん")
think(メッセージ, 秒数) 秒数だけ考え中の吹き出しを表示 think("うーん", 2)
switch_costume("名前") 指定のコスチュームに変更 switch_costume("costume2")
next_costume 次のコスチュームに変更 next_costume
switch_backdrop("名前") 背景を変更 switch_backdrop("backdrop2")
switch_backdrop_and_wait("名前") 背景を変更して完了を待つ switch_backdrop_and_wait("backdrop2")
next_backdrop 次の背景に変更 next_backdrop
self.size = パーセント 大きさを設定 self.size = 200
self.size += 変化量 大きさを変化させる self.size += 10
set_effect("効果名", 値) 画像効果を設定 set_effect("color", 25)
change_effect_by("効果名", 変化量) 画像効果を変化させる change_effect_by("color", 10)
clear_graphic_effects すべての画像効果をクリア clear_graphic_effects
show スプライトを表示 show
hide スプライトを非表示 hide
go_to_layer("front") 最前面に移動 go_to_layer("front")
go_to_layer("back") 最背面に移動 go_to_layer("back")
go_layers(数, "forward") 前に数レイヤー移動 go_layers(1, "forward")
go_layers(数, "backward") 後ろに数レイヤー移動 go_layers(1, "backward")
costume_number コスチューム番号を取得 costume_number
costume_name コスチューム名を取得 costume_name
backdrop_number 背景番号を取得 backdrop_number
backdrop_name 背景名を取得 backdrop_name
size 大きさ(%)を取得 size

画像効果名: "color", "fisheye", "whirl", "pixelate", "mosaic", "brightness", "ghost"

音(Sound)

メソッド 説明 例
play("音の名前") 音を再生(待たない) play("ニャー")
play_until_done("音の名前") 音が終わるまで待って再生 play_until_done("ニャー")
stop_all_sounds すべての音を止める stop_all_sounds
change_sound_effect_by("効果名", 変化量) 音の効果を変化させる change_sound_effect_by("PITCH", 10)
set_sound_effect("効果名", 値) 音の効果を設定 set_sound_effect("PITCH", 100)
clear_sound_effects 音の効果をクリア clear_sound_effects
self.volume = 値 音量を設定 self.volume = 50
self.volume += 変化量 音量を変化させる self.volume += -10
volume 現在の音量を取得 volume

音の効果名: "PITCH", "PAN"

イベント(Events)

メソッド 説明 例
when_flag_clicked do...end 旗が押されたとき when_flag_clicked do ... end
when_key_pressed("キー") do...end キーが押されたとき when_key_pressed("space") do ... end
when_clicked do...end スプライトがクリックされたとき when_clicked do ... end
when_backdrop_switches("名前") do...end 背景が切り替わったとき when_backdrop_switches("backdrop2") do ... end
when_greater_than("種類", 値) do...end 値が超えたとき when_greater_than("LOUDNESS", 10) do ... end
when_receive("メッセージ") do...end メッセージを受け取ったとき when_receive("start") do ... end
broadcast("メッセージ") メッセージを送る broadcast("start")
broadcast_and_wait("メッセージ") メッセージを送って待つ broadcast_and_wait("start")

キー名: "space", "left arrow", "right arrow", "up arrow", "down arrow", "any", "a"〜"z", "0"〜"9"

when_greater_than の種類: "LOUDNESS", "TIMER"

制御(Control)

メソッド 説明 例
sleep(秒数) 指定秒数待つ sleep(1)
loop do...end ずっと繰り返す loop do ... end
数値.times do...end 指定回数繰り返す 10.times do ... end
if 条件...end もし〜なら if x > 0 ... end
if 条件...else...end もし〜でなければ if x > 0 ... else ... end
until 条件 do...end 〜まで繰り返す until touching?("_edge_") do ... end
while 条件 do...end 〜である間繰り返す while @score < 100 ... end
stop("対象") 実行を止める stop("all")
create_clone("対象") クローンを作る create_clone("_myself_")
delete_this_clone このクローンを削除 delete_this_clone
when_start_as_a_clone do...end クローンされたとき when_start_as_a_clone do ... end

stop の対象: "all", "this script", "other scripts in sprite"

create_clone の対象: "_myself_", スプライト名

調べる(Sensing)

メソッド 説明 例
touching?("対象") 対象に触れているか touching?("_mouse_"), touching?("_edge_")
touching_color?("色") 色に触れているか touching_color?("#ff0000")
color_is_touching_color?("色1", "色2") 色が色に触れているか color_is_touching_color?("#ff0000", "#00ff00")
distance("対象") 対象までの距離 distance("_mouse_")
ask("質問") 質問して答えを待つ ask("名前は?")
answer 答えを取得 answer
keyboard.pressed?("キー") キーが押されているか keyboard.pressed?("space")
mouse.down? マウスが押されているか mouse.down?
mouse.x マウスのX座標 mouse.x
mouse.y マウスのY座標 mouse.y
self.drag_mode = "モード" ドラッグモードを設定 self.drag_mode = "draggable"
loudness マイクの音量 loudness
timer.value タイマーの値 timer.value
timer.reset タイマーをリセット timer.reset
Time.now.year 現在の年 Time.now.year
Time.now.month 現在の月 Time.now.month
Time.now.day 現在の日 Time.now.day
Time.now.hour 現在の時 Time.now.hour
Time.now.min 現在の分 Time.now.min
Time.now.sec 現在の秒 Time.now.sec
Time.now.wday + 1 曜日(1=日〜7=土) Time.now.wday + 1
days_since_2000 2000年からの日数 days_since_2000
user_name ユーザー名 user_name

touching? の対象名:

  • "_mouse_" — マウスポインター
  • "_edge_" — 端
  • スプライト名 — 他のスプライト

他のスプライト/ステージの情報を取得する:

sprite("Sprite2").x           # X座標
sprite("Sprite2").y           # Y座標
sprite("Sprite2").direction   # 向き
sprite("Sprite2").costume_number  # コスチューム番号
sprite("Sprite2").costume_name    # コスチューム名
sprite("Sprite2").size        # 大きさ
sprite("Sprite2").volume      # 音量
sprite("Sprite2").variable("@score")  # 変数の値

stage.backdrop_number   # ステージの背景番号
stage.backdrop_name     # ステージの背景名
stage.volume            # ステージの音量
stage.variable("$var")  # ステージの変数の値

演算(Operators)

メソッド 説明 例
rand(範囲) ランダムな数 rand(1..10)
rand(n) 0 以上 n 未満の整数の乱数(n は 1 以上の整数。ブロックでは「0 から n-1 までの乱数」) rand(10)
値.round 四捨五入 3.7.round
値.abs 絶対値 (-5).abs
値.floor 切り捨て 3.7.floor
値.ceil 切り上げ 3.2.ceil
Math.sqrt(数値) 平方根 Math.sqrt(9)
Math.sin(数値) サイン Math.sin(90)
Math.cos(数値) コサイン Math.cos(0)
Math.tan(数値) タンジェント Math.tan(45)
Math.asin(数値) アークサイン Math.asin(1)
Math.acos(数値) アークコサイン Math.acos(0)
Math.atan(数値) アークタンジェント Math.atan(1)
Math.log(数値) 自然対数 Math.log(10)
Math.log10(数値) 常用対数 Math.log10(100)
Math::E ** 数値 eのn乗 Math::E ** 2
10 ** 数値 10のn乗 10 ** 3
文字列.length 文字列の長さ "hello".length
文字列.include?(部分文字列) 文字列を含むか "hello".include?("ell")
文字列[位置] 文字列の文字を取得(位置は 0 から数える。変数や式も使える。ブロックでは「(位置 + 1) 番目の文字」) "hello"[0], "hello"[i]
文字列1 + 文字列2 文字列の結合 "hello" + " world"
文字列 =~ /正規表現/ 正規表現にマッチするか "hello" =~ /^he/
/正規表現/ =~ 文字列 正規表現にマッチするか(逆順) /^he/ =~ "hello"
文字列 !~ /正規表現/ 正規表現にマッチしないか "hello" !~ /world/
/正規表現/ !~ 文字列 正規表現にマッチしないか(逆順) /world/ !~ "hello"

変数/リスト(Data)

変数の使用

# スプライトの変数(インスタンス変数)
@score = 0
@score += 1      # 増加
@score -= 1      # 減少
@score *= 2      # 乗算
@score /= 2      # 除算
@score %= 3      # 剰余

# ステージの変数(グローバル変数)
$high_score = 100

# ローカル変数
count = 0

# 文字列変数の結合
@greeting = "He"
@greeting += "llo"  # "Hello" になる

# 変数の表示/非表示
show_variable("@score")
hide_variable("@score")

リスト(配列)の使用

# 配列リテラルで初期化
@items = ["りんご", "バナナ", "さくらんぼ"]

# 操作(0起点インデックス)
@items.push("りんご")          # 末尾に追加
@items.delete_at(0)            # インデックス指定で削除(0起点)
@items.delete_at(-1)           # 末尾を削除
@items.clear                   # 全削除
@items.insert(0, "バナナ")     # インデックス指定で挿入(0起点)
@items[0] = "みかん"           # インデックス指定で置換(0起点)
@items[0]                      # インデックス指定で取得(0起点)
@items.index("りんご")         # 検索(0起点のインデックスを返す、見つからない場合は0)
@items.length                  # 長さ
@items.include?("りんご")      # 含むか
@items.empty?                  # 空か
show_list("@items")            # リストの表示
hide_list("@items")            # リストの非表示
say(@items)                    # リストそのもの(「リスト items」ブロック)を値として渡す

ブロックの「(リスト) の (k) 番目」「(文字列) の (k) 番目の文字」のように 1 から数える番号は、Ruby では @items[@k - 1] / @s[@k - 1] と書く。添字が 式 - 1(式から整数の 1 を引く形)のときは、ブロックに戻すと「(式) 番目」になる(@items[@k - 1] は「(k) 番目」、@items[rand(1..@n) - 1] は「(1 から n までの乱数) 番目」)。[] / []= / insert / delete_at のどれも同じ。そのほかの添字(@items[@k]、@items[@k - 2]、@items[3 - 1])は「(添字 + 1) 番目」になる。

同じ @a を変数とリストの両方には使えない(Scratch では同じ名前の変数とリストを持てるが、Ruby の @a は 1 つ)。そのため、スプライト(またはステージ)に同じ名前の変数 a とリスト a の両方があるときだけ、Ruby ではリストを @_a_list_(ステージは $_a_list_)と書く。ブロックに戻すとリスト a になる(名前は a のまま)。同じスプライトに _a_list_ という名前の変数かリストもあるときは、リスト a を @_a_list2_(それもあれば @_a_list3_、…)と書き、名前が重ならないようにする(@_a_list2_ がリスト a になるのは @_a_list_ が別の変数かリストのときだけ。@_a_list3_ は @_a_list_ と @_a_list2_ の両方がそうのときだけ)。両方があるときの @a は変数 a。@_a_list_ のような名前の変数やリストを自分で作っていたときは、その名前のまま読む(スプライトに _a_list_ という名前の変数かリストがある、@_a_list_ = 0 のように数や文字列を入れている、または a という名前の変数・リストがどこにも無いとき)。@a = 0 と @a = [] のように 1 つの @a を両方に使うと、ブロックに変えるときにどの行かがわかるエラーになる。リストを値として読むだけ(@a = [] のあとの say(@a))はエラーにならない。文字列を入れた変数の length / include? / empty? / [i] は文字列のブロックになり、リストは作られない。index は文字列のブロックが無いので、文字列だけを入れる名前の @a.index("x") は「文字列の『index』はブロックにできません」というどの行かがわかるエラーになる(リストのエラーにはならない)。どちらとして使うかはコード全体から決める(書いた順によらない): 配列([])を入れる・push / << / insert / delete_at / clear / @a[i] = x を使う名前はリスト、それ以外の値(文字列・数・gets など)だけを入れる名前は変数として読む。メソッドやイベントの中で代入より先に @a.length を読んでも、最後に数を入れても同じ。コードからわからないときは、スプライト(またはステージ)にあるものから決める: 変数だけ(または変数とリストの両方)があれば変数、リストだけがあればリストとして読む(say(@a) もリストを読む)。どちらも無く、どちらも書いていない名前(say(@a.length) だけ)はリストとして読む。リストとして使っていたコードを変数に書きかえたとき(@a = [] → @a = 0)は、スプライト(またはステージ)にあるリストはそのまま残り、変数がとなりに作られる。このコードでリストとして使っていなければエラーにならない。ローカル変数は、別々のメソッドや、別々のイベント(when_flag_clicked do などのブロック)の中では別の変数なので、片方で文字列・もう片方でリストに使ってもエラーにならない(ブロックの外で同じ名前に代入しているときは、ブロックの中もその変数なので、同じ名前を両方に使うとエラーになる)。

5. サポートされていないRuby構文

以下のRuby構文はsmalrubyでは使用できません:

  • for ループ
  • 配列 [...] に直接使うメソッド([1, 2].each do |i| や [1, 2].first のように、配列 [...] に直接 each / first / last / max / min / sort / reverse / join を使うと、ブロックに変えるときにどの行かがわかるエラーになる。先に配列を変数に入れる: @a = [1, 2] → @a.first・@a.each do |i|)
  • break / next / redo / retry(Scratch に当たるブロックがないので、ブロックに変えるときにどの行かがわかるエラーになる。くり返しは until x > 3 ... end(「〜まで繰り返す」)の条件で止め、残りを飛ばしたいときは if で囲む)
  • rescue / else / ensure(例外処理。def ... rescue ... end・do ... rescue ... end・修飾子の x rescue y も含む。ブロックに変えるときに、その節の行がわかるエラーになる。節の無い begin ... end と begin ... end while は使える)
  • module_function, extend(module と include はサポート)
  • private / protected / public(private :foo や private def foo ... end の形も含む。どこに書いてもエラーになるので消す。private def foo ... end は private を消せば def foo ... end として使える。自分で def private ... end と定義したメソッドを呼ぶのはエラーにならない)
  • require / require_relative
  • 文字列の式展開 ("Hello #{name}")
  • 多重代入のうち、右に変数・式・メソッドの呼び出しがある形(a, b = b, a など。右が数・文字列・true / false だけの a, b = 1, 2 は使える。「代入演算子」を参照)
  • alias / undef / BEGIN / END(ブロックに変えるときにどの行かがわかるエラーになる)
  • ||= / &&=(@a ||= 0 など。ブロックに変えるときにどの行かがわかるエラーになる。先に @a = 0 と入れておく)
  • 定数への代入(FOO = 1。ブロックに変えるときにどの行かがわかるエラーになる。変数 @foo = 1 を使う)
  • リストの要素への代入演算子(@a[0] += 1 など。ブロックに変えるときにどの行かがわかるエラーになる。@a[0] = @a[0] + 1 と書く)
  • ふつうの引数でない引数(def foo(a = 1) の既定値・*args・a: / a: 1 のキーワード引数・**opts・&blk・...・3.times do |i = 1| や do |i; j|。ブロックに変えるときにどの行かがわかるエラーになる)
  • 受けない数のブロック引数(when_key_pressed("a") do |k|・loop do |x|・3.times do |i, j| など。ハットと loop はブロック引数を受けず、N.times と配列の each は 0 か 1 つ、ハッシュの each は 0 か 2 つ(do |k, v|。do はハッシュの組の数だけくり返す。@h.each do |k| はエラー)。My Block の呼び出しはブロックを受けない。ブロックに変えるときにどの行かがわかるエラーになる)
  • ブロックの代わりに & で値を渡す呼び出し(@a.each(&:x)・@a.each(&blk)・3.times(&blk) など。ブロックに変えるときにどの行かがわかるエラーになる。@a.each do |x| のように do ... end で書く)
  • 端が数・値でない範囲(rand(self..2)・rand(1..:a)・rand("a".."z") など。ブロックに変えるときにどの行かがわかるエラーになる。端に gets や値を返すメソッドを使うときは、先に変数に入れる: @n = gets.to_i → rand(1..@n))
  • each 以外のブロック付きのイテレータ(map / select / each_with_index など。each と N.times do |i| は使える)
  • プロック / ラムダ
  • yield
  • open / ファイルI/O

6. よくある間違い

# ❌ set_x / change_x は使えません
set_x(100)
change_x(10)

# ✅ self.x = / self.x += を使います
self.x = 100
self.x += 10
# ⚠️ self. を付けない x = / y = は、右辺によって意味が変わります
x = 100        # 右辺が数・変数だけ → x 座標を 100 にする(self.x = 100 と同じ)
x = bar(1)     # 右辺にメソッドの呼び出しや super・計算がある → ローカル変数 x への代入
x = 1 + bar(1) #   (x 座標は変わらない)
x = super

# ✅ 座標を変えたいときは、いつも self.x = / self.y = と書きます
self.x = bar(1)
self.y = super

# ✅ 計算に使う一時的な変数には、x / y 以外の名前を使います
v = bar(1)
return v

direction / size など、self.名前 = で設定できる属性の名前も同じです。迷わないよう、属性を変えるときは self. を付け、一時的な変数には属性と同じ名前を使わないようにしてください。

# ❌ mouse_x / mouse_y は使えません
mouse_x
key_pressed?("space")
timer
reset_timer

# ✅ 正しいメソッド名を使います
mouse.x
keyboard.pressed?("space")
timer.value
timer.reset
# ❌ "_mouse_pointer_" は正しくありません
touching?("_mouse_pointer_")

# ✅ "_mouse_" を使います
touching?("_mouse_")
# ❌ glide の引数の順序が違います
glide(1, 100, 50)

# ✅ 座標を配列で、秒数をキーワード引数で渡します
glide([100, 50], secs: 1)
# ❌ play_sound / stop_sounds は正しくありません
play_sound("ニャー")
stop_sounds

# ✅ 正しいメソッド名を使います
play("ニャー")
stop_all_sounds
# ❌ set_size / change_size は使えません(class定義外)
set_size(200)
change_size(10)

# ✅ self.size = / self.size += を使います
self.size = 200
self.size += 10
# ❌ 配列 [...] に直接 each は使えません
[1, 2, 3].each do |n|
  say(n)
end

# ✅ 先に配列を変数に入れてから each を使います
@numbers = [1, 2, 3]
@numbers.each do |n|
  say(n)
end