一個 **協程** 用於在同一腳本中同時執行多個任務。這些任務可能包括從輸入中產生值或在解決更大問題時對子例程進行處理。任務甚至不需要有明確的結束點，但它需要定義特定的時間來 **讓出**（暫停）以便讓其他事情得以處理。

## 使用協程

可以通過提供一個函數給 `Library.coroutine.create()` 來創建一個新的協程。一旦創建，協程不會開始運行，直到第一次調用 `Library.coroutine.resume()` 並將參數傳遞給函數。當函數停止或調用 `Library.coroutine.yield()` 時，這個調用會返回，並且在這種情況下，`Library.coroutine.resume()` 會返回函數返回的值、傳遞給 `Library.coroutine.yield()` 的值，或一條錯誤消息。如果出現錯誤，第二個返回值是拋出的錯誤。

```lua
local function task(...)
	-- 這個函數可能會工作一段時間然後讓出一些值
	coroutine.yield("first")  -- 將由 coroutine.resume() 返回
	-- 函數在再次恢復後繼續執行
	return "second"
end

local taskCoro = coroutine.create(task)
-- 第一次調用 resume，從頭開始運行函數
local success, result = coroutine.resume(taskCoro, ...)
print(success, result)  --> true, first (任務調用 coroutine.yield())
-- 繼續運行函數直到它讓出或停止
success, result = coroutine.resume(taskCoro)
print(success, result)  --> true, second (任務因返回 "second" 而停止)
```
在協程的生命週期中，您可以調用 `Library.coroutine.status()` 來檢查其狀態：

<table>
    <thead>
        <tr>
            <th>狀態</th>
            <th>含義</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td><b>暫停</b></td> <td>協程正在等待被恢復。協程在這種狀態下開始，並在其函數調用 <code>coroutine.yield()</code> 時進入此狀態。</td>
        </tr>
        <tr>
            <td><b>運行中</b></td>
            <td>協程現在正在運行。</td>
        </tr>
        <tr>
            <td><b>正常</b></td> <td>協程正在等待另一個協程的讓出；換句話說，它已經恢復了另一個協程。</td>
        </tr>
        <tr>
            <td><b>死亡</b></td> <td>函數已經停止（返回或拋出錯誤）。協程無法再使用。</td>
        </tr>
    </tbody>
</table>

### 包裝協程

在使用協程時，您也可以放棄使用協程對象，而是使用包裝函數。這樣的包裝函數在被調用時會恢復特定的協程，並且只會返回讓出的值。您可以使用 `Library.coroutine.wrap()` 來做到這一點：

```lua
-- 一個簡單的協程主體，返回一個值
local function task()
	return "done"
end

-- 創建協程並返回一個恢復它的包裝函數
local f = coroutine.wrap(task)
-- 恢復協程，就像我們調用了 coroutine.resume()
local result = f()
print(result) --> done
-- 如果發生錯誤，將在這裡引發！
-- 這與 coroutine.resume() 不同，後者的行為類似於 pcall()
```
從 `Library.coroutine.resume()` 返回的第一個值描述協程是否在沒有錯誤的情況下運行。然而，`Library.coroutine.wrap()` 返回的函數不會這樣做：相反，它們直接返回返回的值或傳遞給 `Library.coroutine.yield()` 的值（如果有）。如果在運行協程函數時發生錯誤，則在調用返回的函數時會引發錯誤。

### 生產者模式示例

想像一個任務，它生成一個單詞的重複：每次它生成一個重複，下一個將生成一個更多。例如，提供 `Hello` 將生成 `Hello`、`HelloHello`、`HelloHelloHello` 等等。為此，您可以定義 `repeatThis()`：

```lua
-- 這個函數每次其協程被恢復時重複一個單詞
local function repeatThis(word)
	local repetition = ""
	while true do
		-- 做一次重複然後讓出結果
		repetition = repetition .. word
		coroutine.yield(repetition)
	end
end
```
要將此函數作為協程運行，您可以使用 `Library.coroutine.create()`，然後多次調用 `Library.coroutine.resume()`：

