VNLEWIKICrie histórias. Conecte mundos.
Português (Brasil)
Manual do VNLE

Referência dos campos JSON

Execução e conteúdo

format e containerVersion identificam o contêiner. execution contém pontos de entrada e nós; content contém textos, traduções e catálogos. UUIDs conectam as tabelas. Não faça a busca pelos nomes de exibição. JSON não permite comentários; por isso, as explicações ficam fora do código, mantendo o exemplo válido.

// 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

Troca de idioma e traduções ausentes

Guarde o idioma separadamente do nó atual. Ao trocar de idioma, resolva o mesmo textRef novamente: use a tradução para locale, se existir, ou sourceMessage. A ausência da tabela de um idioma significa que suas traduções estão ausentes. allowEmpty permite texto intencionalmente vazio. Resolva os placeholders com a formatação adequada ao tipo; não exiba o JSON convertido em string. As impressões digitais do texto original identificam traduções desatualizadas; workflowStatus, sozinho, não garante que estejam atuais.

Abaixo estão todas as definições acessíveis no schema atual de exportação da história, com suas propriedades, variantes e restrições. Schema também mostra as regras aninhadas. Campos extras são rejeitados quando additionalProperties é false.

JSON Schema · Draft 2020-12

Capability

CampoTipo / obrigatórioSignificado / regras
Schema · Capability
{
  "type": "string",
  "pattern": "^[a-z][a-z0-9.-]*$",
  "title": "Capability"
}

ContentAsset

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
mediaTypestring · obrigatórioTipo MIME do conteúdo da mídia.
relativePathRelativePath · obrigatórioCaminho relativo validado do recurso; nunca o use como caminho do sistema de arquivos sem verificações.
contentHashHash · obrigatórioSHA-256 dos bytes de mídia referenciados.
displayNamestring · obrigatórioNome de exibição legível do recurso.
licenseNotestringNota sobre a licença do recurso; não representa uma verificação jurídica automática.
widthintegerVeja tipo e esquema para estrutura e valores válidos.
{"minimum":0,"maximum":2147483647}
heightintegerVeja tipo e esquema para estrutura e valores válidos.
{"minimum":0,"maximum":2147483647}
byteSizeintegerVeja tipo e esquema para estrutura e valores válidos.
{"minimum":0,"maximum":2147483647}
originalNamestringVeja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
nameTextRefId · obrigatórioID de texto para o nome localizado.
colorstring · obrigatórioCor de exibição do personagem, não um valor de lógica.
{"pattern":"^#[0-9a-fA-F]{6}$"}
defaultPortraitRefIdRecurso do retrato padrão do personagem; omitido na exportação genérica.
emotionsobject · obrigatórioID da expressão → definição da expressão.
{"additionalProperties":{"$ref":"#/$defs/Emotion"}}
emotions[key]EmotionVeja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
categorystring · obrigatórioCategoria de catálogo usada para organizar a definição.
inputsArray<ParameterDefinition> · obrigatórioParâmetros de entrada da assinatura, com nomes e tipos.
outcomesArray<OutcomeDefinition> · obrigatórioPossíveis resultados do comando, com nomes, contratos e vinculações.
{"minItems":1}
descriptionstringDescrição escrita pelo autor; não é uma instrução executável.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
nameTextRefId · obrigatórioID de texto para o nome localizado.
descriptionTextRefIdID de texto para a descrição localizada.
iconAssetRefIdID do recurso usado como ícone no catálogo.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
nameTextRefId · obrigatórioID de texto para o nome localizado.
descriptionTextRefIdID de texto para a descrição localizada.
previewAssetRefIdID do recurso de prévia.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
nameTextRefIdID de texto para o nome localizado.
commandRefId · obrigatórioID do comando do jogo a ser executado.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
titleTextRefId · obrigatórioID de texto de um título localizado.
descriptionTextRefIdID de texto para a descrição localizada.
objectiveDefinitionsArray<QuestObjective> · obrigatórioID do objetivo da missão → definição do objetivo.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
keyKeyChave estável e legível; as referências técnicas continuam sendo os IDs.
categorystring · obrigatórioCategoria de catálogo usada para organizar a definição.
sourceMessageMensagem · obrigatórioMensagem original formada por segmentos de texto e placeholders.
placeholdersobject · obrigatórioChave do placeholder → definição de tipo e formato.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderDefinition"}}
placeholders[key]PlaceholderDefinitionVeja tipo e esquema para estrutura e valores válidos.
externalUseboolean · obrigatórioMarca textos usados fora do grafo de nós.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
keyKey · obrigatórioChave estável e legível; as referências técnicas continuam sendo os IDs.
valueTypeScalarType · obrigatórioContrato de valor esperado, incluindo possíveis tipos de entidade.
defaultValueScalarValue · obrigatórioValor inicial ou padrão, com tipo definido.
descriptionstringDescrição escrita pelo autor; não é uma instrução executável.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
portraitRefIdRecurso do retrato de uma expressão; omitido na exportação genérica.
Schema · Emotion
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "portraitRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "additionalProperties": false,
  "title": "Emotion"
}

