VNLEWIKITwórz historie. Łącz światy.
Polski
Podręcznik VNLE

Opis pól JSON

Wykonanie i treść

format i containerVersion określają format kontenera. execution zawiera punkty wejścia i węzły; content — teksty, tłumaczenia i katalogi. UUID łączą tabele. Nie wyszukuj odwołań według wyświetlanych nazw. JSON nie dopuszcza komentarzy: objaśnienia są osobno, aby przykład pozostał poprawnym 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

Przełączanie języka i brakujące tłumaczenia

Przechowuj język oddzielnie od bieżącego węzła. Po zmianie ponownie odczytaj ten sam textRef: użyj tłumaczenia dla locale, jeśli istnieje, lub sourceMessage. Brak tabeli języka oznacza brak tłumaczeń. allowEmpty obsługuje celowo pusty tekst. Formatuj podstawiane wartości zgodnie z ich typami; nie wyświetlaj surowego JSON jako tekstu. Odciski źródła pozwalają wykrywać nieaktualne tłumaczenia; sam workflowStatus nie potwierdza aktualności.

Poniżej opisano wszystkie definicje dostępne w aktualnym schemacie eksportu historii: właściwości, warianty i ograniczenia. „Schema” pokazuje także reguły zagnieżdżone. Dodatkowe pola są odrzucane tam, gdzie additionalProperties ma wartość false.

JSON Schema · Draft 2020-12

Capability

PoleTyp / wymaganeZnaczenie / reguły
Schema · Capability
{
  "type": "string",
  "pattern": "^[a-z][a-z0-9.-]*$",
  "title": "Capability"
}

ContentAsset

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
mediaTypestring · wymaganeTyp MIME treści medialnej.
relativePathRelativePath · wymaganeSprawdzona względna ścieżka zasobu; przed użyciem jako ścieżki systemu plików wymaga kontroli.
contentHashHash · wymaganeSHA-256 bajtów wskazanego pliku multimedialnego.
displayNamestring · wymaganeCzytelna nazwa zasobu.
licenseNotestringInformacja o licencji zasobu; nie jest automatycznie weryfikowana prawnie.
widthintegerStrukturę i dozwolone wartości określają typ i schemat.
{"minimum":0,"maximum":2147483647}
heightintegerStrukturę i dozwolone wartości określają typ i schemat.
{"minimum":0,"maximum":2147483647}
byteSizeintegerStrukturę i dozwolone wartości określają typ i schemat.
{"minimum":0,"maximum":2147483647}
originalNamestringStrukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
nameTextRefId · wymaganeIdentyfikator tekstu dla nazwy lokalizowanej.
colorstring · wymaganeKolor wyświetlania postaci, nie wartość używana przez logikę.
{"pattern":"^#[0-9a-fA-F]{6}$"}
defaultPortraitRefIdDomyślny zasób portretu postaci; pomijany w eksporcie ogólnym.
emotionsobject · wymaganeID emocji → definicja emocji.
{"additionalProperties":{"$ref":"#/$defs/Emotion"}}
emotions[key]EmotionStrukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
categorystring · wymaganeKategoria katalogowa stosowana do organizacji definicji.
inputsArray<ParameterDefinition> · wymaganeNazwane parametry wejściowe sygnatury, z określonymi typami.
outcomesArray<OutcomeDefinition> · wymaganeNazwane możliwe wyniki polecenia oraz ich kontrakty i powiązania.
{"minItems":1}
descriptionstringOpis autora; nie jest wykonywalną instrukcją.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
nameTextRefId · wymaganeIdentyfikator tekstu dla nazwy lokalizowanej.
descriptionTextRefIdID tekstu przetłumaczonego opisu.
iconAssetRefIdID zasobu ikony katalogu.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
nameTextRefId · wymaganeIdentyfikator tekstu dla nazwy lokalizowanej.
descriptionTextRefIdID tekstu przetłumaczonego opisu.
previewAssetRefIdIdentyfikator zasobu podglądu.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
nameTextRefIdIdentyfikator tekstu dla nazwy lokalizowanej.
commandRefId · wymaganeIdentyfikator polecenia gry do wykonania.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
titleTextRefId · wymaganeID tekstu przetłumaczonego tytułu.
descriptionTextRefIdID tekstu przetłumaczonego opisu.
objectiveDefinitionsArray<QuestObjective> · wymaganeID celu zadania → definicja celu.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
keyKeyStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
categorystring · wymaganeKategoria katalogowa stosowana do organizacji definicji.
sourceMessageWiadomość · wymaganeTekst źródłowy złożony z segmentów tekstu i znaczników podstawianych wartości.
placeholdersobject · wymaganeKlucz znacznika podstawianej wartości → definicja typu i formatu.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderDefinition"}}
placeholders[key]PlaceholderDefinitionStrukturę i dozwolone wartości określają typ i schemat.
externalUseboolean · wymaganeOznacza tekst używany poza grafem węzłów.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
keyKey · wymaganeStały, czytelny klucz; odwołania techniczne nadal korzystają z ID.
valueTypeScalarType · wymaganeKontrakt oczekiwanej wartości, obejmujący możliwe typy obiektów.
defaultValueScalarValue · wymaganeWartość początkowa lub domyślna z określonym typem.
descriptionstringOpis autora; nie jest wykonywalną instrukcją.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
portraitRefIdZasób portretu dla emocji; pomijany w eksporcie ogólnym.
Schema · Emotion
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "portraitRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "additionalProperties": false,
  "title": "Emotion"
}

