このページは Cloud Translation API によって翻訳されました。

カスタムプロシージャブロックの作成

カスタムプロシージャブロックを作成するには、次が必要です。

手順の使用ページの説明に従って、@blockly/block-shareable-procedures プラグインをインストールします。
概要ページの説明に沿って、JSON シリアル化システムを使用します。

ワークスペースにデータモデルを追加する

プロシージャ定義とプロシージャの呼び出し元のブロックはどちらも、プロシージャの署名（名前、パラメータ、戻り値）を定義するバッキングデータモデルを参照します。これにより、アプリケーションを設計する際の柔軟性が向上します（たとえば、あるワークスペースでプロシージャを定義して別のワークスペースで参照できます）。

つまり、ブロックを機能させるには、プロシージャデータモデルをワークスペースに追加する必要があります。これにはさまざまな方法があります（カスタム UI など）。

@blockly/block-shareable-procedures は、procedure-Definition ブロックにより、ワークスペースにインスタンス化される際のバッキングデータモデルを動的に作成します。これを自身で実装するには、init でモデルを作成し、destroy でモデルを削除します。

import {ObservableProcedureModel} from '@blockly/block-shareable-procedures';

Blockly.Blocks['my_procedure_def'] = {
  init: function() {
    this.model = new ObservableProcedureModel('default name');
    this.workspace.getProcedureMap().add(model);
    // etc...
  }

  destroy: function() {
    // Optionally:
    // Destroy the model when the definition block is deleted.
    this.workpace.getProcedureMap().delete(model.getId());
  }
}

ブロックに関する情報を返す

プロシージャ定義とプロシージャ呼び出しのブロックには、getProcedureModel、isProcedureDef、getVarModels の各メソッドを実装する必要があります。これらは、Blockly コードでプロシージャブロックに関する情報を取得するために使用するフックです。

Blockly.Blocks['my_procedure_def'] = {
  getProcedureModel() {
    return this.model;
  },

  isProcedureDef() {
    return true;
  },

  getVarModels() {
    // If your procedure references variables
    // then you should return those models here.
    return [];
  },
};

Blockly.Blocks['my_procedure_call'] = {
  getProcedureModel() {
    return this.model;
  },

  isProcedureDef() {
    return false;
  },

  getVarModels() {
    // If your procedure references variables
    // then you should return those models here.
    return [];
  },
};

更新時に再レンダリングをトリガー

プロシージャ定義とプロシージャ呼び出しのブロックには、doProcedureUpdate メソッドを実装する必要があります。これは、データモデルが呼び出すフックで、プロシージャブロックに再レンダリングするよう指示します。

Blockly.Blocks['my_procedure_def'] = {
  doProcedureUpdate() {
    this.setFieldValue('NAME', this.model.getName());
    this.setFieldValue(
        'PARAMS',
        this.model.getParameters()
            .map((p) => p.getName())
            .join(','));
    this.setFieldValue(
        'RETURN', this.model.getReturnTypes().join(',');
  }
};

Blockly.Blocks['my_procedure_call'] = {
  doProcedureUpdate() {
    // Similar to the def block above...
  }
};

カスタムのシリアル化を追加する

プロシージャブロックのシリアル化では、2 つの処理を個別に行う必要があります。

JSON から読み込む場合は、ブロックとモデルが個別にシリアル化されるため、ブロックはバッキングデータモデルへの参照を取得する必要があります。
プロシージャブロックをコピーして貼り付ける場合、ブロックではプロシージャモデルの状態全体をシリアル化して複製や複製を行う必要があります。

どちらも saveExtraState と loadExtraState を通じて処理されます。ここでも、カスタムプロシージャブロックは JSON シリアル化システムを使用する場合にのみサポートされるため、JSON シリアル化フックを定義するだけで済みます。

import {
    ObservableProcedureModel,
    ObservableParameterModel,
    isProcedureBlock
} from '@blockly/block-shareable-procedures';

Blockly.Blocks['my_procedure_def'] = {
  saveExtraState() {
    return {
      'procedureId': this.model.getId(),

      // These properties are only necessary for pasting.
      'name': this.model.getName(),
      'parameters': this.model.getParameters().map((p) => {
        return {name: p.getName(), p.getId()};
      }),
      'returnTypes': this.model.getReturnTypes(),
    };
  },

  loadExtraState(state) {
    const id = state['procedureId']
    const map = this.workspace.getProcedureMap();

    // Grab a reference to the existing procedure model.
    if (this.model.getId() != id && map.has(id) &&
        (this.isInsertionMarker || this.noBlockHasClaimedModel_(id))) {
      // Delete the existing model (created in init).
      this.workspace.getProcedureMap().delete(model.getId());
      // Grab a reference to the new model.
      this.model = this.workspace.getProcedureMap()
          .get(state['procedureId']);
      this.doProcedureUpdate();
      return;
    }

    // There is no existing procedure model (we are likely pasting), so
    // generate it from JSON.
    this.model
        .setName(state['name'])
        .setReturnTypes(state['returnTypes']);
    for (const [i, param] of state['parameters'].entries()) {
      this.model.insertParameter(
          i,
          new ObservableParameterModel(
              this.workspace, param['name'], param['id']));
    }
  },

  // We don't want to reference a model that some other procedure definition
  // is already referencing.
  noBlockHasClaimedModel_(procedureId) {
    const model =
      this.workspace.getProcedureMap().get(procedureId);
    return this.workspace.getAllBlocks(false).every(
      (block) =>
        !isProcedureBlock(block) ||
        !block.isProcedureDef() ||
        block.getProcedureModel() !== model);
  },
};

Blockly.Blocks['my_procedure_call'] = {
  saveExtraState() {
    return {
      'procedureId': this.model.getId(),
    };
  },

  loadExtraState(state) {
    // Delete our existing model (created in init).
    this.workspace.getProcedureMap().delete(model.getId());
    // Grab a reference to the new model.
    this.model = this.workspace.getProcedureMap()
        .get(state['procedureId']);
    if (this.model) this.doProcedureUpdate();
  },

  // Handle pasting after the procedure definition has been deleted.
  onchange(event) {
    if (event.type === Blockly.Events.BLOCK_CREATE &&
        event.blockId === this.id) {
      if(!this.model) { // Our procedure definition doesn't exist =(
        this.dispose();
      }
    }
  }
};

必要に応じてプロシージャのモデル/署名を変更する

ユーザーがプロシージャモデル/署名を変更する機能を追加することもできます。insertParameter、deleteParameter、または setReturnTypes のメソッドを呼び出すと、ブロックが自動的に（doProcedureUpdate を介して）再レンダリングされます。

UI を作成してプロシージャモデルを変更するオプションには、ミューテータ（組み込みのプロシージャブロックが使用する）、クリックハンドラを含む画像フィールド、Blockly の完全に外部的なものなどがあります。

ツールボックスにブロックを追加する

Blockly の組み込み動的プロシージャカテゴリは、Blockly の組み込みプロシージャブロックに固有のものです。そのため、ブロックにアクセスするには、独自のカスタム動的カテゴリを定義して、ツールボックスに追加する必要があります。

const proceduresFlyoutCallback = function(workspace) {
  const blockList = [];
  blockList.push({
    'kind': 'block',
    'type': 'my_procedure_def',
  });
  for (const model of
        workspace.getProcedureMap().getProcedures()) {
    blockList.push({
      'kind': 'block',
      'type': 'my_procedure_call',
      'extraState': {
        'procedureId': model.getId(),
      },
    });
  }
  return blockList;
};

myWorkspace.registerToolboxCategoryCallback(
    'MY_PROCEDURES', proceduresFlyoutCallback);