変数は、プログラミングの重要な概念です。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 つのブロックが作成されます。
注意すべき重要な点は、変数ゲッターの「output」を 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 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 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 つに色があります。
ツールボックスへの変数の追加
この新しいタイプの変数をユーザーにとって便利なものにするには、新しい変数を作成して使用する方法を追加する必要があります。
変数用の新しい動的カテゴリを作成します(まだ作成していない場合)。
新しいゲッターとセッターをカテゴリに追加します。
[変数を作成] ボタン
次に、変数を作成する方法が必要です。最も簡単な方法は、[変数を作成] ボタンを使用する方法です。
ボタンを作成する際に、コールバック呼び出しを行う
Blockly.Variables.createVariableButtonHandler(button.getTargetWorkspace(), null, 'panda');
Panda 型変数が作成されます。
複数のタイプの変数をユーザーが作成できるようにする最も簡単な方法は、タイプごとに 1 つの「作成」ボタンを用意することです(例: 文字列変数の作成、数値変数の作成、Panda 変数の作成)。
変数タイプが 2 つまたは 3 つを超えると、すぐにボタンの数が多くなってしまいます。その場合は、@blockly/plugin-typed-variable-modal を使用して、ユーザーが目的の変数タイプを選択できるポップアップを表示することを検討してください。
ジェネレータを定義する
最後に、新しい variable ブロックにブロックコード ジェネレータを定義する必要があります。すべての型の変数を取得するには Blockly.Workspace.getAllVariables() を使用して変数のリストに直接アクセスし、特定の型のすべての変数を取得するには Blockly.Workspace.getVariablesOfType() を使用して変数のリストに直接アクセスすることもできます。