*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

LuauExecutionSessionTask

Un LuauExecutionSessionTask ("tâche" pour résumer) exécute un script Luau donné dans le contexte d'une version spécifique d'un emplacement.

Dans une tâche, la simulation de physique ne s'lancerpas. Les scripts du serveur et locaux dans la zone ne s'lancerpas automatiquement non plus.

Le script peut accéder et mettre à jour le modèle de données du emplacement, y compris en invoquant tout script de module.Cependant, les modifications du modèle de données sont locales à la tâche et ne peuvent pas être persistées.

Le script peut également invoquer des API d'engine qui lisent et/ou modifient les données stockées dans le cloud, telles que celles pour les magasins de données.Exercez la prudence lors de l'utilisation de ces API.

Les scripts peuvent avoir jusqu'à 4 Mo de taille et s'exécuter pendant jusqu'à 5 minutes. Les scripts qui s'exécutent plus longtemps que la limite de temps se terminent par une erreur.

Les scripts sont exécutés tels quels et n'ont pas besoin d'être enveloppés dans une fonction.

Les scripts peuvent retourner des valeurs (en utilisant le mot-clé Luau return).Les valeurs de retour sont serialisées en JSON et peuvent être récupérées avec l'API Get LuauExecutionSessionTask après la fin de la tâche.La taille totale des valeurs de retour après la serialisation JSON ne doit pas dépasser 4 Mo.Si la limite est dépassée, la tâche se termine avec une erreur.

Si le script renvoie une erreur non gérée, la tâche se termine. Les informations sur l'erreur peuvent être récupérées avec l'API GetLuauExecutionSessionTask.

La sortie standard (générée par la fonction Luau print ) peut être récupérée avec la méthode ListLuauExecutionSessionTaskLogs après la fin de la tâche.Un maximum de 450 KB de journaux est conservé.Si la quantité de journaux dépasse la limite, les journaux plus anciens sont ignorés.

Les informations sur une tâche sont conservées pendant 24 heures après la fin de la tâche.

Au plus dix tâches incomplètes sont autorisées par emplacement. Tenter de créer plus de tâches alors que les dix premières sont incomplètes provoque une réponse HTTP 429.

  • CHEMINS POUR RESSOURCES
  • /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

Attributs

pathstring

Le chemin de ressource de la tâche d'exécution luau.

Formats :

  • 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
Sortie seule

Temps auquel cette tâche a été créée. Ce string est formatée en tant que Timestamp.

updateTimestring
Sortie seule

Temps où l'état de cette tâche a dernièrement changé. Ce string est formatée en tant que Timestamp.

userstring
Sortie seule

L'utilisateur qui a créé la clé API utilisée pour créer cette tâche.

stateEnum<string>
Sortie seule

L'état de la tâche. Voir l'ensemble d'état pour des informations sur chaque valeur possible.

Valeurs possibles :

| Valeur | Description | | --- | --- | | ÉTAT_NON_SPÉCIFIÉ | NON_SPÉCIFIÉ | | QUEUED | La tâche attend d'être traitée.| | TRAITEMENT | La tâche a été prise en charge pour le traitement.| | ANNULÉ | La tâche a été arrêtée par l'utilisateur.| | COMPLÈTE | La tâche a terminé le traitement.Le champ de sortie contient la sortie.| | ÉCHOUÉ | La tâche a échoué.Le champ d'erreur contient des détails sur l'erreur. |. Valeurs possibles :

scriptstring
Immuable

Le script à exécuter en tant que partie de cette tâche.

Par exemple :

local x = 3

local y = 4

return x + y

```.
timeoutstring
Immuable

Limite pour la durée pendant laquelle le script peut s'lancer.

La tâche échoue si le script ne se termine pas dans la durée spécifiée.

Par défaut à 5 minutes.

Un des éléments suivants pour result:

errorobject

Présent lorsque l'exécution de la tâche échoue. Contient des détails sur l'erreur qui a causé l'échec.

outputobject

Présent lorsque l'exécution de la tâche réussit. Contient la sortie de l'exécution.

URL de base
https://apis.roblox.com
La ressource 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
Bêta

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

Crée une tâche mais ne pas attendre la tâche à terminer.

Pour vérifier si une tâche est terminée, appelez la méthode GetLuauExecutionSessionTask et inspectez le champ state de la ressource retournée.

Quotes-part :

  • 5 appels par minute par propriétaire de clé API
  • 45 appels par minute par adresse IP
Périmètres d'application
universe.place.luau-execution-session:write
RequêteParamètres du chemin
universe_idstring
Requis

L'ID de l'univers.

place_idstring
Requis

L'ID du lieu.

Corps de la requêteLuauExecutionSessionTask
RéponseLuauExecutionSessionTask
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"

}'
Réponse
{

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

  }

}