EntityType

PoleTyp / wymaganeZnaczenie / reguły
Schema · EntityType
{
  "type": "string",
  "enum": [
    "item",
    "quest",
    "location",
    "minigame",
    "asset"
  ],
  "title": "EntityType"
}

EntryRef

PoleTyp / wymaganeZnaczenie / reguły
flowRefId · wymaganeID sceny lub pobocznej sekwencji.
entryRefId · wymaganeID punktu wejścia w określonym przebiegu.
Schema · EntryRef
{
  "type": "object",
  "properties": {
    "flowRef": {
      "$ref": "#/$defs/Id"
    },
    "entryRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "flowRef",
    "entryRef"
  ],
  "additionalProperties": false,
  "title": "EntryRef"
}

ExecutableChoiceOption

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
textExecutableTextUse · wymaganeDla segmentów tekstowych: dosłowna treść. Dla użyć tekstu: textRef i powiązania.
conditionExecutableConditionWarunek sprawdzany przed rozgałęzieniem lub udostępnieniem opcji.
effectsArray<ExecutableEffect> · wymaganeUporządkowane zmiany stanu wykonywane przez węzeł akcji.
continuationExecutableContinuation · wymaganeKontynuacja po zakończeniu węzła.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].kind"compare" · wymaganePole rozróżniające warianty.
[oneOf 1].leftExecutableOperand · wymaganeLewy operand porównania z określonym typem.
[oneOf 1].operator"eq" | "ne" | "lt" | "lte" | "gt" | "gte" · wymaganeOperator porównania lub operator logiczny; dozwolone wartości podano w wariantach.
[oneOf 1].rightExecutableOperand · wymaganePrawy operand porównania z określonym typem.
[oneOf 2].kind"all" · wymaganePole rozróżniające warianty.
[oneOf 2].childrenArray<ExecutableCondition> · wymaganeWarunki podrzędne w wyrażeniu złożonym.
[oneOf 3].kind"any" · wymaganePole rozróżniające warianty.
[oneOf 3].childrenArray<ExecutableCondition> · wymaganeWarunki podrzędne w wyrażeniu złożonym.
[oneOf 4].kind"not" · wymaganePole rozróżniające warianty.
[oneOf 4].childExecutableCondition · wymaganeWarunek podrzędny operatora jednoargumentowego.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].kind"node" · wymaganePole rozróżniające warianty.
[oneOf 1].nodeRefId · wymaganeNastępny identyfikator węzła wykonywalnego.
[oneOf 2].kind"end" · wymaganePole rozróżniające warianty.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].kind"set" · wymaganePole rozróżniające warianty.
[oneOf 1].variableRefId · wymaganeIdentyfikator zmiennej do odczytu lub zapisu.
[oneOf 1].valueExecutableOperand · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
[oneOf 2].kind"add" · wymaganePole rozróżniające warianty.
[oneOf 2].variableRefId · wymaganeIdentyfikator zmiennej do odczytu lub zapisu.
[oneOf 2].valueExecutableOperand · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
[oneOf 3].kind"subtract" · wymaganePole rozróżniające warianty.
[oneOf 3].variableRefId · wymaganeIdentyfikator zmiennej do odczytu lub zapisu.
[oneOf 3].valueExecutableOperand · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].kind"continue" · wymaganePole rozróżniające warianty.
[oneOf 1].continuationExecutableContinuation · wymaganeKontynuacja po zakończeniu węzła.
[oneOf 2].kind"fault" · wymaganePole rozróżniające warianty.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 1].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 1].kind"dialogue" · wymaganePole rozróżniające warianty.
[oneOf 1].textExecutableTextUse · wymaganeDla segmentów tekstowych: dosłowna treść. Dla użyć tekstu: textRef i powiązania.
[oneOf 1].speakerRefIdID mówiącej postaci; brak oznacza, że nie przypisano postaci.
[oneOf 1].emotionRefIdEmocja postaci wybrana dla tego dialogu.
[oneOf 1].continuationExecutableContinuation · wymaganeKontynuacja po zakończeniu węzła.
[oneOf 2].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 2].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 2].kind"choice" · wymaganePole rozróżniające warianty.
[oneOf 2].optionOrderArray<Id> · wymaganeID opcji w kolejności wyświetlania.
[oneOf 2].optionsobject · wymaganeID opcji → opcja z tekstem, warunkiem i dalszą ścieżką.
{"additionalProperties":{"$ref":"#/$defs/ExecutableChoiceOption"}}
[oneOf 2].options[key]ExecutableChoiceOptionStrukturę i dozwolone wartości określają typ i schemat.
[oneOf 2].whenEmptyExecutableEmptyChoice · wymaganeZachowanie, gdy nie ma opcji wyboru.
[oneOf 3].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 3].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 3].kind"branch" · wymaganePole rozróżniające warianty.
[oneOf 3].conditionExecutableCondition · wymaganeWarunek sprawdzany przed rozgałęzieniem lub udostępnieniem opcji.
[oneOf 3].whenTrueExecutableContinuation · wymaganeKontynuacja, gdy warunek jest prawdziwy.
[oneOf 3].whenFalseExecutableContinuation · wymaganeDalsza ścieżka, gdy warunek jest fałszywy.
[oneOf 4].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 4].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 4].kind"action" · wymaganePole rozróżniające warianty.
[oneOf 4].effectsArray<ExecutableEffect> · wymaganeUporządkowane zmiany stanu wykonywane przez węzeł akcji.
[oneOf 4].continuationExecutableContinuation · wymaganeKontynuacja po zakończeniu węzła.
[oneOf 5].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 5].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 5].kind"command" · wymaganePole rozróżniające warianty.
[oneOf 5].commandRefId · wymaganeIdentyfikator polecenia gry do wykonania.
[oneOf 5].argumentsobject · wymaganeNazwane wartości argumentu przekazane do wywołania.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}}
[oneOf 5].arguments[key]ExecutableOperandStrukturę i dozwolone wartości określają typ i schemat.
[oneOf 5].outcomesobject · wymaganeNazwane możliwe wyniki polecenia oraz ich kontrakty i powiązania.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOutcomeBinding"}}
[oneOf 5].outcomes[key]ExecutableOutcomeBindingStrukturę i dozwolone wartości określają typ i schemat.
[oneOf 6].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 6].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 6].kind"jump" · wymaganePole rozróżniające warianty.
[oneOf 6].targetEntryRef · wymaganeOdwołanie do celu o określonym typie, np. zmiennej lub punktu wejścia; dokładną strukturę opisuje wariant.
[oneOf 7].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 7].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 7].kind"end" · wymaganePole rozróżniające warianty.
[oneOf 8].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 8].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 8].kind"call" · wymaganePole rozróżniające warianty.
[oneOf 8].targetEntryRef · wymaganeOdwołanie do celu o określonym typie, np. zmiennej lub punktu wejścia; dokładną strukturę opisuje wariant.
[oneOf 8].continuationExecutableContinuation · wymaganeKontynuacja po zakończeniu węzła.
[oneOf 9].idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
[oneOf 9].flowRefId · wymaganeID sceny lub pobocznej sekwencji.
[oneOf 9].kind"return" · wymaganePole rozróżniające warianty.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].kind"literal" · wymaganePole rozróżniające warianty.
[oneOf 1].valueTypedValue · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
[oneOf 2].kind"variable" · wymaganePole rozróżniające warianty.
[oneOf 2].variableRefId · wymaganeIdentyfikator zmiennej do odczytu lub zapisu.
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