```lua
local function repeatThis(word)
	local repetition = ""
	while true do
		repetition = repetition .. word
		coroutine.yield(repetition)
	end
end

local repetitionCoro = coroutine.create(repeatThis)
print(coroutine.resume(repetitionCoro, "Hello"))  -- true, Hello
print(coroutine.resume(repetitionCoro))           -- true, HelloHello
print(coroutine.resume(repetitionCoro))           -- true, HelloHelloHello
```
對於這個生產者函數，您還可以使用 `Library.coroutine.wrap()` 來獲得一個生成值的函數：

```lua
local function repeatThis(word)
	local repetition = ""
	while true do
		repetition = repetition .. word
		coroutine.yield(repetition)
	end
end

local f = coroutine.wrap(repeatThis)
print(f("Hello"))  -- Hello
print(f())         -- HelloHello
print(f())         -- HelloHelloHello
```

關閉並將提供的協同程式放入死亡狀態。此函數

返回`true`，除非協同程式處於錯誤狀態，在這種情況下，它

返回`false`和錯誤消息。當前正在運行的協同程式無法

關閉。關閉後，協同程式無法被恢復。

coroutine.close

`true`，除非關閉的協同程式處於錯誤狀態。

關閉並將提供的協同程式放入死亡狀態。

創建一個新的協程，主體為 `f`，必須是一個 Luau 函數，並
將其作為 `thread` 返回。返回的協程在 `suspended`
狀態下開始，直到調用 `Library.coroutine.resume()` 才開始執行。
傳遞給第一次 `Library.coroutine.resume()` 調用的參數將作為
`f` 的參數轉發。

coroutine.create

一個處於暫停狀態的新協程，準備被恢復。

創建一個新的協同程式，帶有主體f。f必須是一個Luau函數。

在協程 `co` 上註冊 `callback`，當 `co` 達到終止狀態時將被調用。回調函數會以狀態字符串和一組值作為參數：

- `callback("finished", ...results)`。協程函數返回。所有結果值都會轉發給回調。
- `callback("error", err)`。協程因錯誤終止。錯誤值作為唯一的附加參數傳遞。
- `callback("cancelled")`。對協程調用了 `Library.coroutine.close()` 或 `Library.task.cancel()`。協程未完成其工作。沒有提供額外的值。

回調最多運行一次，按逆註冊順序（LIFO）執行。

當協程在調用 `Library.coroutine.resume()` 或 `Library.coroutine.close()` 時達到終止狀態，這些函數將在回調完成其工作後才返回。回調在調用線程上執行，並可能會讓出控制權。如果回調出錯，則不會調用列表中的剩餘回調，並返回 `false` 狀態和回調錯誤。

嘗試在已死亡的協程上註冊回調會引發錯誤。

如果協程在通過 `Library.coroutine.wrap()` 閉包的恢復中達到終止狀態並且已註冊回調，則會引發 "無法從包裝的協程運行最終處理器" 錯誤。協程也可以在被引擎恢復或通過 `Library.task.cancel()` 關閉時達到終止狀態；在這種情況下，回調在單獨的線程上執行，錯誤報告為腳本錯誤。


coroutine.finally

callback

註冊一個回調函數，以在協程完成、出錯或關閉時調用。


如果此函數所在的協程可以安全地讓出控制權，則返回 `true`。在元方法或 C 函數內讓出協程是禁止的，`pcall` 和 `xpcall` 除外。


coroutine.isyieldable

協程在此時是否可以安全地讓出控制權。


如果此函數所在的協程可以安全地讓出控制權，則返回 `true`。


開始或繼續執行協程 `co`。第一次恢復協程時，它開始運行其主體。值 `...` 作為參數傳遞給主體函數。如果協程已經讓出，恢復將重新啟動它；值 `...` 作為從讓出中返回的結果傳遞。如果協程運行沒有任何錯誤，恢復返回 true 以及任何傳遞給讓出的值（如果協程讓出）或主體函數返回的任何值（如果協程終止）。如果有任何錯誤，恢復返回 false 以及錯誤消息。


coroutine.resume

傳遞給協程主體函數的參數（在第一次恢復時）或從協程內的 `coroutine.yield()` 返回的參數（在後續恢復時）。


`true` 如果協程運行沒有錯誤，`false` 如果發生錯誤。