EntityType

CampoTipo / obrigatórioSignificado / regras
Schema · EntityType
{
  "type": "string",
  "enum": [
    "item",
    "quest",
    "location",
    "minigame",
    "asset"
  ],
  "title": "EntityType"
}

EntryRef

CampoTipo / obrigatórioSignificado / regras
flowRefId · obrigatórioID da cena ou sub-história.
entryRefId · obrigatórioID de entrada dentro do fluxo especificado.
Schema · EntryRef
{
  "type": "object",
  "properties": {
    "flowRef": {
      "$ref": "#/$defs/Id"
    },
    "entryRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "flowRef",
    "entryRef"
  ],
  "additionalProperties": false,
  "title": "EntryRef"
}

ExecutableChoiceOption

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
textExecutableTextUse · obrigatórioPara segmentos de texto: conteúdo literal. Para usos de texto: textRef e bindings.
conditionExecutableConditionCondição avaliada antes de ramificar ou habilitar uma opção.
effectsArray<ExecutableEffect> · obrigatórioEfeitos sobre o estado, aplicados em ordem pelo nó de ação.
continuationExecutableContinuation · obrigatórioContinuação após a conclusão do nó.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].kind"compare" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 1].leftExecutableOperand · obrigatórioOperando tipado à esquerda da comparação.
[oneOf 1].operator"eq" | "ne" | "lt" | "lte" | "gt" | "gte" · obrigatórioOperador de comparação ou lógica; as variantes mostram os valores permitidos.
[oneOf 1].rightExecutableOperand · obrigatórioOperando tipado à direita da comparação.
[oneOf 2].kind"all" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 2].childrenArray<ExecutableCondition> · obrigatórioCondições filhas de uma expressão composta.
[oneOf 3].kind"any" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 3].childrenArray<ExecutableCondition> · obrigatórioCondições filhas de uma expressão composta.
[oneOf 4].kind"not" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 4].childExecutableCondition · obrigatórioCondição filha de um operador unário.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].kind"node" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 1].nodeRefId · obrigatórioID do próximo nó executável.
[oneOf 2].kind"end" · obrigatórioDiscriminador que seleciona a variante válida.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].kind"set" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 1].variableRefId · obrigatórioID da variável a ler ou alterar.
[oneOf 1].valueExecutableOperand · obrigatórioValor literal; deve corresponder ao tipo declarado.
[oneOf 2].kind"add" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 2].variableRefId · obrigatórioID da variável a ler ou alterar.
[oneOf 2].valueExecutableOperand · obrigatórioValor literal; deve corresponder ao tipo declarado.
[oneOf 3].kind"subtract" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 3].variableRefId · obrigatórioID da variável a ler ou alterar.
[oneOf 3].valueExecutableOperand · obrigatórioValor literal; deve corresponder ao tipo declarado.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].kind"continue" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 1].continuationExecutableContinuation · obrigatórioContinuação após a conclusão do nó.
[oneOf 2].kind"fault" · obrigatórioDiscriminador que seleciona a variante válida.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 1].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 1].kind"dialogue" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 1].textExecutableTextUse · obrigatórioPara segmentos de texto: conteúdo literal. Para usos de texto: textRef e bindings.
[oneOf 1].speakerRefIdID do personagem que fala; a ausência indica que não há personagem atribuído.
[oneOf 1].emotionRefIdExpressão do personagem selecionada para este diálogo.
[oneOf 1].continuationExecutableContinuation · obrigatórioContinuação após a conclusão do nó.
[oneOf 2].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 2].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 2].kind"choice" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 2].optionOrderArray<Id> · obrigatórioIDs das opções na ordem de apresentação.
[oneOf 2].optionsobject · obrigatórioID da opção → opção com texto, condição e continuação.
{"additionalProperties":{"$ref":"#/$defs/ExecutableChoiceOption"}}
[oneOf 2].options[key]ExecutableChoiceOptionVeja tipo e esquema para estrutura e valores válidos.
[oneOf 2].whenEmptyExecutableEmptyChoice · obrigatórioComportamento quando não há opção de escolha disponível.
[oneOf 3].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 3].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 3].kind"branch" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 3].conditionExecutableCondition · obrigatórioCondição avaliada antes de ramificar ou habilitar uma opção.
[oneOf 3].whenTrueExecutableContinuation · obrigatórioContinuação quando a condição é verdadeira.
[oneOf 3].whenFalseExecutableContinuation · obrigatórioContinuação quando a condição é falsa.
[oneOf 4].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 4].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 4].kind"action" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 4].effectsArray<ExecutableEffect> · obrigatórioEfeitos sobre o estado, aplicados em ordem pelo nó de ação.
[oneOf 4].continuationExecutableContinuation · obrigatórioContinuação após a conclusão do nó.
[oneOf 5].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 5].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 5].kind"command" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 5].commandRefId · obrigatórioID do comando do jogo a ser executado.
[oneOf 5].argumentsobject · obrigatórioValores dos argumentos nomeados passados à chamada.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}}
[oneOf 5].arguments[key]ExecutableOperandVeja tipo e esquema para estrutura e valores válidos.
[oneOf 5].outcomesobject · obrigatórioPossíveis resultados do comando, com nomes, contratos e vinculações.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOutcomeBinding"}}
[oneOf 5].outcomes[key]ExecutableOutcomeBindingVeja tipo e esquema para estrutura e valores válidos.
[oneOf 6].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 6].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 6].kind"jump" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 6].targetEntryRef · obrigatórioReferência de destino tipada, como variável ou ponto de entrada; consulte a variante para ver a estrutura exata.
[oneOf 7].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 7].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 7].kind"end" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 8].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 8].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 8].kind"call" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 8].targetEntryRef · obrigatórioReferência de destino tipada, como variável ou ponto de entrada; consulte a variante para ver a estrutura exata.
[oneOf 8].continuationExecutableContinuation · obrigatórioContinuação após a conclusão do nó.
[oneOf 9].idId · obrigatórioID estável; nomes de exibição não são chaves.
[oneOf 9].flowRefId · obrigatórioID da cena ou sub-história.
[oneOf 9].kind"return" · obrigatórioDiscriminador que seleciona a variante válida.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].kind"literal" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 1].valueTypedValue · obrigatórioValor literal; deve corresponder ao tipo declarado.
[oneOf 2].kind"variable" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 2].variableRefId · obrigatórioID da variável a ler ou alterar.
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