PoleTyp / wymaganeZnaczenie / reguły
resultBindingsobject · wymaganeNazwa wyniku polecenia → zmienna docelowa dla zwróconej wartości.
{"additionalProperties":{"$ref":"#/$defs/Id"}}
resultBindings[key]IdStrukturę i dozwolone wartości określają typ i schemat.
continuationExecutableContinuation · wymaganeKontynuacja po zakończeniu węzła.
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

PoleTyp / wymaganeZnaczenie / reguły
format"vnle.story" · wymaganeDokładny identyfikator formatu dla tego kontenera danych.
containerVersion1 · wymaganeCałkowita wersja kontenera historii; obecnie 1.
storyBuildIdHash · wymaganeSHA-256 kanonicznych danych wykonania; zmiany samej treści go nie zmieniają.
executionExecutionContract · wymaganeKontrakt wykonania z określonymi typami.
contentobject · wymaganeDane językowe i katalogi oddzielone od wykonania.
{"additionalProperties":false}
content.sourceLocaleLocale · wymaganeJęzyk źródłowy tekstów, używany także przy braku tłumaczenia.
content.localesArray<Locale> · wymaganeZadeklarowane języki eksportu, w tym język źródłowy.
{"minItems":1}
content.fallbackPolicyFallbackPolicy · wymaganeObecnie source: brakujące tłumaczenia zastępuje tekst źródłowy.
content.textsobject · wymaganeID tekstu → tekst źródłowy, znaczniki podstawianych wartości i metadane.
{"additionalProperties":{"$ref":"#/$defs/ContentTextEntry"}}
content.texts[key]ContentTextEntryStrukturę i dozwolone wartości określają typ i schemat.
content.translationsobject · wymaganeKod języka → ID tekstu → tłumaczenie; brak wpisu oznacza użycie tekstu źródłowego.
{"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]objectStrukturę i dozwolone wartości określają typ i schemat.
content.charactersobject · wymaganeID postaci → postać z tłumaczonymi imionami i emocjami.
{"additionalProperties":{"$ref":"#/$defs/ContentCharacter"}}
content.characters[key]ContentCharacterStrukturę i dozwolone wartości określają typ i schemat.
content.questsobject · wymaganeID zadania → definicja zadania wraz z celami.
{"additionalProperties":{"$ref":"#/$defs/ContentQuestDefinition"}}
content.quests[key]ContentQuestDefinitionStrukturę i dozwolone wartości określają typ i schemat.
content.itemsobject · wymaganeID przedmiotu → definicja przedmiotu.
{"additionalProperties":{"$ref":"#/$defs/ContentItemDefinition"}}
content.items[key]ContentItemDefinitionStrukturę i dozwolone wartości określają typ i schemat.
content.locationsobject · wymaganeID miejsca → definicja miejsca.
{"additionalProperties":{"$ref":"#/$defs/ContentLocationDefinition"}}
content.locations[key]ContentLocationDefinitionStrukturę i dozwolone wartości określają typ i schemat.
content.minigamesobject · wymaganeID minigry → definicja; rozgrywkę implementuje gra korzystająca z eksportu.
{"additionalProperties":{"$ref":"#/$defs/ContentMinigameDefinition"}}
content.minigames[key]ContentMinigameDefinitionStrukturę i dozwolone wartości określają typ i schemat.
content.assetsobject · wymaganeID zasobu → definicja pliku multimedialnego; eksport ogólny nie dostarcza obecnie zasobów dopasowanych do konkretnego silnika.
{"additionalProperties":{"$ref":"#/$defs/ContentAsset"}}
content.assets[key]ContentAssetStrukturę i dozwolone wartości określają typ i schemat.
content.variableDefinitionsobject · wymaganeDefinicje zmiennych utworzone przez autora, z nazwami i odwołaniami do tekstów.
{"additionalProperties":{"$ref":"#/$defs/ContentVariableDefinition"}}
content.variableDefinitions[key]ContentVariableDefinitionStrukturę i dozwolone wartości określają typ i schemat.
content.commandDefinitionsobject · wymaganeDefinicje poleceń utworzone przez autora, w tym odwołania do tekstów.
{"additionalProperties":{"$ref":"#/$defs/ContentCommandDefinition"}}
content.commandDefinitions[key]ContentCommandDefinitionStrukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
textRefId · wymaganeOdwołanie do content.texts i kontraktu danego tekstu.
bindingsobject · wymaganeNazwa znacznika lub parametru → operand z określonym typem.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}}
bindings[key]ExecutableOperandStrukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
format"vnle.execution" · wymaganeDokładny identyfikator formatu dla tego kontenera danych.
contractVersionRuntimeVersion · wymaganeWersja zgodności wykonania: major i minor.
projectIdId · wymaganeStabilny identyfikator projektu źródłowego.
requiredCapabilitiesArray<Capability> · wymaganeWymagane możliwości, które pełny adapter wykonawczy musi sprawdzić przed uruchomieniem.
limitsobject · wymaganeLimity automatycznego wykonania i rekurencji.
{"additionalProperties":false}
limits.maxAutomaticTransitions1000 · wymaganeMaksymalna liczba automatycznych przejść bez działania użytkownika.
limits.maxConditionDepth32 · wymaganeMaksymalna głębokość zagnieżdżenia warunków.
limits.maxConditionTerms1024 · wymaganeMaksymalna liczba członów warunku.
limits.maxCallDepth32 · wymaganeMaksymalna głębokość zagnieżdżonych wywołań pobocznych sekwencji.
entriesobject · wymaganeID punktu wejścia → odwołanie do przebiegu i węzła.
{"additionalProperties":{"$ref":"#/$defs/RuntimeEntry"}}
entries[key]RuntimeEntryStrukturę i dozwolone wartości określają typ i schemat.
nodesobject · wymaganeID węzła → wykonywalny węzeł; kind określa jego pola.
{"additionalProperties":{"$ref":"#/$defs/ExecutableNode"}}
nodes[key]ExecutableNodeStrukturę i dozwolone wartości określają typ i schemat.
variablesobject · wymaganeID zmiennej → definicja zmiennej wykonawczej z określonym typem.
{"additionalProperties":{"$ref":"#/$defs/RuntimeVariable"}}
variables[key]RuntimeVariableStrukturę i dozwolone wartości określają typ i schemat.
commandsobject · wymaganeID polecenia → sygnatura wykonawcza z określonymi typami.
{"additionalProperties":{"$ref":"#/$defs/RuntimeSignature"}}
commands[key]RuntimeSignatureStrukturę i dozwolone wartości określają typ i schemat.
textContractsobject · wymaganeID tekstu → kontrakty podstawianych wartości wymagane przy wykonaniu.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderContract"}}
textContracts[key]PlaceholderContractStrukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
Schema · FallbackPolicy
{
  "type": "string",
  "enum": [
    "block",
    "source"
  ],
  "title": "FallbackPolicy"
}