成功時傳遞給 `coroutine.yield()` 的值或主體函數返回的值，或失敗時的錯誤消息。


返回當前正在運行的協程作為 `thread` 值，如果從主線程調用則返回 `nil`。主線程不被視為協程，因此只有通過 `Library.coroutine.create()` 或 `Library.coroutine.wrap()` 創建的線程會被此函數返回。


coroutine.running

當前正在運行的協程，或如果從主線程調用則為 `nil`。


返回協程 co 的狀態，作為字符串：'running'，如果協程正在運行（即，它調用了狀態）；'suspended'，如果協程在調用讓出時被暫停，或者如果它尚未開始運行；'normal' 如果協程處於活動狀態但未運行（即，它已恢復另一個協程）；以及 'dead' 如果協程已完成其主體函數，或者如果它因錯誤停止。


coroutine.status

其中之一 `"running"`，`"suspended"`，`"normal"`，或 `"dead"`。


返回協程 co 的狀態作為字符串。


創建一個新的協程，主體為 f。f 必須是一個 Luau 函數。返回一個每次調用時恢復協程的函數。傳遞給該函數的任何參數作為恢復的額外參數。返回與恢復返回的相同值，除了第一個布爾值。在出錯的情況下，傳播錯誤。


coroutine.wrap

每次調用時恢復協程的包裝函數，直接返回讓出或返回的值（不帶布爾狀態）。如果協程出錯，則引發錯誤。


創建一個新的協程並返回一個函數，當調用時，恢復該協程。


暫停調用協程的執行。任何讓出的參數作為額外結果傳遞給恢復。讓出協程在元方法或 C 函數內是禁止的，`pcall` 和 `xpcall` 除外。


coroutine.yield

從相應的 `coroutine.resume()` 調用返回的額外結果的值。


傳遞給下一個 `coroutine.resume()` 調用的參數，該調用將繼續此協程。


coroutine

一個與主執行緒並行執行的函數。

/reference/engine/libraries/coroutine.yaml

在特定事件發生時運行連接的函數的對象。

Data Type

RBXScriptSignal

Luau

Tuple

Variant

一種值為 true 或 false 的資料類型。

boolean

函數是可以在命令下多次執行的程式碼區塊。

function

一系列字元，如字母、數字和符號。

string

Library

體驗

虛擬人偶

素材

範例與專案

引擎 API

開放式雲端 API

Studio

分析

平台

教學

創作者計畫

教育

學習

此方法不同步且會傳回一個「Operation」，代表該操作的目前狀態。其中包含一個端點路徑，您可以輪詢以獲得實際回應和適用的中繼資料。詳情請參閱關於長期執行操作的[說明文件]({longRunningOperationsLink})。
            
以下部分描述操作完成時提供的回應和中繼資料物件。

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

這些開放式雲端文件頁面將於 2026 年 3 月 31 日移除。屆時，系統會自動將你重新導向至新版開放式雲端文件。{linkStart}瞭解詳情{linkEnd}

這些舊版開放式雲端頁面將於 2026 年 3 月 31 日移除，並重新導向至新頁面。{linkStart}瞭解詳情{linkEnd}

實驗端點已可供公開使用，但隨著 API 合約結束，可能會偶爾發生重大變更。

此終點可在體驗內透過 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 使用 API 金鑰呼叫。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

建立資源時可設定這些欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

舊版本驗證方法。可用時，請務必使用 API 金鑰或 OAuth 2.0。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

無需驗證即可呼叫。通常會大幅降低速率限制。可用時，請務必使用 API 金鑰或 OAuth 2.0。

對於每個群組，只需提供架構中下列任一欄位，其餘可省略。

你隨時可以重新加入。{linkStart}歡迎提供回饋。{linkEnd}

你正在檢視舊版文件。{linkStart}歡迎提供回饋。{linkEnd}

你可以隨時選擇退出，並重新導向回舊版參考頁面。{linkStart}歡迎提供任何回饋。{linkEnd}

你正在檢視新版文件。{linkStart}歡迎提供回饋。{linkEnd}

此欄位可在回應中設定，但將在請求中被忽略。

注意：在高流量期間，速率限制可能會降低。部分端點有額外的速率限制。[深入瞭解速率限制]({link})。