CampoTipo / obrigatórioSignificado / regras
resultBindingsobject · obrigatórioNome do resultado do comando → variável de destino para o valor devolvido.
{"additionalProperties":{"$ref":"#/$defs/Id"}}
resultBindings[key]IdVeja tipo e esquema para estrutura e valores válidos.
continuationExecutableContinuation · obrigatórioContinuação após a conclusão do nó.
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

CampoTipo / obrigatórioSignificado / regras
format"vnle.story" · obrigatórioIdentificador exato do formato deste contêiner de dados.
containerVersion1 · obrigatórioVersão inteira do contêiner da história; atualmente, 1.
storyBuildIdHash · obrigatórioSHA-256 dos dados de execução canônicos; alterações apenas no conteúdo não mudam esse valor.
executionExecutionContract · obrigatórioContrato de execução tipado.
contentobject · obrigatórioDados de idioma e catálogo separados da execução.
{"additionalProperties":false}
content.sourceLocaleLocale · obrigatórioIdioma de origem dos textos, também usado quando falta tradução.
content.localesArray<Locale> · obrigatórioIdiomas declarados para exportação, incluindo o idioma de origem.
{"minItems":1}
content.fallbackPolicyFallbackPolicy · obrigatórioAtualmente source: usa o texto original quando falta tradução.
content.textsobject · obrigatórioID de texto → mensagem de origem, placeholders e metadados.
{"additionalProperties":{"$ref":"#/$defs/ContentTextEntry"}}
content.texts[key]ContentTextEntryVeja tipo e esquema para estrutura e valores válidos.
content.translationsobject · obrigatórioIdioma → ID do texto → tradução; registros ausentes fazem o jogo usar o original.
{"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]objectVeja tipo e esquema para estrutura e valores válidos.
content.charactersobject · obrigatórioID do personagem → personagem com nomes localizados e expressões.
{"additionalProperties":{"$ref":"#/$defs/ContentCharacter"}}
content.characters[key]ContentCharacterVeja tipo e esquema para estrutura e valores válidos.
content.questsobject · obrigatórioID da missão → definição da missão com seus objetivos.
{"additionalProperties":{"$ref":"#/$defs/ContentQuestDefinition"}}
content.quests[key]ContentQuestDefinitionVeja tipo e esquema para estrutura e valores válidos.
content.itemsobject · obrigatórioID do item → definição do item.
{"additionalProperties":{"$ref":"#/$defs/ContentItemDefinition"}}
content.items[key]ContentItemDefinitionVeja tipo e esquema para estrutura e valores válidos.
content.locationsobject · obrigatórioID do local → definição do local.
{"additionalProperties":{"$ref":"#/$defs/ContentLocationDefinition"}}
content.locations[key]ContentLocationDefinitionVeja tipo e esquema para estrutura e valores válidos.
content.minigamesobject · obrigatórioID do minijogo → definição; o jogo que recebe os dados implementa a jogabilidade.
{"additionalProperties":{"$ref":"#/$defs/ContentMinigameDefinition"}}
content.minigames[key]ContentMinigameDefinitionVeja tipo e esquema para estrutura e valores válidos.
content.assetsobject · obrigatórioID do recurso → definição da mídia; a exportação genérica ainda não fornece recursos resolvidos para a engine.
{"additionalProperties":{"$ref":"#/$defs/ContentAsset"}}
content.assets[key]ContentAssetVeja tipo e esquema para estrutura e valores válidos.
content.variableDefinitionsobject · obrigatórioDefinições de variáveis criadas pelo autor, com nomes e referências de texto.
{"additionalProperties":{"$ref":"#/$defs/ContentVariableDefinition"}}
content.variableDefinitions[key]ContentVariableDefinitionVeja tipo e esquema para estrutura e valores válidos.
content.commandDefinitionsobject · obrigatórioDefinições de comandos criadas pelo autor, incluindo referências de texto.
{"additionalProperties":{"$ref":"#/$defs/ContentCommandDefinition"}}
content.commandDefinitions[key]ContentCommandDefinitionVeja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
textRefId · obrigatórioReferência a content.texts e ao seu contrato de texto.
bindingsobject · obrigatórioNome do placeholder ou parâmetro → operando tipado.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}}
bindings[key]ExecutableOperandVeja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
format"vnle.execution" · obrigatórioIdentificador exato do formato deste contêiner de dados.
contractVersionRuntimeVersion · obrigatórioVersão de compatibilidade da execução: principal e secundária.
projectIdId · obrigatórioID estável do projeto de origem.
requiredCapabilitiesArray<Capability> · obrigatórioCapacidades que um adaptador completo de execução deve conferir antes de iniciar.
limitsobject · obrigatórioLimites para execução automática e recursão.
{"additionalProperties":false}
limits.maxAutomaticTransitions1000 · obrigatórioNúmero máximo de transições automáticas sem entrada do usuário.
limits.maxConditionDepth32 · obrigatórioProfundidade máxima de aninhamento das condições.
limits.maxConditionTerms1024 · obrigatórioNúmero máximo de termos de condição.
limits.maxCallDepth32 · obrigatórioProfundidade máxima de chamadas aninhadas a sub-histórias.
entriesobject · obrigatórioID de entrada → fluxo e referência de nó.
{"additionalProperties":{"$ref":"#/$defs/RuntimeEntry"}}
entries[key]RuntimeEntryVeja tipo e esquema para estrutura e valores válidos.
nodesobject · obrigatórioID do nó → nó executável; kind determina seus campos.
{"additionalProperties":{"$ref":"#/$defs/ExecutableNode"}}
nodes[key]ExecutableNodeVeja tipo e esquema para estrutura e valores válidos.
variablesobject · obrigatórioID da variável → definição tipada da variável em tempo de execução.
{"additionalProperties":{"$ref":"#/$defs/RuntimeVariable"}}
variables[key]RuntimeVariableVeja tipo e esquema para estrutura e valores válidos.
commandsobject · obrigatórioID do comando → assinatura tipada em tempo de execução.
{"additionalProperties":{"$ref":"#/$defs/RuntimeSignature"}}
commands[key]RuntimeSignatureVeja tipo e esquema para estrutura e valores válidos.
textContractsobject · obrigatórioID de texto → Contratos de placeholder exigidos pela execução.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderContract"}}
textContracts[key]PlaceholderContractVeja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
Schema · FallbackPolicy
{
  "type": "string",
  "enum": [
    "block",
    "source"
  ],
  "title": "FallbackPolicy"
}

