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