*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、 こちら をクリックしてください。

LuauExecutionSessionTask

A LuauExecutionSessionTask （「タスク」として略称）は、特定のバージョンの場プレースのコンテキストで指定された Luau スクリプトを実行します。

タスクでは、物理シミュレーションは実行しません。場所内のサーバーとローカルスクリプトも自動的に実行されません。

スクリプトは、モジュールスクリプトを呼び出して場プレースのデータモデルにアクセスし更新することができます。しかし、データモデルの変更はタスクにローカルであり、継続することはできません。

スクリプトは、データストアなどのクラウドに保存されたデータを読み込み、または変更するエンジン APIを呼び出すこともできます。これらの API を使用するときは注意を払いましょう。

スクリプトのサイズは最大 4MB、実行時間は最大 5分です。制限時間を超えて実行するスクリプトはエラーで終了します。

スクリプトはそのまま実行され、機能に包まれる必要はありません。

スクリプトは値を返すことができます (Luau return キーワードを使用)。返却値は JSON にserialize され、タスクが完了した後の Get LuauExecutionSessionTask APIで回収できます。JSON シリアル化後の返却値の総サイズは 4MB を超えてはなりません。制限を超えると、タスクはエラーで終了します。

スクリプトが未処理エラーを発生させると、タスクが終了します。エラー情報は GetLuauExecutionSessionTask API で回収できます。

標準出力 (Luau print 関数によって生成される) は、タスクが完了した後、ListLuauExecutionSessionTaskLogs メソッドで回収できます。ログの最大 450KB が保持されます。ログの量が制限を超えると、古いログが廃棄されます。

タスクの情報は、タスク完了後 24 時間保持されます。

場プレースごとに最大 10個の未完了タスクが許可されています。最初の 10個が未完了のままであると、HTTP 429 レスポンスが生成されます。

  • リソースパス
  • /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

属性

pathstring

luau 実行セッションタスクのリソースパス。

形式:

  • 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
出力のみ

このタスクが作成された時間。. この文字列は Timestamp としてフォーマットされています。

updateTimestring
出力のみ

このタスクの状態が最後に変更された時間。. この文字列は Timestamp としてフォーマットされています。

userstring
出力のみ

このタスクを作成するために使用された API キーを作成したユーザー。.

stateEnum<string>
出力のみ

タスクの状態。各可能な値に関する情報は、状態枚数を参照してください。

可能な値:

| 値 | 説明 | | --- | --- | | STATE_UNSPECIFIED | 未指定 | | QUEUED | タスクが処理を待っています。| | 処理 | タスクが処理のためにピックアップされました。| | キャンセル済み | タスクはユーザーによって停止されました。| | 完了 | タスクの処理が完了しました。出力フィールドに出力が含まれています。| | FAILED | タスクが失敗しました。エラーフィールドには、エラーに関する詳細が含まれています。|. 可能な値:

scriptstring
不変

このタスクの一部として実行するスクリプト。

例えば:

local x = 3

local y = 4

return x + y

```.
timeoutstring
不変

スクリプトが実行できる期間の制限。

スクリプトが指定された期間内に完了しない場合、タスクが失敗します。

デフォルトは 5分です。.

以下のうちの一つの result:

errorobject

タスク実行が失敗したときに表示されます。失敗の原因となったエラーの詳細を含みます。.

outputobject

タスクの実行が成功したときに表示されます。実行の出力を含みます。.

ベース URL
https://apis.roblox.com
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
ベータ版

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

タスクを作成しますが、タスクが完了するのを待たない。

タスクが完了したかどうかを確認するには、GetLuauExecutionSessionTask メソッドを呼び出して、返されたリソースの state フィールドを調べます。

クォータ:

  • API キー所有者あたり分ごとに 5 回の呼び出し
  • IP アドレスごとに分ごとに 45 回の呼び出し
範囲
universe.place.luau-execution-session:write
リクエストパスのパラメータ
universe_idstring
必須

ユニバースID。.

place_idstring
必須

プレースID。.

リクエスト本文LuauExecutionSessionTask
レスポンスLuauExecutionSessionTask
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"

}'
レスポンス
{

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

  }

}