Hash

CampoTipo / obrigatórioSignificado / regras
Schema · Hash
{
  "type": "string",
  "pattern": "^sha256:[0-9a-f]{64}$",
  "title": "Hash"
}

Id

CampoTipo / obrigatórioSignificado / regras
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

CampoTipo / obrigatórioSignificado / regras
Schema · Key
{
  "type": "string",
  "pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,127}$",
  "title": "Key"
}

Locale

CampoTipo / obrigatórioSignificado / regras
Schema · Locale
{
  "type": "string",
  "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$",
  "title": "Locale"
}

Mensagem

CampoTipo / obrigatórioSignificado / regras
kind"segments" · obrigatórioDiscriminador que seleciona a variante válida.
segmentsArray<object | object> · obrigatórioSegmentos de texto e placeholders da mensagem, em ordem.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
resultsArray<ResultDefinition> · obrigatórioValores retornados por um resultado, com nomes e tipos.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
valueTypeValueType · obrigatórioContrato de valor esperado, incluindo possíveis tipos de entidade.
defaultValueTypedValueValor inicial ou padrão, com tipo definido.
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

CampoTipo / obrigatórioSignificado / regras
map[key]ScalarTypeVeja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
displayNamestring · obrigatórioNome de exibição legível do recurso.
valueTypeScalarType · obrigatórioContrato de valor esperado, incluindo possíveis tipos de entidade.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
labelTextRefId · obrigatórioID do texto do rótulo localizado.
descriptionTextRefIdID de texto para a descrição localizada.
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

