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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · Capability
{
"type": "string",
"pattern": "^[a-z][a-z0-9.-]*$",
"title": "Capability"
}
ContentAsset
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
mediaType | string · obrigatório | Tipo MIME do conteúdo da mídia. |
relativePath | RelativePath · obrigatório | Caminho relativo validado do recurso; nunca o use como caminho do sistema de arquivos sem verificações. |
contentHash | Hash · obrigatório | SHA-256 dos bytes de mídia referenciados. |
displayName | string · obrigatório | Nome de exibição legível do recurso. |
licenseNote | string | Nota sobre a licença do recurso; não representa uma verificação jurídica automática. |
width | integer | Veja tipo e esquema para estrutura e valores válidos.
{"minimum":0,"maximum":2147483647} |
height | integer | Veja tipo e esquema para estrutura e valores válidos.
{"minimum":0,"maximum":2147483647} |
byteSize | integer | Veja tipo e esquema para estrutura e valores válidos.
{"minimum":0,"maximum":2147483647} |
originalName | string | Veja 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
nameTextRef | Id · obrigatório | ID de texto para o nome localizado. |
color | string · obrigatório | Cor de exibição do personagem, não um valor de lógica.
{"pattern":"^#[0-9a-fA-F]{6}$"} |
defaultPortraitRef | Id | Recurso do retrato padrão do personagem; omitido na exportação genérica. |
emotions | object · obrigatório | ID da expressão → definição da expressão.
{"additionalProperties":{"$ref":"#/$defs/Emotion"}} |
emotions[key] | Emotion | Veja 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
category | string · obrigatório | Categoria de catálogo usada para organizar a definição. |
inputs | Array<ParameterDefinition> · obrigatório | Parâmetros de entrada da assinatura, com nomes e tipos. |
outcomes | Array<OutcomeDefinition> · obrigatório | Possíveis resultados do comando, com nomes, contratos e vinculações.
{"minItems":1} |
description | string | Descriçã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
nameTextRef | Id · obrigatório | ID de texto para o nome localizado. |
descriptionTextRef | Id | ID de texto para a descrição localizada. |
iconAssetRef | Id | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
nameTextRef | Id · obrigatório | ID de texto para o nome localizado. |
descriptionTextRef | Id | ID de texto para a descrição localizada. |
previewAssetRef | Id | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
nameTextRef | Id | ID de texto para o nome localizado. |
commandRef | Id · obrigatório | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
titleTextRef | Id · obrigatório | ID de texto de um título localizado. |
descriptionTextRef | Id | ID de texto para a descrição localizada. |
objectiveDefinitions | Array<QuestObjective> · obrigatório | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
key | Key | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
category | string · obrigatório | Categoria de catálogo usada para organizar a definição. |
sourceMessage | Mensagem · obrigatório | Mensagem original formada por segmentos de texto e placeholders. |
placeholders | object · obrigatório | Chave do placeholder → definição de tipo e formato.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderDefinition"}} |
placeholders[key] | PlaceholderDefinition | Veja tipo e esquema para estrutura e valores válidos. |
externalUse | boolean · obrigatório | Marca 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
key | Key · obrigatório | Chave estável e legível; as referências técnicas continuam sendo os IDs. |
valueType | ScalarType · obrigatório | Contrato de valor esperado, incluindo possíveis tipos de entidade. |
defaultValue | ScalarValue · obrigatório | Valor inicial ou padrão, com tipo definido. |
description | string | Descriçã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
portraitRef | Id | Recurso 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · EntityType
{
"type": "string",
"enum": [
"item",
"quest",
"location",
"minigame",
"asset"
],
"title": "EntityType"
}
EntryRef
| Campo | Tipo / obrigatório | Significado / regras |
|---|
flowRef | Id · obrigatório | ID da cena ou sub-história. |
entryRef | Id · obrigatório | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
text | ExecutableTextUse · obrigatório | Para segmentos de texto: conteúdo literal. Para usos de texto: textRef e bindings. |
condition | ExecutableCondition | Condição avaliada antes de ramificar ou habilitar uma opção. |
effects | Array<ExecutableEffect> · obrigatório | Efeitos sobre o estado, aplicados em ordem pelo nó de ação. |
continuation | ExecutableContinuation · obrigatório | Continuaçã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].kind | "compare" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 1].left | ExecutableOperand · obrigatório | Operando tipado à esquerda da comparação. |
[oneOf 1].operator | "eq" | "ne" | "lt" | "lte" | "gt" | "gte" · obrigatório | Operador de comparação ou lógica; as variantes mostram os valores permitidos. |
[oneOf 1].right | ExecutableOperand · obrigatório | Operando tipado à direita da comparação. |
[oneOf 2].kind | "all" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 2].children | Array<ExecutableCondition> · obrigatório | Condições filhas de uma expressão composta. |
[oneOf 3].kind | "any" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 3].children | Array<ExecutableCondition> · obrigatório | Condições filhas de uma expressão composta. |
[oneOf 4].kind | "not" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 4].child | ExecutableCondition · obrigatório | Condiçã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].kind | "node" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 1].nodeRef | Id · obrigatório | ID do próximo nó executável. |
[oneOf 2].kind | "end" · obrigatório | Discriminador 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].kind | "set" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 1].variableRef | Id · obrigatório | ID da variável a ler ou alterar. |
[oneOf 1].value | ExecutableOperand · obrigatório | Valor literal; deve corresponder ao tipo declarado. |
[oneOf 2].kind | "add" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 2].variableRef | Id · obrigatório | ID da variável a ler ou alterar. |
[oneOf 2].value | ExecutableOperand · obrigatório | Valor literal; deve corresponder ao tipo declarado. |
[oneOf 3].kind | "subtract" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 3].variableRef | Id · obrigatório | ID da variável a ler ou alterar. |
[oneOf 3].value | ExecutableOperand · obrigatório | Valor 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].kind | "continue" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 1].continuation | ExecutableContinuation · obrigatório | Continuação após a conclusão do nó. |
[oneOf 2].kind | "fault" · obrigatório | Discriminador 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 1].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 1].kind | "dialogue" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 1].text | ExecutableTextUse · obrigatório | Para segmentos de texto: conteúdo literal. Para usos de texto: textRef e bindings. |
[oneOf 1].speakerRef | Id | ID do personagem que fala; a ausência indica que não há personagem atribuído. |
[oneOf 1].emotionRef | Id | Expressão do personagem selecionada para este diálogo. |
[oneOf 1].continuation | ExecutableContinuation · obrigatório | Continuação após a conclusão do nó. |
[oneOf 2].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 2].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 2].kind | "choice" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 2].optionOrder | Array<Id> · obrigatório | IDs das opções na ordem de apresentação. |
[oneOf 2].options | object · obrigatório | ID da opção → opção com texto, condição e continuação.
{"additionalProperties":{"$ref":"#/$defs/ExecutableChoiceOption"}} |
[oneOf 2].options[key] | ExecutableChoiceOption | Veja tipo e esquema para estrutura e valores válidos. |
[oneOf 2].whenEmpty | ExecutableEmptyChoice · obrigatório | Comportamento quando não há opção de escolha disponível. |
[oneOf 3].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 3].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 3].kind | "branch" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 3].condition | ExecutableCondition · obrigatório | Condição avaliada antes de ramificar ou habilitar uma opção. |
[oneOf 3].whenTrue | ExecutableContinuation · obrigatório | Continuação quando a condição é verdadeira. |
[oneOf 3].whenFalse | ExecutableContinuation · obrigatório | Continuação quando a condição é falsa. |
[oneOf 4].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 4].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 4].kind | "action" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 4].effects | Array<ExecutableEffect> · obrigatório | Efeitos sobre o estado, aplicados em ordem pelo nó de ação. |
[oneOf 4].continuation | ExecutableContinuation · obrigatório | Continuação após a conclusão do nó. |
[oneOf 5].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 5].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 5].kind | "command" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 5].commandRef | Id · obrigatório | ID do comando do jogo a ser executado. |
[oneOf 5].arguments | object · obrigatório | Valores dos argumentos nomeados passados à chamada.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}} |
[oneOf 5].arguments[key] | ExecutableOperand | Veja tipo e esquema para estrutura e valores válidos. |
[oneOf 5].outcomes | object · obrigatório | Possíveis resultados do comando, com nomes, contratos e vinculações.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOutcomeBinding"}} |
[oneOf 5].outcomes[key] | ExecutableOutcomeBinding | Veja tipo e esquema para estrutura e valores válidos. |
[oneOf 6].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 6].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 6].kind | "jump" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 6].target | EntryRef · obrigatório | Referência de destino tipada, como variável ou ponto de entrada; consulte a variante para ver a estrutura exata. |
[oneOf 7].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 7].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 7].kind | "end" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 8].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 8].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 8].kind | "call" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 8].target | EntryRef · obrigatório | Referência de destino tipada, como variável ou ponto de entrada; consulte a variante para ver a estrutura exata. |
[oneOf 8].continuation | ExecutableContinuation · obrigatório | Continuação após a conclusão do nó. |
[oneOf 9].id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
[oneOf 9].flowRef | Id · obrigatório | ID da cena ou sub-história. |
[oneOf 9].kind | "return" · obrigatório | Discriminador 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].kind | "literal" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 1].value | TypedValue · obrigatório | Valor literal; deve corresponder ao tipo declarado. |
[oneOf 2].kind | "variable" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 2].variableRef | Id · obrigatório | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
resultBindings | object · obrigatório | Nome do resultado do comando → variável de destino para o valor devolvido.
{"additionalProperties":{"$ref":"#/$defs/Id"}} |
resultBindings[key] | Id | Veja tipo e esquema para estrutura e valores válidos. |
continuation | ExecutableContinuation · obrigatório | Continuaçã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
format | "vnle.story" · obrigatório | Identificador exato do formato deste contêiner de dados. |
containerVersion | 1 · obrigatório | Versão inteira do contêiner da história; atualmente, 1. |
storyBuildId | Hash · obrigatório | SHA-256 dos dados de execução canônicos; alterações apenas no conteúdo não mudam esse valor. |
execution | ExecutionContract · obrigatório | Contrato de execução tipado. |
content | object · obrigatório | Dados de idioma e catálogo separados da execução.
{"additionalProperties":false} |
content.sourceLocale | Locale · obrigatório | Idioma de origem dos textos, também usado quando falta tradução. |
content.locales | Array<Locale> · obrigatório | Idiomas declarados para exportação, incluindo o idioma de origem.
{"minItems":1} |
content.fallbackPolicy | FallbackPolicy · obrigatório | Atualmente source: usa o texto original quando falta tradução. |
content.texts | object · obrigatório | ID de texto → mensagem de origem, placeholders e metadados.
{"additionalProperties":{"$ref":"#/$defs/ContentTextEntry"}} |
content.texts[key] | ContentTextEntry | Veja tipo e esquema para estrutura e valores válidos. |
content.translations | object · obrigatório | Idioma → 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] | object | Veja tipo e esquema para estrutura e valores válidos. |
content.characters | object · obrigatório | ID do personagem → personagem com nomes localizados e expressões.
{"additionalProperties":{"$ref":"#/$defs/ContentCharacter"}} |
content.characters[key] | ContentCharacter | Veja tipo e esquema para estrutura e valores válidos. |
content.quests | object · obrigatório | ID da missão → definição da missão com seus objetivos.
{"additionalProperties":{"$ref":"#/$defs/ContentQuestDefinition"}} |
content.quests[key] | ContentQuestDefinition | Veja tipo e esquema para estrutura e valores válidos. |
content.items | object · obrigatório | ID do item → definição do item.
{"additionalProperties":{"$ref":"#/$defs/ContentItemDefinition"}} |
content.items[key] | ContentItemDefinition | Veja tipo e esquema para estrutura e valores válidos. |
content.locations | object · obrigatório | ID do local → definição do local.
{"additionalProperties":{"$ref":"#/$defs/ContentLocationDefinition"}} |
content.locations[key] | ContentLocationDefinition | Veja tipo e esquema para estrutura e valores válidos. |
content.minigames | object · obrigatório | ID do minijogo → definição; o jogo que recebe os dados implementa a jogabilidade.
{"additionalProperties":{"$ref":"#/$defs/ContentMinigameDefinition"}} |
content.minigames[key] | ContentMinigameDefinition | Veja tipo e esquema para estrutura e valores válidos. |
content.assets | object · obrigatório | ID 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] | ContentAsset | Veja tipo e esquema para estrutura e valores válidos. |
content.variableDefinitions | object · obrigatório | Definições de variáveis criadas pelo autor, com nomes e referências de texto.
{"additionalProperties":{"$ref":"#/$defs/ContentVariableDefinition"}} |
content.variableDefinitions[key] | ContentVariableDefinition | Veja tipo e esquema para estrutura e valores válidos. |
content.commandDefinitions | object · obrigatório | Definições de comandos criadas pelo autor, incluindo referências de texto.
{"additionalProperties":{"$ref":"#/$defs/ContentCommandDefinition"}} |
content.commandDefinitions[key] | ContentCommandDefinition | Veja 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
textRef | Id · obrigatório | Referência a content.texts e ao seu contrato de texto. |
bindings | object · obrigatório | Nome do placeholder ou parâmetro → operando tipado.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}} |
bindings[key] | ExecutableOperand | Veja 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
format | "vnle.execution" · obrigatório | Identificador exato do formato deste contêiner de dados. |
contractVersion | RuntimeVersion · obrigatório | Versão de compatibilidade da execução: principal e secundária. |
projectId | Id · obrigatório | ID estável do projeto de origem. |
requiredCapabilities | Array<Capability> · obrigatório | Capacidades que um adaptador completo de execução deve conferir antes de iniciar. |
limits | object · obrigatório | Limites para execução automática e recursão.
{"additionalProperties":false} |
limits.maxAutomaticTransitions | 1000 · obrigatório | Número máximo de transições automáticas sem entrada do usuário. |
limits.maxConditionDepth | 32 · obrigatório | Profundidade máxima de aninhamento das condições. |
limits.maxConditionTerms | 1024 · obrigatório | Número máximo de termos de condição. |
limits.maxCallDepth | 32 · obrigatório | Profundidade máxima de chamadas aninhadas a sub-histórias. |
entries | object · obrigatório | ID de entrada → fluxo e referência de nó.
{"additionalProperties":{"$ref":"#/$defs/RuntimeEntry"}} |
entries[key] | RuntimeEntry | Veja tipo e esquema para estrutura e valores válidos. |
nodes | object · obrigatório | ID do nó → nó executável; kind determina seus campos.
{"additionalProperties":{"$ref":"#/$defs/ExecutableNode"}} |
nodes[key] | ExecutableNode | Veja tipo e esquema para estrutura e valores válidos. |
variables | object · obrigatório | ID da variável → definição tipada da variável em tempo de execução.
{"additionalProperties":{"$ref":"#/$defs/RuntimeVariable"}} |
variables[key] | RuntimeVariable | Veja tipo e esquema para estrutura e valores válidos. |
commands | object · obrigatório | ID do comando → assinatura tipada em tempo de execução.
{"additionalProperties":{"$ref":"#/$defs/RuntimeSignature"}} |
commands[key] | RuntimeSignature | Veja tipo e esquema para estrutura e valores válidos. |
textContracts | object · obrigatório | ID de texto → Contratos de placeholder exigidos pela execução.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderContract"}} |
textContracts[key] | PlaceholderContract | Veja 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · FallbackPolicy
{
"type": "string",
"enum": [
"block",
"source"
],
"title": "FallbackPolicy"
}
Hash
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · Hash
{
"type": "string",
"pattern": "^sha256:[0-9a-f]{64}$",
"title": "Hash"
}
Id
| Campo | Tipo / obrigatório | Significado / 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · Key
{
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,127}$",
"title": "Key"
}
Locale
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · Locale
{
"type": "string",
"pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$",
"title": "Locale"
}
Mensagem
| Campo | Tipo / obrigatório | Significado / regras |
|---|
kind | "segments" · obrigatório | Discriminador que seleciona a variante válida. |
segments | Array<object | object> · obrigatório | Segmentos 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
results | Array<ResultDefinition> · obrigatório | Valores 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
valueType | ValueType · obrigatório | Contrato de valor esperado, incluindo possíveis tipos de entidade. |
defaultValue | TypedValue | Valor 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
map[key] | ScalarType | Veja 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
displayName | string · obrigatório | Nome de exibição legível do recurso. |
valueType | ScalarType · obrigatório | Contrato 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
labelTextRef | Id · obrigatório | ID do texto do rótulo localizado. |
descriptionTextRef | Id | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · RelativePath
{
"type": "string",
"minLength": 1,
"maxLength": 1024,
"title": "RelativePath"
}
ResultDefinition
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
name | string · obrigatório | Nome definido pelo autor; não o use como chave de referência. |
valueType | ValueType · obrigatório | Contrato 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
flowRef | Id · obrigatório | ID da cena ou sub-história. |
nodeRef | Id · obrigatório | ID 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
inputs | Array<object> · obrigatório | Parâmetros de entrada da assinatura, com nomes e tipos. |
outcomes | Array<object> · obrigatório | Possí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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
id | Id · obrigatório | ID estável; nomes de exibição não são chaves. |
valueType | ScalarType · obrigatório | Contrato de valor esperado, incluindo possíveis tipos de entidade. |
defaultValue | ScalarValue · obrigatório | Valor 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
major | 1 · obrigatório | Versão principal incompatível; rejeite versões não suportadas. |
minor | 1 · obrigatório | Versã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
Schema · ScalarType
{
"type": "string",
"enum": [
"boolean",
"integer",
"string"
],
"title": "ScalarType"
}
ScalarValue
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 1].type | "boolean" · obrigatório | Discriminador de tipo; os valores permitidos dependem do schema em que aparece. |
[oneOf 1].value | boolean · obrigatório | Valor literal; deve corresponder ao tipo declarado. |
[oneOf 2].type | "integer" · obrigatório | Discriminador de tipo; os valores permitidos dependem do schema em que aparece. |
[oneOf 2].value | integer · obrigatório | Valor literal; deve corresponder ao tipo declarado.
{"minimum":-2147483648,"maximum":2147483647} |
[oneOf 3].type | "string" · obrigatório | Discriminador de tipo; os valores permitidos dependem do schema em que aparece. |
[oneOf 3].value | string · obrigatório | Valor 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
textRef | Id · obrigatório | Referência a content.texts e ao seu contrato de texto. |
locale | Locale · obrigatório | Código de idioma deste registro de tradução. |
message | Mensagem · obrigatório | Mensagem traduzida respeitando o contrato de placeholder. |
allowEmpty | boolean · obrigatório | Permita uma tradução intencionalmente vazia. |
workflowStatus | "draft" | "translated" | "reviewed" · obrigatório | Status do fluxo de trabalho de tradução, não um ramo em tempo de execução. |
basedOnSourceFingerprint | Hash · obrigatório | Base do texto original usada pela tradução; uma diferença indica que ela está desatualizada. |
reviewedContextFingerprint | Hash | Impressã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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 2].type | "reference" · obrigatório | Discriminador de tipo; os valores permitidos dependem do schema em que aparece. |
[oneOf 2].entityType | EntityType · obrigatório | Tipo de catálogo para uma referência de entidade. |
[oneOf 2].value | Id · obrigatório | Valor 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
| Campo | Tipo / obrigatório | Significado / regras |
|---|
[oneOf 2].kind | "reference" · obrigatório | Discriminador que seleciona a variante válida. |
[oneOf 2].entityType | EntityType · obrigatório | Tipo 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"
}