変数

変数は重要なプログラミングの概念です。Blockly は、Python や JavaScript などの動的型付け言語をサポートしています。少し手間をかければ、Java や C などの静的型付け言語（または静的型付け言語）をサポートする情報を追加できます。

動的型付け言語と静的型付け言語の詳細については、データ型の概要: 静的、動的、強型、弱型をご覧ください。

Blockly には、ユーザーが指定した変数の名前を表示する動的プルダウン ボックスである変数フィールドが用意されています。以下に例を示します。

変数を選択したり、現在の変数の名前を変更したり、現在の変数を削除したりするためのプルダウンがある変数フィールド。

デフォルトでは、Blockly では任意の型を変数に割り当てることができ、Blockly が提供するすべてのジェネレータは動的型付け言語用です。代わりに型付き言語を使用する場合は、次の操作を行って Blockly を構成し、サポートできます。

型指定なしの変数ブロック

変数にアクセスして操作するための最も基本的なブロックは、ゲッターブロックとセッターブロックです。Blockly が提供するゲッターブロックとセッターブロックについて説明します。

JSON

// Block for variable getter.
{
  "type": "variables_get",
  "message0": "%1",
  "args0": [
    {    // Beginning of the field variable dropdown
      "type": "field_variable",
      "name": "VAR",    // Static name of the field
      "variable": "%{BKY_VARIABLES_DEFAULT_NAME}"    // Given at runtime
    }    // End of the field variable dropdown
  ],
  "output": null,    // Null means the return value can be of any type
  ...
},

// Block for variable setter.
{
  "type": "variables_set",
  "message0": "%{BKY_VARIABLES_SET}",
  "args0": [
    {
      "type": "field_variable",
      "name": "VAR",
      "variable": "%{BKY_VARIABLES_DEFAULT_NAME}"
    },
    {
      "type": "input_value",    // This expects an input of any type
      "name": "VALUE"
    }
  ],
  ...
}

JavaScript

// Block for variable getter.
Blockly.Blocks['variables_get'] = {
  init: function() {
    this.appendDummyInput()
      .appendField(new Blockly.FieldVariable("VAR_NAME"), "FIELD_NAME");
    this.setOutput(true, null);
    ...
  }
};

// Block for variable setter.
Blockly.Blocks['variables_set'] = {
  init: function() {
    this.appendValueInput("NAME")
        .setCheck(null)
        .appendField("set")
        .appendField(new Blockly.FieldVariable("VAR_NAME"), "FIELD_NAME")
        .appendField("to");
    this.setOutput(true, null);
    ...
  }
};

これにより、次の 2 つのブロックが作成されます。

変数 `foo` のゲッター ブロックとセッター ブロック。

重要な点は、変数ゲッターの「出力」を null に設定すると、戻り値が任意の型になることです。また、変数セッターの入力ではチェックが指定されていないことに注意してください。そのため、変数には任意の型の値を設定できます。

型付き変数ブロック

型チェックを強制するゲッターとセッターを追加できます。たとえば、 型が "Panda" の変数を作成した場合、次の定義では適切な型の ゲッターとセッターが作成されます。

JSON

// Block for Panda variable getter.
{
  "type": "variables_get_panda",
  "message0": "%1",
  "args0": [
    {
      "type": "field_variable",
      "name": "VAR",
      "variable": "%{BKY_VARIABLES_DEFAULT_NAME}",
      "variableTypes": ["Panda"],    // Specifies what types to put in the dropdown
      "defaultType": "Panda"
    }
  ],
  "output": "Panda",    // Returns a value of "Panda"
  ...
},

 // Block for Panda variable setter.
{
  "type": "variables_set_panda",
  "message0": "%{BKY_VARIABLES_SET}",
  "args0": [
    {
      "type": "field_variable",
      "name": "VAR",
      "variable": "%{BKY_VARIABLES_DEFAULT_NAME}",
      "variableTypes": ["Panda"],
      "defaultType": "Panda"
    },
    {
      "type": "input_value",
      "name": "VALUE",
      "check": "Panda"    // Checks that the input value is of type "Panda"
    }
  ],
  "previousStatement": null,
  "nextStatement": null,
  ...
}

JavaScript

// Block for Panda variable getter.
Blockly.Blocks['variables_get_panda'] = {
  init: function() {
    this.appendDummyInput()
      .appendField(new Blockly.FieldVariable(
          "VAR_NAME", ['Panda'], 'Panda'), "FIELD_NAME");
    this.setOutput(true, 'Panda');
    ...
  }
};

// Block for Panda variable setter.
Blockly.Blocks['variables_set_panda'] = {
  init: function() {
    this.appendValueInput("NAME")
        .setCheck('Panda')
        .appendField("set")
        .appendField(new Blockly.FieldVariable(
            "VAR_NAME", null, ['Panda'], 'Panda'), "FIELD_NAME")
        .appendField("to");
        this.setPreviousStatement(true, null);
        this.setNextStatement(true, null);
    ...
  }
};

これにより、ゲッターとセッターの 2 種類のブロックが作成されます。プルダウンには、 型 "Panda"の変数のみが表示されます。入力と出力は、 "Panda" 型の接続のみを受け入れます。フィールドの defaultType は、variableTypes 配列の値のいずれかに設定する必要があります。variableTypes 配列を指定したときに defaultType を設定しないと、エラーがスローされます。

デフォルトでは、使用されている型をユーザーに知らせる視覚的なインジケーターはありません。変数型を区別する簡単な方法の 1 つは、 色を使用することです。

ツールボックスに変数を追加する

この新しい型の変数をユーザーが使用できるようにするには、新しい変数を作成して使用する方法を追加する必要があります。

まだ作成していない場合は、変数の新しい動的カテゴリ を作成します。

[変数] という名前の開いているカテゴリに、[変数を作成] ボタンが含まれています。

新しいゲッターとセッターをカテゴリに追加します。

`foo` 変数と `bar` 変数が作成された後の同じカテゴリ。[変数を作成] ボタン、set-variable-to ブロック、change-variable-by ブロック、getter ブロックが含まれています。

[変数を作成] ボタン

次に、ユーザーが変数を作成する方法が必要です。最も簡単な方法は、 [変数を作成] ボタンを使用することです。

ボタンを作成するときに、コールバック呼び出しを行います。

Blockly.Variables.createVariableButtonHandler(button.getTargetWorkspace(), null, 'panda');

"Panda" 型の変数が作成されます。

ユーザーが複数の型の変数を作成できるようにする最も簡単な方法は、型ごとに 1 つの [作成] ボタンを用意することです（例: 文字列変数を作成、数値変数を作成、パンダ変数を作成）。

変数型が 2 つまたは 3 つ以上ある場合は、ボタンが多すぎる可能性があります。その場合は、 @blockly/plugin-typed-variable-modal を使用して、ユーザーが目的の変数型を選択できるポップアップを表示することを検討してください。

ジェネレータを定義する

最後に、新しい変数ブロックのブロックコード ジェネレータを定義する 必要があります。Workspace.getVariableMap().getAllVariables() を使用して変数のリストに直接アクセスし、すべての型のすべての変数を取得することもできます。また、Workspace.getVariableMap().getVariablesOfType() を使用して、特定の型のすべての変数を取得することもできます。