CampoTipo / obrigatórioSignificado / regras
Schema · RelativePath
{
  "type": "string",
  "minLength": 1,
  "maxLength": 1024,
  "title": "RelativePath"
}

ResultDefinition

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
namestring · obrigatórioNome definido pelo autor; não o use como chave de referência.
valueTypeValueType · obrigatórioContrato de valor esperado, incluindo possíveis tipos de entidade.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
flowRefId · obrigatórioID da cena ou sub-história.
nodeRefId · obrigatórioID do próximo nó executável.
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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
inputsArray<object> · obrigatórioParâmetros de entrada da assinatura, com nomes e tipos.
outcomesArray<object> · obrigatórioPossíveis resultados do comando, com nomes, contratos e vinculações.
{"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

CampoTipo / obrigatórioSignificado / regras
idId · obrigatórioID estável; nomes de exibição não são chaves.
valueTypeScalarType · obrigatórioContrato de valor esperado, incluindo possíveis tipos de entidade.
defaultValueScalarValue · obrigatórioValor inicial ou padrão, com tipo definido.
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

CampoTipo / obrigatórioSignificado / regras
major1 · obrigatórioVersão principal incompatível; rejeite versões não suportadas.
minor1 · obrigatórioVersão de extensão dentro da versão principal.
Schema · RuntimeVersion
{
  "type": "object",
  "properties": {
    "major": {
      "const": 1
    },
    "minor": {
      "const": 1
    }
  },
  "required": [
    "major",
    "minor"
  ],
  "additionalProperties": false,
  "title": "RuntimeVersion"
}

ScalarType

CampoTipo / obrigatórioSignificado / regras
Schema · ScalarType
{
  "type": "string",
  "enum": [
    "boolean",
    "integer",
    "string"
  ],
  "title": "ScalarType"
}

ScalarValue

CampoTipo / obrigatórioSignificado / regras
[oneOf 1].type"boolean" · obrigatórioDiscriminador de tipo; os valores permitidos dependem do schema em que aparece.
[oneOf 1].valueboolean · obrigatórioValor literal; deve corresponder ao tipo declarado.
[oneOf 2].type"integer" · obrigatórioDiscriminador de tipo; os valores permitidos dependem do schema em que aparece.
[oneOf 2].valueinteger · obrigatórioValor literal; deve corresponder ao tipo declarado.
{"minimum":-2147483648,"maximum":2147483647}
[oneOf 3].type"string" · obrigatórioDiscriminador de tipo; os valores permitidos dependem do schema em que aparece.
[oneOf 3].valuestring · obrigatórioValor literal; deve corresponder ao tipo declarado.
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

CampoTipo / obrigatórioSignificado / regras
textRefId · obrigatórioReferência a content.texts e ao seu contrato de texto.
localeLocale · obrigatórioCódigo de idioma deste registro de tradução.
messageMensagem · obrigatórioMensagem traduzida respeitando o contrato de placeholder.
allowEmptyboolean · obrigatórioPermita uma tradução intencionalmente vazia.
workflowStatus"draft" | "translated" | "reviewed" · obrigatórioStatus do fluxo de trabalho de tradução, não um ramo em tempo de execução.
basedOnSourceFingerprintHash · obrigatórioBase do texto original usada pela tradução; uma diferença indica que ela está desatualizada.
reviewedContextFingerprintHashImpressão digital do contexto no estado revisado da tradução.
origin"ai"Veja tipo e esquema para estrutura e valores válidos.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 2].type"reference" · obrigatórioDiscriminador de tipo; os valores permitidos dependem do schema em que aparece.
[oneOf 2].entityTypeEntityType · obrigatórioTipo de catálogo para uma referência de entidade.
[oneOf 2].valueId · obrigatórioValor literal; deve corresponder ao tipo declarado.
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

CampoTipo / obrigatórioSignificado / regras
[oneOf 2].kind"reference" · obrigatórioDiscriminador que seleciona a variante válida.
[oneOf 2].entityTypeEntityType · obrigatórioTipo de catálogo para uma referência de entidade.
Schema · ValueType
{
  "oneOf": [
    {
      "$ref": "#/$defs/ScalarType"
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "reference"
        },
        "entityType": {
          "$ref": "#/$defs/EntityType"
        }
      },
      "required": [
        "kind",
        "entityType"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ValueType"
}