Hash

PoleTyp / wymaganeZnaczenie / reguły
Schema · Hash
{
  "type": "string",
  "pattern": "^sha256:[0-9a-f]{64}$",
  "title": "Hash"
}

Id

PoleTyp / wymaganeZnaczenie / reguły
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

PoleTyp / wymaganeZnaczenie / reguły
Schema · Key
{
  "type": "string",
  "pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,127}$",
  "title": "Key"
}

Locale

PoleTyp / wymaganeZnaczenie / reguły
Schema · Locale
{
  "type": "string",
  "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$",
  "title": "Locale"
}

Wiadomość

PoleTyp / wymaganeZnaczenie / reguły
kind"segments" · wymaganePole rozróżniające warianty.
segmentsArray<object | object> · wymaganeUporządkowane segmenty tekstu i znaczników podstawianych wartości.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
resultsArray<ResultDefinition> · wymaganeNazwane wartości zwracane przez dany wynik, z określonymi typami.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
valueTypeValueType · wymaganeKontrakt oczekiwanej wartości, obejmujący możliwe typy obiektów.
defaultValueTypedValueWartość początkowa lub domyślna z określonym typem.
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

PoleTyp / wymaganeZnaczenie / reguły
map[key]ScalarTypeStrukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
displayNamestring · wymaganeCzytelna nazwa zasobu.
valueTypeScalarType · wymaganeKontrakt oczekiwanej wartości, obejmujący możliwe typy obiektów.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
labelTextRefId · wymaganeID tekstu przetłumaczonej etykiety.
descriptionTextRefIdID tekstu przetłumaczonego opisu.
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

