VNLEガイド
JSONフィールドリファレンス
実行データとコンテンツ
formatとcontainerVersionがデータ形式を識別します。executionには開始地点とノード、contentには文章、翻訳、各種項目が入ります。表同士はUUIDで結び付け、表示名で参照しないでください。JSONにはコメントを書けないため、説明は外に分けてサンプルを有効なJSONに保っています。
// Explanation only — not a JSON file
// execution.entries[entryId].nodeRef -> execution.nodes[nodeId]
// node.text.textRef -> content.texts[textId].sourceMessage
// content.translations[locale][textId].message -> translated segments
// dialogue.continuation.nodeRef -> next node
// end -> stop; never keep advancing
story.json
言語の切り替えと未翻訳の扱い
言語は現在のノードとは別に保存します。切り替えたら同じtextRefを再取得し、localeの翻訳があれば使い、なければsourceMessageを使います。言語の表がない場合も未翻訳として扱います。allowEmptyは意図的な空欄に対応します。プレースホルダーは型に従って表示し、JSONそのものを文字列化しないでください。翻訳が古いかどうかは原文のフィンガープリントで判断します。workflowStatusだけでは新しさを判断できません。
現在のエクスポートスキーマから参照されるすべての定義を掲載しています。以下には全プロパティ、形式の違い、制約が含まれます。Schemaを開くと入れ子のルールも確認できます。additionalPropertiesがfalseの場所では、余分なフィールドは認められません。
JSON Schema · Draft 2020-12
Capability
Schema · Capability
{
"type": "string",
"pattern": "^[a-z][a-z0-9.-]*$",
"title": "Capability"
}
ContentAsset
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
mediaType | string · 必須 | メディアコンテンツのMIMEタイプ。 |
relativePath | RelativePath · 必須 | 検証済みの相対アセットパス。確認せずにファイルシステムのパスとして使用しないでください。 |
contentHash | Hash · 必須 | 参照されたメディアバイトのSHA-256。 |
displayName | string · 必須 | 人が読み取れるアセットの表示名。 |
licenseNote | string | アセットのライセンスに関するメモ。法的な確認が自動で行われるわけではありません。 |
width | integer | 構造と有効な値は、型とスキーマを参照してください。
{"minimum":0,"maximum":2147483647} |
height | integer | 構造と有効な値は、型とスキーマを参照してください。
{"minimum":0,"maximum":2147483647} |
byteSize | integer | 構造と有効な値は、型とスキーマを参照してください。
{"minimum":0,"maximum":2147483647} |
originalName | string | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · ContentAsset
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"mediaType": {
"type": "string"
},
"relativePath": {
"$ref": "#/$defs/RelativePath"
},
"contentHash": {
"$ref": "#/$defs/Hash"
},
"displayName": {
"type": "string"
},
"licenseNote": {
"type": "string"
},
"width": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"height": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"byteSize": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647
},
"originalName": {
"type": "string"
}
},
"required": [
"id",
"mediaType",
"relativePath",
"contentHash",
"displayName"
],
"additionalProperties": false,
"title": "ContentAsset"
}
ContentCharacter
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
nameTextRef | Id · 必須 | ローカライズされた名前のテキストID。 |
color | string · 必須 | キャラクターの表示色。ロジックに使う値ではありません。
{"pattern":"^#[0-9a-fA-F]{6}$"} |
defaultPortraitRef | Id | キャラクターの標準ポートレート用アセット。汎用エクスポートには含まれません。 |
emotions | object · 必須 | 感情ID→感情定義。
{"additionalProperties":{"$ref":"#/$defs/Emotion"}} |
emotions[key] | Emotion | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · ContentCharacter
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"nameTextRef": {
"$ref": "#/$defs/Id"
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"defaultPortraitRef": {
"$ref": "#/$defs/Id"
},
"emotions": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/Emotion"
}
}
},
"required": [
"id",
"name",
"key",
"nameTextRef",
"color",
"emotions"
],
"additionalProperties": false,
"title": "ContentCharacter"
}
ContentCommandDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
category | string · 必須 | 定義を整理するのに使用されるカタログカテゴリ。 |
inputs | Array<ParameterDefinition> · 必須 | 名前と型を持つシグネチャの入力項目。 |
outcomes | Array<OutcomeDefinition> · 必須 | コマンドが返し得る結果の名前と、そのデータ契約およびバインディング。
{"minItems":1} |
description | string | 作成者が記述した説明。実行可能な命令ではありません。 |
Schema · ContentCommandDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"category": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"$ref": "#/$defs/ParameterDefinition"
}
},
"outcomes": {
"type": "array",
"items": {
"$ref": "#/$defs/OutcomeDefinition"
},
"minItems": 1
},
"description": {
"type": "string"
}
},
"required": [
"id",
"name",
"key",
"category",
"inputs",
"outcomes"
],
"additionalProperties": false,
"title": "ContentCommandDefinition"
}
ContentItemDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
nameTextRef | Id · 必須 | ローカライズされた名前のテキストID。 |
descriptionTextRef | Id | 翻訳可能な説明文のテキストID。 |
iconAssetRef | Id | カタログアイコンのアセットID。 |
Schema · ContentItemDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"nameTextRef": {
"$ref": "#/$defs/Id"
},
"descriptionTextRef": {
"$ref": "#/$defs/Id"
},
"iconAssetRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"id",
"name",
"key",
"nameTextRef"
],
"additionalProperties": false,
"title": "ContentItemDefinition"
}
ContentLocationDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
nameTextRef | Id · 必須 | ローカライズされた名前のテキストID。 |
descriptionTextRef | Id | 翻訳可能な説明文のテキストID。 |
previewAssetRef | Id | プレビューリソースのアセットID。 |
Schema · ContentLocationDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"nameTextRef": {
"$ref": "#/$defs/Id"
},
"descriptionTextRef": {
"$ref": "#/$defs/Id"
},
"previewAssetRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"id",
"name",
"key",
"nameTextRef"
],
"additionalProperties": false,
"title": "ContentLocationDefinition"
}
ContentMinigameDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
nameTextRef | Id | ローカライズされた名前のテキストID。 |
commandRef | Id · 必須 | 実行するゲームコマンドのID。 |
Schema · ContentMinigameDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"nameTextRef": {
"$ref": "#/$defs/Id"
},
"commandRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"id",
"name",
"key",
"commandRef"
],
"additionalProperties": false,
"title": "ContentMinigameDefinition"
}
ContentQuestDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
titleTextRef | Id · 必須 | ローカライズされたタイトルのテキストID。 |
descriptionTextRef | Id | 翻訳可能な説明文のテキストID。 |
objectiveDefinitions | Array<QuestObjective> · 必須 | クエスト目標ID → 目標の定義。 |
Schema · ContentQuestDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"titleTextRef": {
"$ref": "#/$defs/Id"
},
"descriptionTextRef": {
"$ref": "#/$defs/Id"
},
"objectiveDefinitions": {
"type": "array",
"items": {
"$ref": "#/$defs/QuestObjective"
}
}
},
"required": [
"id",
"name",
"key",
"titleTextRef",
"objectiveDefinitions"
],
"additionalProperties": false,
"title": "ContentQuestDefinition"
}
ContentTextEntry
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
key | Key | 人が読める固定キー。技術的な参照にはIDを使います。 |
category | string · 必須 | 定義を整理するのに使用されるカタログカテゴリ。 |
sourceMessage | メッセージ · 必須 | テキストとプレースホルダーセグメントから作られたソースメッセージ。 |
placeholders | object · 必須 | プレースホルダーキー→タイプ/フォーマット定義。
{"additionalProperties":{"$ref":"#/$defs/PlaceholderDefinition"}} |
placeholders[key] | PlaceholderDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
externalUse | boolean · 必須 | ノードグラフの外で使用されるテキストをマークします。 |
Schema · ContentTextEntry
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"key": {
"$ref": "#/$defs/Key"
},
"category": {
"type": "string"
},
"sourceMessage": {
"$ref": "#/$defs/Message"
},
"placeholders": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/PlaceholderDefinition"
}
},
"externalUse": {
"type": "boolean"
}
},
"required": [
"id",
"category",
"sourceMessage",
"placeholders",
"externalUse"
],
"additionalProperties": false,
"title": "ContentTextEntry"
}
ContentVariableDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
key | Key · 必須 | 人が読める固定キー。技術的な参照にはIDを使います。 |
valueType | ScalarType · 必須 | 想定される値のデータ契約。使用可能なエンティティの型を含みます。 |
defaultValue | ScalarValue · 必須 | 型を持つ初期値/既定値。 |
description | string | 作成者が記述した説明。実行可能な命令ではありません。 |
Schema · ContentVariableDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"key": {
"$ref": "#/$defs/Key"
},
"valueType": {
"$ref": "#/$defs/ScalarType"
},
"defaultValue": {
"$ref": "#/$defs/ScalarValue"
},
"description": {
"type": "string"
}
},
"required": [
"id",
"name",
"key",
"valueType",
"defaultValue"
],
"additionalProperties": false,
"title": "ContentVariableDefinition"
}
Emotion
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
portraitRef | Id | 感情に対応するポートレートのアセット。汎用エクスポートには含まれません。 |
Schema · Emotion
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"portraitRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false,
"title": "Emotion"
}
EntityType
Schema · EntityType
{
"type": "string",
"enum": [
"item",
"quest",
"location",
"minigame",
"asset"
],
"title": "EntityType"
}
EntryRef
| フィールド | 型/必須 | 意味/ルール |
|---|
flowRef | Id · 必須 | シーン/サブストーリーのID。 |
entryRef | Id · 必須 | 指定されたフロー内のエントリーID。 |
Schema · EntryRef
{
"type": "object",
"properties": {
"flowRef": {
"$ref": "#/$defs/Id"
},
"entryRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"flowRef",
"entryRef"
],
"additionalProperties": false,
"title": "EntryRef"
}
ExecutableChoiceOption
Schema · ExecutableChoiceOption
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"text": {
"$ref": "#/$defs/ExecutableTextUse"
},
"condition": {
"$ref": "#/$defs/ExecutableCondition"
},
"effects": {
"type": "array",
"items": {
"$ref": "#/$defs/ExecutableEffect"
}
},
"continuation": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"id",
"text",
"effects",
"continuation"
],
"additionalProperties": false,
"title": "ExecutableChoiceOption"
}
ExecutableCondition
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].kind | "compare" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 1].left | ExecutableOperand · 必須 | 比較の左辺となる型付きオペランド。 |
[oneOf 1].operator | "eq" | "ne" | "lt" | "lte" | "gt" | "gte" · 必須 | 比較/論理演算子; 許可された値はバリアントに表示されます。 |
[oneOf 1].right | ExecutableOperand · 必須 | 比較の右辺となる型付きオペランド。 |
[oneOf 2].kind | "all" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 2].children | Array<ExecutableCondition> · 必須 | 複合条件に含まれる子条件。 |
[oneOf 3].kind | "any" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 3].children | Array<ExecutableCondition> · 必須 | 複合条件に含まれる子条件。 |
[oneOf 4].kind | "not" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 4].child | ExecutableCondition · 必須 | 単項演算子が対象とする子条件。 |
Schema · ExecutableCondition
{
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "compare"
},
"left": {
"$ref": "#/$defs/ExecutableOperand"
},
"operator": {
"type": "string",
"enum": [
"eq",
"ne",
"lt",
"lte",
"gt",
"gte"
]
},
"right": {
"$ref": "#/$defs/ExecutableOperand"
}
},
"required": [
"kind",
"left",
"operator",
"right"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "all"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/ExecutableCondition"
}
}
},
"required": [
"kind",
"children"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "any"
},
"children": {
"type": "array",
"items": {
"$ref": "#/$defs/ExecutableCondition"
}
}
},
"required": [
"kind",
"children"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "not"
},
"child": {
"$ref": "#/$defs/ExecutableCondition"
}
},
"required": [
"kind",
"child"
],
"additionalProperties": false
}
],
"title": "ExecutableCondition"
}
ExecutableContinuation
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].kind | "node" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 1].nodeRef | Id · 必須 | 次の実行可能ノードID。 |
[oneOf 2].kind | "end" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
Schema · ExecutableContinuation
{
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "node"
},
"nodeRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"kind",
"nodeRef"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "end"
}
},
"required": [
"kind"
],
"additionalProperties": false
}
],
"title": "ExecutableContinuation"
}
ExecutableEffect
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].kind | "set" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 1].variableRef | Id · 必須 | 読み書きする変数の ID 。 |
[oneOf 1].value | ExecutableOperand · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
[oneOf 2].kind | "add" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 2].variableRef | Id · 必須 | 読み書きする変数の ID 。 |
[oneOf 2].value | ExecutableOperand · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
[oneOf 3].kind | "subtract" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 3].variableRef | Id · 必須 | 読み書きする変数の ID 。 |
[oneOf 3].value | ExecutableOperand · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
Schema · ExecutableEffect
{
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "set"
},
"variableRef": {
"$ref": "#/$defs/Id"
},
"value": {
"$ref": "#/$defs/ExecutableOperand"
}
},
"required": [
"kind",
"variableRef",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "add"
},
"variableRef": {
"$ref": "#/$defs/Id"
},
"value": {
"$ref": "#/$defs/ExecutableOperand"
}
},
"required": [
"kind",
"variableRef",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "subtract"
},
"variableRef": {
"$ref": "#/$defs/Id"
},
"value": {
"$ref": "#/$defs/ExecutableOperand"
}
},
"required": [
"kind",
"variableRef",
"value"
],
"additionalProperties": false
}
],
"title": "ExecutableEffect"
}
ExecutableEmptyChoice
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].kind | "continue" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 1].continuation | ExecutableContinuation · 必須 | ノードの処理が完了した後の進行先。 |
[oneOf 2].kind | "fault" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
Schema · ExecutableEmptyChoice
{
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "continue"
},
"continuation": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"kind",
"continuation"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "fault"
}
},
"required": [
"kind"
],
"additionalProperties": false
}
],
"title": "ExecutableEmptyChoice"
}
ExecutableNode
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 1].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 1].kind | "dialogue" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 1].text | ExecutableTextUse · 必須 | テキストセグメントでは文章そのもの。テキストを参照する箇所ではtextRefとbindings。 |
[oneOf 1].speakerRef | Id | 話者のキャラクターID。省略時は話者が未指定。 |
[oneOf 1].emotionRef | Id | この会話で選択したキャラクターの感情。 |
[oneOf 1].continuation | ExecutableContinuation · 必須 | ノードの処理が完了した後の進行先。 |
[oneOf 2].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 2].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 2].kind | "choice" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 2].optionOrder | Array<Id> · 必須 | 表示順に並べた選択肢のID。 |
[oneOf 2].options | object · 必須 | 選択肢ID → 文章、条件、進行先を含む選択肢。
{"additionalProperties":{"$ref":"#/$defs/ExecutableChoiceOption"}} |
[oneOf 2].options[key] | ExecutableChoiceOption | 構造と有効な値は、型とスキーマを参照してください。 |
[oneOf 2].whenEmpty | ExecutableEmptyChoice · 必須 | 選べる回答が一つもない場合の動作。 |
[oneOf 3].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 3].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 3].kind | "branch" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 3].condition | ExecutableCondition · 必須 | 分岐や選択肢の有効化の前に評価する条件。 |
[oneOf 3].whenTrue | ExecutableContinuation · 必須 | 条件が真の場合の進行先。 |
[oneOf 3].whenFalse | ExecutableContinuation · 必須 | 条件が偽の場合の進行先。 |
[oneOf 4].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 4].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 4].kind | "action" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 4].effects | Array<ExecutableEffect> · 必須 | アクションノードが順番に適用する状態の変更。 |
[oneOf 4].continuation | ExecutableContinuation · 必須 | ノードの処理が完了した後の進行先。 |
[oneOf 5].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 5].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 5].kind | "command" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 5].commandRef | Id · 必須 | 実行するゲームコマンドのID。 |
[oneOf 5].arguments | object · 必須 | 呼び出しに渡す、名前付きの引数値。
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}} |
[oneOf 5].arguments[key] | ExecutableOperand | 構造と有効な値は、型とスキーマを参照してください。 |
[oneOf 5].outcomes | object · 必須 | コマンドが返し得る結果の名前と、そのデータ契約およびバインディング。
{"additionalProperties":{"$ref":"#/$defs/ExecutableOutcomeBinding"}} |
[oneOf 5].outcomes[key] | ExecutableOutcomeBinding | 構造と有効な値は、型とスキーマを参照してください。 |
[oneOf 6].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 6].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 6].kind | "jump" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 6].target | EntryRef · 必須 | 変数や開始地点などを指す型付き参照。正確な構造は各形式を参照してください。 |
[oneOf 7].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 7].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 7].kind | "end" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 8].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 8].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 8].kind | "call" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 8].target | EntryRef · 必須 | 変数や開始地点などを指す型付き参照。正確な構造は各形式を参照してください。 |
[oneOf 8].continuation | ExecutableContinuation · 必須 | ノードの処理が完了した後の進行先。 |
[oneOf 9].id | Id · 必須 | 安定したID;表示名はキーではありません。 |
[oneOf 9].flowRef | Id · 必須 | シーン/サブストーリーのID。 |
[oneOf 9].kind | "return" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
Schema · ExecutableNode
{
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "dialogue"
},
"text": {
"$ref": "#/$defs/ExecutableTextUse"
},
"speakerRef": {
"$ref": "#/$defs/Id"
},
"emotionRef": {
"$ref": "#/$defs/Id"
},
"continuation": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"id",
"flowRef",
"kind",
"text",
"continuation"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "choice"
},
"optionOrder": {
"type": "array",
"items": {
"$ref": "#/$defs/Id"
},
"uniqueItems": true
},
"options": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ExecutableChoiceOption"
}
},
"whenEmpty": {
"$ref": "#/$defs/ExecutableEmptyChoice"
}
},
"required": [
"id",
"flowRef",
"kind",
"optionOrder",
"options",
"whenEmpty"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "branch"
},
"condition": {
"$ref": "#/$defs/ExecutableCondition"
},
"whenTrue": {
"$ref": "#/$defs/ExecutableContinuation"
},
"whenFalse": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"id",
"flowRef",
"kind",
"condition",
"whenTrue",
"whenFalse"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "action"
},
"effects": {
"type": "array",
"items": {
"$ref": "#/$defs/ExecutableEffect"
}
},
"continuation": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"id",
"flowRef",
"kind",
"effects",
"continuation"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "command"
},
"commandRef": {
"$ref": "#/$defs/Id"
},
"arguments": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ExecutableOperand"
}
},
"outcomes": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ExecutableOutcomeBinding"
}
}
},
"required": [
"id",
"flowRef",
"kind",
"commandRef",
"arguments",
"outcomes"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "jump"
},
"target": {
"$ref": "#/$defs/EntryRef"
}
},
"required": [
"id",
"flowRef",
"kind",
"target"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "end"
}
},
"required": [
"id",
"flowRef",
"kind"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "call"
},
"target": {
"$ref": "#/$defs/EntryRef"
},
"continuation": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"id",
"flowRef",
"kind",
"target",
"continuation"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"kind": {
"const": "return"
}
},
"required": [
"id",
"flowRef",
"kind"
],
"additionalProperties": false
}
],
"title": "ExecutableNode"
}
ExecutableOperand
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].kind | "literal" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 1].value | TypedValue · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
[oneOf 2].kind | "variable" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 2].variableRef | Id · 必須 | 読み書きする変数の ID 。 |
Schema · ExecutableOperand
{
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "literal"
},
"value": {
"$ref": "#/$defs/TypedValue"
}
},
"required": [
"kind",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "variable"
},
"variableRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"kind",
"variableRef"
],
"additionalProperties": false
}
],
"title": "ExecutableOperand"
}
ExecutableOutcomeBinding
| フィールド | 型/必須 | 意味/ルール |
|---|
resultBindings | object · 必須 | コマンド結果名 → 返された値の宛先変数。
{"additionalProperties":{"$ref":"#/$defs/Id"}} |
resultBindings[key] | Id | 構造と有効な値は、型とスキーマを参照してください。 |
continuation | ExecutableContinuation · 必須 | ノードの処理が完了した後の進行先。 |
Schema · ExecutableOutcomeBinding
{
"type": "object",
"properties": {
"resultBindings": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/Id"
}
},
"continuation": {
"$ref": "#/$defs/ExecutableContinuation"
}
},
"required": [
"resultBindings",
"continuation"
],
"additionalProperties": false,
"title": "ExecutableOutcomeBinding"
}
ExecutableStory
| フィールド | 型/必須 | 意味/ルール |
|---|
format | "vnle.story" · 必須 | このデータコンテナの正確なフォーマット識別子。 |
containerVersion | 1 · 必須 | 物語のコンテナ形式のバージョンを示す整数。現在は1。 |
storyBuildId | Hash · 必須 | 正規化された実行データのSHA-256。コンテンツのみの変更では変わりません。 |
execution | ExecutionContract · 必須 | 型が定義された実行データの契約。 |
content | object · 必須 | 実行データから分離された、言語と各種項目のデータ。
{"additionalProperties":false} |
content.sourceLocale | Locale · 必須 | テキストとフォールバックのソースロケール。 |
content.locales | Array<Locale> · 必須 | 原文の言語を含む、宣言済みのエクスポート言語。
{"minItems":1} |
content.fallbackPolicy | FallbackPolicy · 必須 | 現在はsource。翻訳がなければ原文を使用します。 |
content.texts | object · 必須 | テキストID → ソースメッセージ、プレースホルダー、メタデータ。
{"additionalProperties":{"$ref":"#/$defs/ContentTextEntry"}} |
content.texts[key] | ContentTextEntry | 構造と有効な値は、型とスキーマを参照してください。 |
content.translations | object · 必須 | 言語 → テキストID → 翻訳。項目がなければ原文を使用します。
{"additionalProperties":{"type":"object","propertyNames":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"additionalProperties":{"$ref":"#/$defs/Translation"},"minProperties":1}} |
content.translations[key] | object | 構造と有効な値は、型とスキーマを参照してください。 |
content.characters | object · 必須 | キャラクターID→ローカライズされた名前と感情を持つキャラクター。
{"additionalProperties":{"$ref":"#/$defs/ContentCharacter"}} |
content.characters[key] | ContentCharacter | 構造と有効な値は、型とスキーマを参照してください。 |
content.quests | object · 必須 | クエストID → 目標を含むクエストの定義。
{"additionalProperties":{"$ref":"#/$defs/ContentQuestDefinition"}} |
content.quests[key] | ContentQuestDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
content.items | object · 必須 | アイテムID → アイテムの定義。
{"additionalProperties":{"$ref":"#/$defs/ContentItemDefinition"}} |
content.items[key] | ContentItemDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
content.locations | object · 必須 | 場所ID → 場所の定義。
{"additionalProperties":{"$ref":"#/$defs/ContentLocationDefinition"}} |
content.locations[key] | ContentLocationDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
content.minigames | object · 必須 | ミニゲームID → 定義。ゲームの動作は呼び出し側で実装します。
{"additionalProperties":{"$ref":"#/$defs/ContentMinigameDefinition"}} |
content.minigames[key] | ContentMinigameDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
content.assets | object · 必須 | アセットID → メディアの定義。汎用エクスポートでは、エンジンで利用するアセットの解決結果は提供されません。
{"additionalProperties":{"$ref":"#/$defs/ContentAsset"}} |
content.assets[key] | ContentAsset | 構造と有効な値は、型とスキーマを参照してください。 |
content.variableDefinitions | object · 必須 | 名前とテキスト参照を含む、作成者が定義した変数。
{"additionalProperties":{"$ref":"#/$defs/ContentVariableDefinition"}} |
content.variableDefinitions[key] | ContentVariableDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
content.commandDefinitions | object · 必須 | テキスト参照を含む、作成者が定義したコマンド。
{"additionalProperties":{"$ref":"#/$defs/ContentCommandDefinition"}} |
content.commandDefinitions[key] | ContentCommandDefinition | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · ExecutableStory
{
"type": "object",
"properties": {
"format": {
"const": "vnle.story"
},
"containerVersion": {
"const": 1
},
"storyBuildId": {
"$ref": "#/$defs/Hash"
},
"execution": {
"$ref": "#/$defs/ExecutionContract"
},
"content": {
"type": "object",
"properties": {
"sourceLocale": {
"$ref": "#/$defs/Locale"
},
"locales": {
"type": "array",
"items": {
"$ref": "#/$defs/Locale"
},
"minItems": 1,
"uniqueItems": true
},
"fallbackPolicy": {
"$ref": "#/$defs/FallbackPolicy"
},
"texts": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentTextEntry"
}
},
"translations": {
"type": "object",
"propertyNames": {
"pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$"
},
"additionalProperties": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/Translation"
},
"minProperties": 1
}
},
"characters": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentCharacter"
}
},
"quests": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentQuestDefinition"
}
},
"items": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentItemDefinition"
}
},
"locations": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentLocationDefinition"
}
},
"minigames": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentMinigameDefinition"
}
},
"assets": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentAsset"
}
},
"variableDefinitions": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentVariableDefinition"
}
},
"commandDefinitions": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ContentCommandDefinition"
}
}
},
"required": [
"sourceLocale",
"locales",
"fallbackPolicy",
"texts",
"translations",
"characters",
"quests",
"items",
"locations",
"minigames",
"assets",
"variableDefinitions",
"commandDefinitions"
],
"additionalProperties": false
}
},
"required": [
"format",
"containerVersion",
"storyBuildId",
"execution",
"content"
],
"additionalProperties": false,
"title": "ExecutableStory"
}
ExecutableTextUse
| フィールド | 型/必須 | 意味/ルール |
|---|
textRef | Id · 必須 | content.textsと、そのテキストの契約への参照。 |
bindings | object · 必須 | プレースホルダー/パラメーター名 → 型付きオペランド。
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}} |
bindings[key] | ExecutableOperand | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · ExecutableTextUse
{
"type": "object",
"properties": {
"textRef": {
"$ref": "#/$defs/Id"
},
"bindings": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ExecutableOperand"
}
}
},
"required": [
"textRef",
"bindings"
],
"additionalProperties": false,
"title": "ExecutableTextUse"
}
ExecutionContract
| フィールド | 型/必須 | 意味/ルール |
|---|
format | "vnle.execution" · 必須 | このデータコンテナの正確なフォーマット識別子。 |
contractVersion | RuntimeVersion · 必須 | 実行互換性バージョン:メジャーとマイナー。 |
projectId | Id · 必須 | ソースプロジェクトの安定したID。 |
requiredCapabilities | Array<Capability> · 必須 | 完全な実行アダプターが開始前に確認すべき機能。 |
limits | object · 必須 | 自動実行と再帰の上限。
{"additionalProperties":false} |
limits.maxAutomaticTransitions | 1000 · 必須 | ユーザー入力を待たずに自動で進める回数の上限。 |
limits.maxConditionDepth | 32 · 必須 | 条件の入れ子の深さの上限。 |
limits.maxConditionTerms | 1024 · 必須 | 条件項目数の上限。 |
limits.maxCallDepth | 32 · 必須 | サブストーリー呼び出しの入れ子の深さの上限。 |
entries | object · 必須 | エントリーID→フローとノード参照。
{"additionalProperties":{"$ref":"#/$defs/RuntimeEntry"}} |
entries[key] | RuntimeEntry | 構造と有効な値は、型とスキーマを参照してください。 |
nodes | object · 必須 | ノードID → 実行可能なノード。kindでフィールドが決まります。
{"additionalProperties":{"$ref":"#/$defs/ExecutableNode"}} |
nodes[key] | ExecutableNode | 構造と有効な値は、型とスキーマを参照してください。 |
variables | object · 必須 | 変数ID → 実行時の型付き変数の定義。
{"additionalProperties":{"$ref":"#/$defs/RuntimeVariable"}} |
variables[key] | RuntimeVariable | 構造と有効な値は、型とスキーマを参照してください。 |
commands | object · 必須 | コマンドID → 実行時の型付きシグネチャ。
{"additionalProperties":{"$ref":"#/$defs/RuntimeSignature"}} |
commands[key] | RuntimeSignature | 構造と有効な値は、型とスキーマを参照してください。 |
textContracts | object · 必須 | テキストID → 実行に必要なプレースホルダー契約。
{"additionalProperties":{"$ref":"#/$defs/PlaceholderContract"}} |
textContracts[key] | PlaceholderContract | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · ExecutionContract
{
"type": "object",
"properties": {
"format": {
"const": "vnle.execution"
},
"contractVersion": {
"$ref": "#/$defs/RuntimeVersion"
},
"projectId": {
"$ref": "#/$defs/Id"
},
"requiredCapabilities": {
"type": "array",
"items": {
"$ref": "#/$defs/Capability"
},
"uniqueItems": true
},
"limits": {
"type": "object",
"properties": {
"maxAutomaticTransitions": {
"const": 1000
},
"maxConditionDepth": {
"const": 32
},
"maxConditionTerms": {
"const": 1024
},
"maxCallDepth": {
"const": 32
}
},
"required": [
"maxAutomaticTransitions",
"maxConditionDepth",
"maxConditionTerms",
"maxCallDepth"
],
"additionalProperties": false
},
"entries": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/RuntimeEntry"
}
},
"nodes": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ExecutableNode"
}
},
"variables": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/RuntimeVariable"
}
},
"commands": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/RuntimeSignature"
}
},
"textContracts": {
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/PlaceholderContract"
}
}
},
"required": [
"format",
"contractVersion",
"projectId",
"requiredCapabilities",
"limits",
"entries",
"nodes",
"variables",
"commands",
"textContracts"
],
"additionalProperties": false,
"title": "ExecutionContract"
}
FallbackPolicy
Schema · FallbackPolicy
{
"type": "string",
"enum": [
"block",
"source"
],
"title": "FallbackPolicy"
}
Hash
Schema · Hash
{
"type": "string",
"pattern": "^sha256:[0-9a-f]{64}$",
"title": "Hash"
}
Id
Schema · Id
{
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"title": "Id"
}
Key
Schema · Key
{
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,127}$",
"title": "Key"
}
Locale
Schema · Locale
{
"type": "string",
"pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$",
"title": "Locale"
}
メッセージ
| フィールド | 型/必須 | 意味/ルール |
|---|
kind | "segments" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
segments | Array<object | object> · 必須 | 順番に並んだテキストとプレースホルダーのセグメント。 |
Schema · Message
{
"type": "object",
"properties": {
"kind": {
"const": "segments"
},
"segments": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"const": "text"
},
"text": {
"type": "string"
}
},
"required": [
"kind",
"text"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"kind": {
"const": "placeholder"
},
"placeholderRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"kind",
"placeholderRef"
],
"additionalProperties": false
}
]
}
}
},
"required": [
"kind",
"segments"
],
"additionalProperties": false,
"title": "Message"
}
OutcomeDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
results | Array<ResultDefinition> · 必須 | 各結果が返す、名前と型を持つ値。 |
Schema · OutcomeDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"results": {
"type": "array",
"items": {
"$ref": "#/$defs/ResultDefinition"
}
}
},
"required": [
"id",
"name",
"results"
],
"additionalProperties": false,
"title": "OutcomeDefinition"
}
ParameterDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
valueType | ValueType · 必須 | 想定される値のデータ契約。使用可能なエンティティの型を含みます。 |
defaultValue | TypedValue | 型を持つ初期値/既定値。 |
Schema · ParameterDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"valueType": {
"$ref": "#/$defs/ValueType"
},
"defaultValue": {
"$ref": "#/$defs/TypedValue"
}
},
"required": [
"id",
"name",
"valueType"
],
"additionalProperties": false,
"title": "ParameterDefinition"
}
PlaceholderContract
| フィールド | 型/必須 | 意味/ルール |
|---|
map[key] | ScalarType | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · PlaceholderContract
{
"type": "object",
"propertyNames": {
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"additionalProperties": {
"$ref": "#/$defs/ScalarType"
},
"title": "PlaceholderContract"
}
PlaceholderDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
displayName | string · 必須 | 人が読み取れるアセットの表示名。 |
valueType | ScalarType · 必須 | 想定される値のデータ契約。使用可能なエンティティの型を含みます。 |
Schema · PlaceholderDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"displayName": {
"type": "string"
},
"valueType": {
"$ref": "#/$defs/ScalarType"
}
},
"required": [
"id",
"displayName",
"valueType"
],
"additionalProperties": false,
"title": "PlaceholderDefinition"
}
QuestObjective
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
labelTextRef | Id · 必須 | ローカライズされたラベルのテキストID。 |
descriptionTextRef | Id | 翻訳可能な説明文のテキストID。 |
Schema · QuestObjective
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"labelTextRef": {
"$ref": "#/$defs/Id"
},
"descriptionTextRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"id",
"labelTextRef"
],
"additionalProperties": false,
"title": "QuestObjective"
}
RelativePath
Schema · RelativePath
{
"type": "string",
"minLength": 1,
"maxLength": 1024,
"title": "RelativePath"
}
ResultDefinition
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
name | string · 必須 | 作成者が付けた名前。参照キーとして使用しないでください。 |
valueType | ValueType · 必須 | 想定される値のデータ契約。使用可能なエンティティの型を含みます。 |
Schema · ResultDefinition
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"name": {
"type": "string"
},
"valueType": {
"$ref": "#/$defs/ValueType"
}
},
"required": [
"id",
"name",
"valueType"
],
"additionalProperties": false,
"title": "ResultDefinition"
}
RuntimeEntry
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
flowRef | Id · 必須 | シーン/サブストーリーのID。 |
nodeRef | Id · 必須 | 次の実行可能ノードID。 |
Schema · RuntimeEntry
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"flowRef": {
"$ref": "#/$defs/Id"
},
"nodeRef": {
"$ref": "#/$defs/Id"
}
},
"required": [
"id",
"flowRef",
"nodeRef"
],
"additionalProperties": false,
"title": "RuntimeEntry"
}
RuntimeSignature
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
inputs | Array<object> · 必須 | 名前と型を持つシグネチャの入力項目。 |
outcomes | Array<object> · 必須 | コマンドが返し得る結果の名前と、そのデータ契約およびバインディング。
{"minItems":1} |
Schema · RuntimeSignature
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"inputs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"valueType": {
"$ref": "#/$defs/ValueType"
},
"defaultValue": {
"$ref": "#/$defs/TypedValue"
}
},
"required": [
"id",
"valueType"
],
"additionalProperties": false
}
},
"outcomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"valueType": {
"$ref": "#/$defs/ValueType"
}
},
"required": [
"id",
"valueType"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"results"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"id",
"inputs",
"outcomes"
],
"additionalProperties": false,
"title": "RuntimeSignature"
}
RuntimeVariable
| フィールド | 型/必須 | 意味/ルール |
|---|
id | Id · 必須 | 安定したID;表示名はキーではありません。 |
valueType | ScalarType · 必須 | 想定される値のデータ契約。使用可能なエンティティの型を含みます。 |
defaultValue | ScalarValue · 必須 | 型を持つ初期値/既定値。 |
Schema · RuntimeVariable
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/Id"
},
"valueType": {
"$ref": "#/$defs/ScalarType"
},
"defaultValue": {
"$ref": "#/$defs/ScalarValue"
}
},
"required": [
"id",
"valueType",
"defaultValue"
],
"additionalProperties": false,
"title": "RuntimeVariable"
}
RuntimeVersion
| フィールド | 型/必須 | 意味/ルール |
|---|
major | 1 · 必須 | 互換性のないメジャーバージョン。サポートされていないバージョンを拒否します。 |
minor | 1 · 必須 | メジャーバージョン内の拡張バージョン。 |
Schema · RuntimeVersion
{
"type": "object",
"properties": {
"major": {
"const": 1
},
"minor": {
"const": 1
}
},
"required": [
"major",
"minor"
],
"additionalProperties": false,
"title": "RuntimeVersion"
}
ScalarType
Schema · ScalarType
{
"type": "string",
"enum": [
"boolean",
"integer",
"string"
],
"title": "ScalarType"
}
ScalarValue
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 1].type | "boolean" · 必須 | 型を識別するフィールド。使用できる値は周囲のスキーマによって決まります。 |
[oneOf 1].value | boolean · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
[oneOf 2].type | "integer" · 必須 | 型を識別するフィールド。使用できる値は周囲のスキーマによって決まります。 |
[oneOf 2].value | integer · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。
{"minimum":-2147483648,"maximum":2147483647} |
[oneOf 3].type | "string" · 必須 | 型を識別するフィールド。使用できる値は周囲のスキーマによって決まります。 |
[oneOf 3].value | string · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
Schema · ScalarValue
{
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "boolean"
},
"value": {
"type": "boolean"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "integer"
},
"value": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "string"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
],
"title": "ScalarValue"
}
Translation
| フィールド | 型/必須 | 意味/ルール |
|---|
textRef | Id · 必須 | content.textsと、そのテキストの契約への参照。 |
locale | Locale · 必須 | この翻訳エントリのロケールコード。 |
message | メッセージ · 必須 | プレースホルダーの契約に従った翻訳文。 |
allowEmpty | boolean · 必須 | 意図的に空にした翻訳を許可します。 |
workflowStatus | "draft" | "translated" | "reviewed" · 必須 | 翻訳作業の状態。実行時の分岐ではありません。 |
basedOnSourceFingerprint | Hash · 必須 | 翻訳の基準となった原文。不一致なら原文の更新後に未確認の翻訳です。 |
reviewedContextFingerprint | Hash | レビューされた翻訳状態のコンテキストフィンガープリント。 |
origin | "ai" | 構造と有効な値は、型とスキーマを参照してください。 |
Schema · Translation
{
"type": "object",
"properties": {
"textRef": {
"$ref": "#/$defs/Id"
},
"locale": {
"$ref": "#/$defs/Locale"
},
"message": {
"$ref": "#/$defs/Message"
},
"allowEmpty": {
"type": "boolean"
},
"workflowStatus": {
"type": "string",
"enum": [
"draft",
"translated",
"reviewed"
]
},
"basedOnSourceFingerprint": {
"$ref": "#/$defs/Hash"
},
"reviewedContextFingerprint": {
"$ref": "#/$defs/Hash"
},
"origin": {
"const": "ai"
}
},
"required": [
"textRef",
"locale",
"message",
"allowEmpty",
"workflowStatus",
"basedOnSourceFingerprint"
],
"additionalProperties": false,
"title": "Translation"
}
TypedValue
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 2].type | "reference" · 必須 | 型を識別するフィールド。使用できる値は周囲のスキーマによって決まります。 |
[oneOf 2].entityType | EntityType · 必須 | エンティティ参照のカタログ種別。 |
[oneOf 2].value | Id · 必須 | リテラル値;宣言されたタイプと一致しなければなりません。 |
Schema · TypedValue
{
"oneOf": [
{
"$ref": "#/$defs/ScalarValue"
},
{
"type": "object",
"properties": {
"type": {
"const": "reference"
},
"entityType": {
"$ref": "#/$defs/EntityType"
},
"value": {
"$ref": "#/$defs/Id"
}
},
"required": [
"type",
"entityType",
"value"
],
"additionalProperties": false
}
],
"title": "TypedValue"
}
ValueType
| フィールド | 型/必須 | 意味/ルール |
|---|
[oneOf 2].kind | "reference" · 必須 | 有効なデータ形式を選ぶ識別フィールド。 |
[oneOf 2].entityType | EntityType · 必須 | エンティティ参照のカタログ種別。 |
Schema · ValueType
{
"oneOf": [
{
"$ref": "#/$defs/ScalarType"
},
{
"type": "object",
"properties": {
"kind": {
"const": "reference"
},
"entityType": {
"$ref": "#/$defs/EntityType"
}
},
"required": [
"kind",
"entityType"
],
"additionalProperties": false
}
],
"title": "ValueType"
}