進行ルールとゲームアクション

ジャンプ

鍵をすでに購入している場合は、Warehouseの開始地点へ直接ジャンプします。targetはflowRefとentryRefを持ち、execution.entries[entryRef].nodeRefから次のノードを取得します。Jumpがエンジンのシーンやマップを自動で開くわけではありません。それには対応するゲームアクションが必要です。

{
  "flowRef": "1f69a7b6-1bdc-4dff-b8ee-9b2819b35168",
  "id": "2e1710dc-c32f-418f-abca-e055d6fd28f3",
  "kind": "jump",
  "target": {
    "entryRef": "a4dd48dc-b0e2-47fc-b102-def52583a8fe",
    "flowRef": "2a0a259c-b76a-4de0-8cee-567713c2d320"
  }
}

サブストーリー呼び出し／復帰

この流れもJSONで表現されています。挨拶の後、鍵のかかった倉庫の説明を呼び出します。ゲームはcontinuationをスタックに積み、targetへ移ります。ミラの説明後にreturnへ到達したら、直近のcontinuationを取り出して「Already have the key?」へ進みます。入れ子の呼び出しも同じルールです。

{
  "continuation": {
    "kind": "node",
    "nodeRef": "95e9a55f-f6b1-4696-9c52-6ea3ea2ac7e5"
  },
  "flowRef": "1f69a7b6-1bdc-4dff-b8ee-9b2819b35168",
  "id": "85b3aadf-2b95-4150-bc44-c0c796337874",
  "kind": "call",
  "target": {
    "entryRef": "2bac8555-3cae-4a21-9b8c-b410ab207ebb",
    "flowRef": "ea13b52e-092a-44ff-b087-0ce65d040c9a"
  }
}

{
  "flowRef": "ea13b52e-092a-44ff-b087-0ce65d040c9a",
  "id": "f8b8673a-cb86-40ae-a4f6-d37a5c1563c3",
  "kind": "return"
}

関係するすべてのノードはstory.jsonに含まれます。Callは別のJSONやスクリプトを読み込む操作ではありません。入れ子の深さはmaxCallDepthで制限します。空のスタックでReturnするとエラーです。一方、Endは会話全体を終了し、スタックを空にします。

コマンド

例えば店を開く場合、ゲーム側が店の画面を開いて会話を一時停止します。店を閉じてから、purchasedやcancelledなどの合意済みの結果を返します。結果の名前と引数はVNLEプロジェクトのゲームアクションで定義してください。open_shopはVNLEの組み込みコマンドではありません。

港の実際のエクスポートではgive_itemを使います。コマンドは定義を参照し、アイテムIDと2つの結果を持ちます。ゲームは鍵をインベントリに追加するか、受け取りを拒否します。どちらの結果にも、その後の進行先が作成者によって設定されています。

{
  "arguments": {
    "3cac6185-4404-4a2a-be5f-14afa0f97137": {
      "kind": "literal",
      "value": {
        "entityType": "item",
        "type": "reference",
        "value": "2d71e57e-9b58-4fdb-a33f-42b89bd8bf04"
      }
    }
  },
  "commandRef": "0723beb0-daba-4602-a665-4efc27511bc3",
  "flowRef": "1f69a7b6-1bdc-4dff-b8ee-9b2819b35168",
  "id": "500c28a1-ed85-4c36-9a38-bedacce1c6b7",
  "kind": "command",
  "outcomes": {
    "12bc86a9-b2eb-4eb4-836c-a9efd936bf1b": {
      "continuation": {
        "kind": "node",
        "nodeRef": "382640aa-5b50-4715-9148-b470bc2f7cd6"
      },
      "resultBindings": {}
    },
    "1c527580-69a6-4e99-8503-1b0de3fc8e78": {
      "continuation": {
        "kind": "node",
        "nodeRef": "221d6b0c-99e1-45a8-bc73-768c4ee679eb"
      },
      "resultBindings": {}
    }
  }
}

{
  "id": "0723beb0-daba-4602-a665-4efc27511bc3",
  "key": "give_item",
  "name": "Give item",
  "category": "custom",
  "inputs": [
    {
      "id": "3cac6185-4404-4a2a-be5f-14afa0f97137",
      "name": "Item",
      "valueType": {
        "entityType": "item",
        "kind": "reference"
      }
    }
  ],
  "outcomes": [
    {
      "id": "12bc86a9-b2eb-4eb4-836c-a9efd936bf1b",
      "name": "Received",
      "results": []
    },
    {
      "id": "1c527580-69a6-4e99-8503-1b0de3fc8e78",
      "name": "Declined",
      "results": []
    }
  ]
}

1. commandRefをexecution.commandsで調べてシグネチャを取得し、content.commandDefinitionsで読みやすいキーを取得します。
2. 入力IDを使って引数を評価します。省略可能な引数がなければ、定義されたdefaultValueを使います。
3. 明示的に対応しているゲームアクションを一度だけ要求します。結果を待つ間は、Continueや二重実行を許可しないでください。
4. 結果IDと型付きの戻り値を検証します。outcome.resultBindingsに従って値を物語の変数へ代入し、outcome.continuationへ進みます。
5. 技術的な失敗を、自動的に作成者のキャンセル結果として扱ってはいけません。エラーを表示し、ゲーム側で再試行やキャンセルの手順を用意します。

このプロジェクトでは、鍵を受け取れないと5ゴールドを返金します。これはエクスポート内の進行先による動作で、すべてのCommandに自動で付く処理ではありません。インベントリ、クエストログ、マップはゲーム側の仕組みです。JSONの項目だけでは作られません。

テキストとプレースホルダー

{
  "continuation": {
    "kind": "node",
    "nodeRef": "2e1710dc-c32f-418f-abca-e055d6fd28f3"
  },
  "flowRef": "1f69a7b6-1bdc-4dff-b8ee-9b2819b35168",
  "id": "0d7f959e-8fba-4882-ae98-b66d8416d4d2",
  "kind": "dialogue",
  "speakerRef": "807b2957-7bab-4a28-83a4-1f3d1589bbc2",
  "text": {
    "bindings": {
      "1084cf8e-515e-4b33-92f8-b5c260e88a9e": {
        "kind": "variable",
        "variableRef": "a547610e-661f-4b8d-a25b-21d042f1a2d5"
      }
    },
    "textRef": "fcc775ff-558e-4a41-823d-183aaff03e4b"
  }
}

kind: textのセグメントはそのまま連結します。kind: placeholderではplaceholderRefを使い、テキスト項目内の定義とnode.text.bindings内のバインディングを探します。バインディングはリテラル値か変数値を提供します。セリフを表示する時点の値を保持し、型に合った形式で表示してください。型と書式はフィールドリファレンスで確認できます。

PlaceholderDefinition · メッセージ