*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

LuauExecutionSessionTask

Um LuauExecutionSessionTask ("tarefa" para breve) executa um script Luau dado no contexto de uma versão específica de um local.

Em uma tarefa, a simulação de física não é executar. Os scripts do servidor e locais dentro do local também não são executarautomaticamente.

O script pode acessar e atualizar o modelo de dados do local, incluindo invocar quaisquer scripts de módulo.No entanto, as alterações no modelo de dados são locais para a tarefa e não podem ser persistentes.

O script também pode invocar APIs de motor que leem e/ou modificam dados armazenados na nuvem, como as para DataStores.Exercite cuidado ao usar essas APIs.

Scripts podem ter até 4 MB de tamanho e executar por até 5 minutos. Scripts que executam por mais tempo do que o limite de tempo terminam com um erro.

Scripts são executados como estão e não precisam ser embalados em uma função.

Scripts podem retornar valores (usando a palavra-chave Luau return).Os valores de retorno são serializados para JSON e podem ser recuperados com a API Get LuauExecutionSessionTask após a conclusão da tarefa.O tamanho total dos valores de retorno após serialização JSON não deve exceder 4 MB.Se o limite for excedido, a tarefa termina com um erro.

Se o script levantar um erro não tratado, a tarefa termina. As informações de erro podem ser recuperadas com a API (Interface de Programação para Aplicações)GetLuauExecutionSessionTask.

A saída padrão (gerada pela função Luau print ) pode ser recuperada com o método ListLuauExecutionSessionTaskLogs após a conclusão da tarefa.Um máximo de 450 KB de registros é mantido.Se a quantidade de registros exceder o limite, registros mais antigos são descartados.

Informações sobre uma tarefa são mantidas por 24 horas após a conclusão da tarefa.

No máximo, dez tarefas incompletas são permitidas por local. Tentar criar mais tarefas enquanto as primeiras dez são incompletas resulta em uma resposta HTTP 429.

ENDEREÇOS DE RECURSOS
/cloud/v2/universes/{universe_id}/places/{place_id}/luau-execution-session-tasks
/cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-session-tasks
/cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks

Atributos

pathstring

O caminho de recursos da tarefa de execução do luau.

Formatos:

universes/{universe_id}/places/{place_id}/luau-execution-session-tasks/{luau_execution_session_task_id}
universes/{universe_id}/places/{place_id}/versions/{place_version_id}/luau-execution-session-tasks/{luau_execution_session_task_id}
universes/{universe_id}/places/{place_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{luau_execution_session_task_id}
universes/{universe_id}/places/{place_id}/versions/{place_version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{luau_execution_session_task_id}.

createTimestring

Apenas saída

Tempo em que essa tarefa foi criada. Esta cadeia de caracteres é formatada como um Timestamp.

updateTimestring

Apenas saída

Tempo em que o estado desta tarefa foi alterado pela última vez. Esta cadeia de caracteres é formatada como um Timestamp.

userstring

Apenas saída

O usuário que criou a chave da API que foi usada para criar esta tarefa.

stateEnum<string>

Apenas saída

O estado da tarefa. Veja o estado enum para obter informações sobre cada valor possível.

Valores possíveis:

| Valor | Descrição | | --- | --- | | ESTADO_NÃO_ESPECIFICADO | NÃO_ESPECIFICADO | | QUEUED | A tarefa está esperando para ser processada.| | PROCESSANDO | A tarefa foi selecionada para processamento.| | CANCELADO | A tarefa foi interrompida pelo usuário.| | COMPLETO | A tarefa terminou de processar.O campo de saída contém a saída.| | FALHOU | A tarefa falhou.O campo de erro contém detalhes sobre o erro. |. Valores possíveis:

scriptstring

Imutável

O script a ser executado como parte dessa tarefa.

Por exemplo:


local x = 3
local y = 4
return x + y
```.

timeoutstring

Imutável

Limite para quanto tempo o script pode executar.

A tarefa falha se o script não for concluído dentro do período especificado.

Padrão para 5 minutos.

Um dos seguintes para result:

errorobject

Presente quando a execução da tarefa falha. Contém detalhes sobre o erro que causou o fracasso.

outputobject

Presente quando a execução da tarefa for bem-sucedida. Contém a saída da execução.

URL base

https://apis.roblox.com

O recurso LuauExecutionSessionTask

{
  "path": "universes/123/places/123/luau-execution-session-tasks/123e4567-e89b-12d3-a456-426655440000",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "user": "string",
  "state": "STATE_UNSPECIFIED",
  "script": "string",
  "timeout": "3s",
  "error": {
    "code": "ERROR_CODE_UNSPECIFIED",
    "message": "string"
  }
}

LuauExecutionSessionTask

Create Luau Execution Session Task
Beta

POST /cloud/v2/universes/{universe_id}/places/{place_id}/luau-execution-session-tasks

Cria uma tarefa, mas não aguarda a conclusão da tarefa.

Para verificar se uma tarefa foi concluída, chame o método GetLuauExecutionSessionTask e inspecione o campo state da recursa retornada.

Cotações:

5 chamadas por minuto por Proprietáriode chave da API
45 chamadas por minuto por endereço IP

Escopos

universe.place.luau-execution-session:write

SolicitaçãoParâmetros de endereço

universe_idstring

Obrigatório

O ID do universo.

place_idstring

Obrigatório

O ID do local.

Requisitar corpoLuauExecutionSessionTask

RespostaLuauExecutionSessionTask

POST /cloud/v2/universes/{universe_id}/places/{place_id}/luau-execution-session-tasks

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/luau-execution-session-tasks' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  --data '{
  "script": "string",
  "timeout": "3s"
}'

Resposta

{
  "path": "universes/123/places/123/luau-execution-session-tasks/123e4567-e89b-12d3-a456-426655440000",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "user": "string",
  "state": "STATE_UNSPECIFIED",
  "script": "string",
  "timeout": "3s",
  "error": {
    "code": "ERROR_CODE_UNSPECIFIED",
    "message": "string"
  }
}

LuauExecutionSessionTask

Atributos

LuauExecutionSessionTask

Create Luau Execution Session TaskBeta

Create Luau Execution Session Task
Beta