PoleTyp / wymaganeZnaczenie / reguły
Schema · RelativePath
{
  "type": "string",
  "minLength": 1,
  "maxLength": 1024,
  "title": "RelativePath"
}

ResultDefinition

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
namestring · wymaganeNazwa nadana przez autora; nie używaj jej jako klucza odwołania.
valueTypeValueType · wymaganeKontrakt oczekiwanej wartości, obejmujący możliwe typy obiektów.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
flowRefId · wymaganeID sceny lub pobocznej sekwencji.
nodeRefId · wymaganeNastępny identyfikator węzła wykonywalnego.
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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
inputsArray<object> · wymaganeNazwane parametry wejściowe sygnatury, z określonymi typami.
outcomesArray<object> · wymaganeNazwane możliwe wyniki polecenia oraz ich kontrakty i powiązania.
{"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

PoleTyp / wymaganeZnaczenie / reguły
idId · wymaganeStały identyfikator; wyświetlane nazwy nie są kluczami.
valueTypeScalarType · wymaganeKontrakt oczekiwanej wartości, obejmujący możliwe typy obiektów.
defaultValueScalarValue · wymaganeWartość początkowa lub domyślna z określonym typem.
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

PoleTyp / wymaganeZnaczenie / reguły
major1 · wymaganeNiezgodna wersja główna; nieobsługiwane wersje należy odrzucić.
minor1 · wymaganeWersja rozszerzeń w obrębie wersji głównej.
Schema · RuntimeVersion
{
  "type": "object",
  "properties": {
    "major": {
      "const": 1
    },
    "minor": {
      "const": 1
    }
  },
  "required": [
    "major",
    "minor"
  ],
  "additionalProperties": false,
  "title": "RuntimeVersion"
}

ScalarType

PoleTyp / wymaganeZnaczenie / reguły
Schema · ScalarType
{
  "type": "string",
  "enum": [
    "boolean",
    "integer",
    "string"
  ],
  "title": "ScalarType"
}

ScalarValue

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 1].type"boolean" · wymaganePole rozróżniające typy; dozwolone wartości zależą od otaczającego schematu.
[oneOf 1].valueboolean · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
[oneOf 2].type"integer" · wymaganePole rozróżniające typy; dozwolone wartości zależą od otaczającego schematu.
[oneOf 2].valueinteger · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
{"minimum":-2147483648,"maximum":2147483647}
[oneOf 3].type"string" · wymaganePole rozróżniające typy; dozwolone wartości zależą od otaczającego schematu.
[oneOf 3].valuestring · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
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

