変数フィールド

変数フィールドには文字列を値として格納し、文字列をテキストに格納します。値は変数の ID で、テキストは変数の名前です。

変数フィールド

エディタを開いた状態の変数フィールド

閉じたブロックの [変数] フィールド

動画を作成

型指定なし

JSON

{
  "type": "example_variable_untyped",
  "message0": "variable: %1",
  "args0": [
    {
      "type": "field_variable",
      "name": "FIELDNAME",
      "variable": "x"
    }
  ]
}

JavaScript

Blockly.Blocks['example_variable_untyped'] = {
  init: function() {
    this.appendDummyInput()
        .appendField('variable:')
        .appendField(new Blockly.FieldVariable('x'), 'FIELDNAME');
  }
};

Typed

JSON

{
  "type": "example_variable_typed",
  "message0": "variable: %1",
  "args0": [
    {
      "type": "field_variable",
      "name": "FIELDNAME",
      "variable": "x",
      "variableTypes": ["Number", "String"],
      "defaultType": "Number"
    }
  ]
}

JavaScript

Blockly.Blocks['example_variable_typed'] = {
  init: function() {
    this.appendDummyInput()
      .appendField('variable:')
      .appendField(new Blockly.FieldVariable(
          'X',
          null,
          ['Number', 'String'],
          'Number'
      ), 'FIELDNAME');
  }
};

変数コンストラクタは、オプションの変数名、オプションのvalidator、変数型の配列（オプション）、オプションのデフォルト型を受け取ります。

  • 変数名は文字列にする必要があります。これは、フィールドで保持される初期変数の名前です。null または未定義の場合は、一意の名前が生成されます。
  • 変数タイプは文字列の配列です。これは、そのフィールドが保持できる変数のタイプ（プルダウンに追加する変数のタイプ）をフィールドに指示します。null または未定義の場合は、すべての変数タイプが受け入れられます（プルダウンに追加されます）。
  • デフォルトのタイプは文字列です。これは、フィールドの初期変数モデルの作成時に使用されます。これが定義されている場合は、変数タイプの配列に含める必要があります。null または未定義の場合、この値はデフォルトで空の文字列になります。つまり、初期変数は柔軟に型付けされます。

→ 厳密な型指定について詳しくは、型チェックをご覧ください。

シリアル化

JSON

変数フィールドの JSON は次のようになります。

{
  "fields": {
    "FIELDNAME": {
      "id": "QJD^+@[RVIwbLSZoDb:V"
    }
  }
}

ここで、FIELDNAME は変数フィールドを参照する文字列、値はフィールドが参照する変数の ID です。

ツールボックスでこのフィールドを使用している場合は、参照できる変数がないため、名前と型（省略可）を直接指定することもできます。

{
  "fields": {
    "FIELDNAME": {
      "name": "my_variable",
      "type": "string"
    }
  }
}

XML

変数フィールドの XML は次のようになります。

<field name="VARIABLE" id="QJD^+@[RVIwbLSZoDb:V" variabletype="">name</field>
  • ノードの name 属性に、変数フィールドを参照する文字列が含まれている。
  • ノードの id 属性には、フィールドが参照する変数の ID が含まれます。
  • 変数の型はノードの variabletype 属性に含まれます。variabletype は、コンストラクタのデフォルトの型パラメータと同じルールに従います。
  • ノードの内部テキストは変数の名前です。内部テキストの値は、コンストラクタの変数名パラメータと同じルールに従います。

変数バリデータの作成

変数フィールドの値は文字列であるため、すべてのバリデータは文字列を受け入れ、文字列、null、または undefined を返す必要があります。

事前定義された変数をオプションとしてのみ受け入れるバリデータの例を次に示します。これらの変数は、ワークスペースを読み込むときに Workspace.createVariable 関数で定義する必要があります。

function(newValue) {
  var validIds = ['Worf', 'Riker', 'Picard'];
  if (validIds.indexOf(newValue) == -1) {
    return null;
  }
  return newValue;
}