使用者或群組所有 API 金鑰每日 {limit} 次要求數

使用者或群組所有 API 金鑰每小時 {limit} 次要求數

使用者或群組所有 API 金鑰每分鐘 {limit} 次要求數

使用者或群組所有 API 金鑰每秒 {limit} 次要求數

每位 API 金鑰擁有者每分鐘 {limit} 次要求數

每位應用程式使用者每日 {limit} 次要求數

每位應用程式使用者每小時 {limit} 次要求數

每位應用程式使用者每分鐘 {limit} 次要求數

每位應用程式使用者每秒 {limit} 次要求數

每位 API 金鑰擁有者每秒 {limit} 次要求數

範圍控制憑證的權限。憑證只能存取你選取的範圍所支援的端點。

穩定終點已準備好投入正式環境，在其生命週期中幾乎不會發生破壞性變更。

此目標可讓你將金鑰存取權限制為所選的{requiredParts}

此目標可讓你將金鑰存取權限制為所選的{requiredParts}和{optionalParts}

目標類型是用來限制憑證對於資源的權限。即使你的帳戶擁有其他資源的權限，也只能對所選資源執行操作。某些操作範圍不包含特定目標部分。在這種情況下，所有相關資源皆可操作。

對於使用者擁有的 API 金鑰，無需選擇宇宙的頂層部分。在這種情況下，你的 API 金鑰將可存取你所擁有的使用者體驗內容，以及你具備正確群組權限的所有群組體驗內容。

「立即試試」功能尚未支援需要 API 金鑰或 OAuth 2.0 驗證的端點

為了安全起見，Cookie 驗證在高風險操作中已停用。

關鍵風險端點極為敏感，為了安全起見，已停用「立即試試」功能

注意：此程式碼範例中不包含驗證標頭資訊。你可能需要為此指令新增驗證標頭，才能正常運作。

這是一個高風險端點，用以修改或刪除關鍵資料。測試時請格外小心。

此 API 端點已被歸類為高風險，且可能會影響即時資料或使用者帳號。

對於高風險 API 的驗證請求，可能會造成無法撤銷的變更。請在繼續之前仔細檢查請求參數。

這是一個低風險端點，用以擷取資料。測試這個端點通常是安全的。

這是一個中等風險端點，用以修改資料。請謹慎地使用非關鍵帳戶測試，因為變更可能是永久性的。

為了確保帳號安全，切勿從其他來源貼上文字，或將此頁面的資訊傳送給其他人。

你即將使用實際帳號憑證來測試已發布的 API 端點。

除非你了解即將進行的 API 呼叫可能涉及的後果，方可繼續操作。在測試之前，請仔細閱讀 API 文件。

API 呼叫將透過你已驗證的工作階段進行

這些皆為實際 API 呼叫，可能會影響你的帳號或資料

部分操作可能會修改或刪除資料

此終點已被這些建議的替代終點取代：

需要以下範圍才能呼叫此端點。若要了解更多
關於產生正確金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

若要了解更多關於產生金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可為「null」、「boolean」、「string」、「number」、「array」或「object」。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看[應用程式註冊和審查]({oauth2ReferenceDocLink})。

若要了解更多關於如何註冊 OAuth 2.0 應用程式的資訊，請參閱[App 註冊與審核]({oauth2ReferenceDocLink})。

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

需要以下範圍才能呼叫此端點。

資源路徑