PoleTyp / wymaganeZnaczenie / reguły
textRefId · wymaganeOdwołanie do content.texts i kontraktu danego tekstu.
localeLocale · wymaganeKod języka tego wpisu tłumaczenia.
messageWiadomość · wymaganePrzetłumaczony tekst zgodny z kontraktem podstawianych wartości.
allowEmptyboolean · wymaganeZezwala na celowo puste tłumaczenie.
workflowStatus"draft" | "translated" | "reviewed" · wymaganeStatus pracy nad tłumaczeniem, nie rozgałęzienie wykonania.
basedOnSourceFingerprintHash · wymaganePodstawa źródłowa tłumaczenia; niezgodność oznacza, że tłumaczenie jest nieaktualne.
reviewedContextFingerprintHashOdcisk kontekstu dla stanu sprawdzonego tłumaczenia.
origin"ai"Strukturę i dozwolone wartości określają typ i schemat.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 2].type"reference" · wymaganePole rozróżniające typy; dozwolone wartości zależą od otaczającego schematu.
[oneOf 2].entityTypeEntityType · wymaganeTyp katalogu dla odwołania do obiektu.
[oneOf 2].valueId · wymaganeWartość stała; musi odpowiadać zadeklarowanemu typowi.
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

PoleTyp / wymaganeZnaczenie / reguły
[oneOf 2].kind"reference" · wymaganePole rozróżniające warianty.
[oneOf 2].entityTypeEntityType · wymaganeTyp katalogu dla odwołania do obiektu.
Schema · ValueType
{
  "oneOf": [
    {
      "$ref": "#/$defs/ScalarType"
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "reference"
        },
        "entityType": {
          "$ref": "#/$defs/EntityType"
        }
      },
      "required": [
        "kind",
        "entityType"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ValueType"
}