此字串的格式為 [Timestamp](/cloud/reference/types#timestamp)。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看 [應用程式註冊和審查]（{oauth2ReferenceDocLink}）。

不推薦

你正在檢視新版 Open Cloud 參考資料。

你已選擇退出新版 Open Cloud 參考資料。

授予設定帳務帳號和購買廣告點數的權限。

建立、更新並管理你的廣告活動。

這可以查看有關您資產的資訊。

這可以上傳和更新 Roblox 的資產。

這項操作可讓你查看主體（包括群組和體驗）的素材權限，以及帳號可存取的素材。

這會允許授予素材權限給您的帳號可存取的任何對象（包含群組和體驗）及素材。

這項操作可讓你代為檢視虛擬人偶自動設定工作的狀態和結果。

這項操作可讓你代為建立和管理虛擬人偶自動設定工作。

授予更新使用者所擁有之徽章的能力。

這會允許查看您商品的相關資訊。

這麼做可對已同步的商品進行變更。

此操作可讓你檢視商務聯絡對象的資訊。

這會允許對您的商務商家連結進行編輯。

這能讓您檢視您創作者商店商品的相關資訊。

這能讓您修改您創作者商店商品的相關資訊。

這項操作可以讓你查看創作者商店儲存項目的相關資訊。

這項操作可讓你修改創作者商店儲存項目的相關資訊。

授予代為建立資料存儲的存取權。

授予代為刪除資料存儲的權限。

授予讀取資料存儲清單的存取權。

授予為資料存儲拍攝快照的存取權。

授予在資料存儲中建立條目的存取權。

授予標記指定條目以進行刪除的存取權。

授予可列出資料存儲項目的存取權。

授予在資料存儲中讀取指定條目的存取權。

授予更新項目值、屬性和使用者的存取權。

授予可刪除資料存儲條目修訂版的存取權。

授予可列出資料存儲條目修訂版的存取權。

授予可讀取資料存儲條目修訂版的存取權。

授予檢視授權使用者開發者產品設定詳細資訊的權限。

授予編輯授權使用者開發者產品的權限。

這會允許查看您宇宙環境的相關資訊。

授予檢視授權使用者遊戲通行證設定詳細資訊的權限。

授予編輯授權使用者遊戲通行證的權限。

授予檢視帳號社群論壇資訊的權限。

授予管理帳號社群論壇資訊的權限。

這會允許查看您社群的相關資訊。

這能讓您管理自己帳號的社群加入申請和低階社群成員的角色更新。

允許你修改個體的屬性資料（目前僅支援指令碼）。

這可以查看有關您道具欄的資訊。

授予管理使用者資產的存取權。

授予管理您徽章和花費 Robux 的權限。

授予更新授權使用者徽章的權限。

授予管理您開發者產品的權限。

授予存取權限，以讀取你已開啟通知的體驗相關資訊。

授予存取權限，代你開啟或關閉體驗通知。

授予讀取與寫入您在地化表格的權限。

授予管理您擁有之所有體驗的團隊協作權限。

授予管理您的體驗及部分體驗相關資訊（例如：在地化資訊）的權限。

授予讀取您體驗之在地化資訊的權限。

授予修改您體驗在地化偏好的權限。

授予管理您使用者帳號的權限。

授予修改使用者在地化偏好的權限。

允許你檢視關聯地點的 Luau 執行任務狀態、紀錄和結果。

允許你為關聯地點建立新的 Luau 執行任務。

授予非同步清除宇宙中所有資料結構的存取權。

授予建立新佇列項目的存取權。

授予從佇列前端捨棄讀取項目的存取權。

授予從佇列前端讀取項目的權限。

授予讀取記憶存儲項目的存取權。

授予建立、更新和刪除地圖項目的存取權。

給予代替使用者發布訊息的能力。

這能讓您的體驗向使用者傳送通知。

（棄用）授予在已排序資料存儲中讀取條目清單的存取權。

（棄用）授予在已排序資料存儲中建立新條目的存取權。

授予從已排序資料存儲中列出條目的存取權。

授予在已排序資料存儲中建立條目的存取權。

此將允許列出與您的體驗相關的機密資料。

此將允許建立並更新與您的體驗相關的機密資料。

此權限可讓你提交評估工作，並檢視工作結果。

授予讀取您訂閱產品相關資訊的權限。

這項操作可讓你代為讀取縮圖資訊。

授予建立或修改分析提醒的能力。

授予寫入遊戲分析相關資源的能力。

授予發佈新版本體驗到 Roblox 的權限。

這項操作可讓你讀取體驗的縮圖和縮圖個人化設定。

這項操作可讓你上傳和刪除體驗的縮圖，並管理縮圖個人化設定。

授予編輯授權使用者體驗的權限。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

這項操作將允許檢視傳送至你帳號的通知。

授予讀取權限，查看授權使用者的高級會員與驗證狀態。

此舉可以讓你查看授權使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。

概要