事件序列器 | 文件 - Roblox 創作者中心

事件序列器是一個強大的框架，使您能夠在結構化的動作和觸發器序列上構建即時的跨伺服器事件和過場動畫。更具體地說，這個模組幫助您：

通過音頻、動畫和過渡的計劃配置，在結構化的框架上構建事件或過場動畫。
在多個伺服器之間轉換多個場景，將複雜的動畫和視覺效果同步到時間線。
在事件中尋找並預覽遊戲以進行測試和開發。

這個框架在 Roblox 事件中經過實戰考驗，例如 Twenty One Pilots 和 24kGoldn 音樂會，以及許多高訪問量的遊戲。

要在可編輯的地方中查看事件序列器的實際運作，請查看 Roblox Studio 中的音樂會模板。這個模板是開發者創建事件/音樂會的全面起點，並使他們熟悉各種功能和組件。

模組使用

安裝

要在遊戲中使用事件序列器框架：

從 Studio 的視窗菜單或首頁標籤工具欄中，打開工具箱並選擇創作者商店標籤。
確保選擇了模型排序，然後點擊查看所有按鈕以查看類別。
找到並點擊包磚塊。
找到事件序列器模組並點擊它，或將其拖放到 3D 視圖中。
在資源管理器窗口中，將整個事件序列器模型移動到 ServerScriptService。運行遊戲時，模組將開始運行。

框架模式

替換模式

默認的框架模式是替換模式，在此模式下，您通過將 3D 物件、地形、照明屬性、環境效果和用戶界面物件放入該場景的環境文件夾中來設計獨特的場景。當場景加載時，這些物件和屬性將分配到 Workspace、Terrain 和 Lighting，替換現有的物件/屬性以形成克隆空間。

此模式最適合由多個連續場景組成的新事件遊戲，例如從主音樂會的預演場地到演出後的派對。

行內模式

另一種框架模式是行內模式，在此模式下，您同樣設計獨特的場景，並為其流程/事件編寫腳本邏輯，但框架將不銷毀現有的 3D 物件、地形、照明屬性、環境效果和用戶界面物件，以便在加載時從場景的環境文件夾克隆資產/屬性。

此模式最適合現有遊戲，因為它保留了您地方的設計和佈局，同時讓您編排事件，例如過場動畫。

要啟用行內模式：

在您放置在 ServerScriptService 中的事件序列器模型內，深入並選擇行內值，該值位於 ReplicatedStorage 文件夾內。
在屬性窗口中，打開其值復選框。

創建場景

場景本質上是整體事件或過場動畫的一部分，包裹在一系列文件夾中。每個場景包含定義其流程/事件的腳本邏輯，並且場景可以存儲自己的 3D 物件、地形、照明屬性、環境效果和用戶界面物件。

要快速入門，您可以在模組的主文件夾中找到一個空場景：

展開事件序列器文件夾並找到空白場景文件夾。
將整個空白場景文件夾移動或複製到 ReplicatedStorage。

在開發事件時，您也可以將場景放置在資源管理器層次結構中的其他位置，並使用其屬性的標籤部分標記為 SequencerScene（空白場景已經標記為這樣）。但是，您需要將所有準備好的事件場景移動到 ReplicatedStorage，以便它們在整體事件流程中正常工作。

時間長度

每個場景應具有一個時間長度，以秒為單位，定義其持續時間 — 就像電影或音樂會有固定的持續時間一樣。時間長度定義為場景文件夾中的一個數字屬性，名為 TimeLength，您可以直接在 Studio 中設置或通過 Instance:SetAttribute() 以編程方式設置。

環境

場景的環境文件夾包含用戶看到和聽到的所有內容，包括 3D 物件、地形、照明屬性和環境效果，以及用戶界面物件。當場景加載時，這些物件和屬性將分配到 Workspace、Terrain 和 Lighting，替換現有的物件/屬性以形成克隆空間。

此文件夾不適合用於行內模式，因為該模式期望您使用現有資產和地方的全局屬性設置，而不是加載場景特定的資產/屬性。

環境文件夾包含以下容器：

容器	描述
客戶端	包含任何用戶（客戶端）加入事件時要加載的所有資產，例如用戶界面物件或動畫裝置。
玩家生成點	包含用戶加入時生成的部件。此文件夾中的任何部件行為類似於 SpawnLocation。
伺服器	包含在伺服器上首次創建場景時要加載的所有資產。建議將大多數視覺資產放在這裡。
地形	包含場景地形。
照明	包含全局照明屬性作為屬性，以及像大氣效果和後處理效果的修飾符。

事件

場景的事件文件夾純粹是 RemoteEvents 的佔位符，用於在客戶端和伺服器模組之間進行通信。將任何內容放入此文件夾並不是必需的。

客戶端

此腳本在客戶端執行架構邏輯。

伺服器

此腳本在伺服器執行架構邏輯。

場景架構

場景的架構定義了在場景時間線的什麼時候發生什麼。您應該在其客戶端和伺服器模組中定義場景的架構，並包含生命週期鉤子以管理配置何時發生。

生命週期鉤子

架構生命週期鉤子讓您管理場景操作何時發生。生產中的場景通常會在最簡單的流程中運行：

OnSetup → OnRun → OnEndScene

OnRun 可能在尋找時被中斷：

OnSetup → OnRun… 尋找 → OnRun… 尋找 → OnRun → OnEndScene

如果場景被重播，所有三個鉤子也可以重複：

OnSetup → OnRun → OnEndScene… 重播 → OnSetup → OnRun → OnEndScene

配置

架構配置定義了場景的核心操作，例如在 00:32 播放音頻、排隊一個動畫以與該音頻同步、安排場景事件例如煙火表演等等。每個配置支持某些回調函數，其中第一個參數（self）是配置實例。

您可以在客戶端和伺服器模組架構中使用配置，但建議您在客戶端執行操作，例如音頻和動畫，就像在典型遊戲中一樣。

尋找場景

事件序列器的一個獨特功能是能夠像在視頻中尋找一樣在場景中“尋找”。在替換模式中，您還可以在場景之間切換，以預覽整個多場景事件，然後再將其部署到生產環境。

場景尋找對所有人都不可訪問，因為僅僅享受事件的用戶不應該能夠控制其時間流。相反，您必須根據事件的 PlaceId 以及特定的 UserIds 和/或群組及其內部角色授予尋找權限。

在 ServerScriptService 中創建一個新的 Script。

將以下代碼粘貼到新腳本中。

腳本 - 設置尋找權限

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

EventSequencer.setSeekingPermissions({
	placeIDs = {},
	userIDs = {},
	groups = {
		{GroupID = , MinimumRankID = },
	}
})

在 setSeekingPermissions 調用中填寫以下表格：

placeIDs	以逗號分隔的 PlaceId 值列表，以支持在其中尋找。
userIDs	以逗號分隔的 UserIds 列表，這些用戶可以在支持的地方中尋找。
groups	以逗號分隔的表格列表，每個表格包含一個群組 ID 和該群組成員的最低等級，這些成員可以在支持的地方中尋找。

場景管理器插件

場景管理器插件是一個有用的工具，用於加載和卸載場景、照明和地形。除非您使用行內模式，否則強烈建議您使用此插件，而不是手動放置/編輯場景物件和屬性。

此插件不適合用於行內模式，因為該模式期望您使用現有資產和地方的全局屬性設置，而不是從場景的環境文件夾加載場景特定的資產/屬性。

要安裝插件：

從 Studio 的視窗菜單或首頁標籤工具欄中，打開工具箱。
在選擇創作者商店標籤的情況下，從下拉菜單中選擇插件。
在搜索框中輸入場景管理器並按 Enter 以查找插件。
點擊插件的圖標以查看其詳細信息，然後點擊安裝按鈕。
插件安裝後，它將出現在 Studio 的插件標籤中。

加載和卸載場景

如創建場景中所述，場景的環境文件夾包含用戶看到和聽到的所有內容，包括 3D 物件。該插件幫助您快速將場景的資產加載到工作區中的有組織的文件夾中或從中卸載。

場景必須標記為 SequencerScene，以便插件識別它們（空白場景已經標記為這樣）。如果您創建了一個場景但它未出現在插件中，請確保它已標記，然後保存並重新打開地方。

插件操作	描述
加載客戶端	如果場景的客戶端內容未加載，則將其環境/客戶端文件夾移動到工作區/場景客戶端文件夾中。
加載伺服器	如果場景的伺服器內容未加載，則將其環境/伺服器文件夾移動到工作區/場景伺服器文件夾中。
卸載客戶端	如果場景的客戶端內容已加載，則將其客戶端文件夾從工作區/場景客戶端移回 [場景]/環境文件夾。
卸載伺服器	如果場景的伺服器內容已加載，則將其伺服器文件夾從工作區/場景伺服器移回 [場景]/環境文件夾。
卸載所有場景	將每個加載的場景的客戶端和伺服器文件夾移回其環境文件夾。

保存和加載照明

頂層的 Lighting 服務存儲地方的所有照明屬性和視覺效果。由於它是頂層服務，您無法手動將其移動到特定場景的環境/伺服器或環境/客戶端文件夾中。相反，您可以利用插件將其屬性和子項複製到場景的環境/照明文件夾中。

通過頂層的 Lighting 服務配置場景的照明屬性、後處理效果、大氣效果和天空盒。
在場景管理器插件窗口中，點擊所需場景的保存照明。
選擇並展開該場景的環境/照明配置，您將看到與該文件夾的屬性相同的照明屬性，以及頂層 Lighting 服務的克隆子項。

克隆實例
保存的屬性

一旦為場景保存了照明屬性和子項，您可以通過點擊插件窗口中的加載照明快速將它們加載回頂層的 Lighting 服務。

如果您希望像 Atmosphere 這樣的環境照明效果在多場景事件的場景之間持續存在，請將其放置在頂層的 Lighting 服務中，並將其布爾屬性 SceneFrameworkIgnore 設置為 true。

該框架還將 UseCurrentLighting 屬性應用於頂層的 Lighting 服務，默認為 false。如果設置為 true，則該服務的照明會在遊戲測試期間覆蓋所有場景特定的照明 — 但是，場景照明在發佈的事件中始終優先。作為現實世界的類比，這讓您可以在演出開始之前在全光下排練音樂會，然後“關掉燈光”。

保存和加載地形

由於 Terrain 是 Workspace 中的頂層類別，您無法手動將生成或雕刻的地形移動到特定場景的環境/伺服器或環境/客戶端文件夾中。相反，您可以利用插件將其複製到場景的環境/地形文件夾中。

通過頂層地形服務配置場景的地形。
在場景管理器插件窗口中，點擊所需場景的保存地形。
選擇並展開該場景的環境/地形文件夾，您將看到一個 TerrainRegion 物件，該物件表示保存的地形。

一旦為場景保存了地形，您可以通過點擊插件窗口中的加載地形快速將其加載回頂層的 Terrain 服務。

如果場景完全沒有地形，您仍然應該點擊保存地形。這將為場景保存一個“空”地形區域，並有效地清除之前顯示的任何場景中的所有地形。

API 參考

架構生命週期鉤子

OnSetup

OnSetup 生命週期鉤子旨在初始化將在 OnRun 或 OnEndScene 中引用的資產和變數，設置連接，這些連接旨在持續整個場景的持續時間等。此鉤子接收 timePositionObject 參數，讓您在設置時讀取當前時間。

建議您在 OnSetup 中不調用 wait() 或 task.wait()，因為這會延遲 OnRun 的開始，而場景的計時器繼續計數。

客戶端架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

local clientEnvironment
local serverEnvironment
local dummy

Schema.OnSetup = function(timePositionObject)
	print("OnSetup (客戶端)")

	-- 訪問場景環境；不適用於行內模式
	clientEnvironment = EventSequencer.getCurrentSceneEnvironment()
	serverEnvironment = EventSequencer.getCurrentServerEnvironmentFromClient()
	-- 等待資產
	dummy = clientEnvironment:WaitForChild("Dummy")

	print("當前時間是:", timePositionObject.Value)
end

伺服器架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

local serverEnvironment
local partColorConnection
local changePartColorEvent = script.Parent.Events.ChangePartColor

Schema.OnSetup = function(timePositionObject)
	print("OnSetup (伺服器)")

	-- 訪問場景環境；不適用於行內模式
	serverEnvironment = EventSequencer.getCurrentSceneEnvironment()
	partColorConnection = changePartColorEvent.OnServerEvent:Connect(function(player, changedPart, newColor)
		serverEnvironment.changedPart.Color = newColor
	end)

	print("當前時間是:", timePositionObject.Value)
end

OnRun

OnRun 是架構中的主要操作生命週期鉤子。它應包含場景的所有定時配置，從播放音頻或動畫到安排事件例如煙火表演。

建議您在 OnRun 中不調用 wait() 或 task.wait()，因為這會延遲場景的編排，而場景的計時器繼續計數。

客戶端架構

Schema.OnRun = function()
	print("OnRun (客戶端)")

	local MainAudio = Schema:audio({
		StartTime = 1,
		SoundId = "rbxassetid://1838673350",
		OnStart = function(self)
			print("音頻播放中")
		end,
		OnEnd = function(self)
			print("音頻結束")
		end
	})
end

OnEndScene

OnEndScene 生命週期鉤子對於清理場景中任何未完成的內容非常有用，例如斷開在 OnSetup 或 OnRun 中創建的連接，這些連接在場景的持續時間內保持。

伺服器架構

Schema.OnEndScene = function()
	print("OnEndScene (伺服器)")

	if partColorConnection then
		partColorConnection:Disconnect()
		partColorConnection = nil
	end
end

在像演出後的場地這樣可能被視為“無限”的情況下，省略 OnEndScene 生命週期事件，並將 TimeLength 值設置為足夠長，以容納所有架構配置。此外，請不要通知任何事情給架構，因為這些事情將在場景達到其時間長度時被清理。

架構配置

audio

在工作區中創建一個 Sound 物件，該物件在特定時間播放。然後在場景結束後或 Sound 物件播放完成後刪除該音頻。

配置鍵	描述
StartTime	在場景持續時間內播放音頻的時間，以秒為單位。
SoundId	要播放的音頻的資產 ID。
OnStart	音頻開始播放時觸發的自定義函數。
OnEnd	音頻播放結束時觸發的自定義函數。
Volume	Sound 物件的音量；默認為 0.5。

客戶端架構

Schema.OnRun = function()
	print("OnRun (客戶端)")

	local MainAudio = Schema:audio({
		StartTime = 1,
		SoundId = "rbxassetid://1838673350",
		OnStart = function(self)
			print("音頻播放中")
		end,
		OnEnd = function(self)
			print("音頻結束")
		end
	})
end

您可以訪問 [audio].CurrentSoundIntensityRatio 作為音頻配置的音量強度比，用於您的間隔。這就像是根據音頻的音量強度來計算的歌曲的脈衝/節拍。

animate

創建一個在特定時間播放的 Animation。

配置鍵	描述
StartTime	在場景持續時間內播放動畫的時間，以秒為單位。
EndTime	可選的時間，在場景持續時間內結束動畫，以秒為單位。
Rig	播放動畫的動畫裝置。
AnimationId	要播放的動畫的資產 ID。
Speed	動畫的播放速度；默認為 1。
FadeInTime	動畫淡入的時間，以秒為單位；默認為 0.2（秒）。
FadeOutTime	動畫淡出的時間，以秒為單位；默認為 0.2（秒）。
OnStart	動畫開始播放時觸發的自定義函數。
OnEnd	動畫播放結束時觸發的自定義函數。
Looped	是否循環播放動畫；默認為 false。
SyncToAudio	定義是否將動畫與音頻配置同步的表格。接受以下鍵： Audio – 參考一個音頻配置。 StartAtAudioTime – 在音頻持續時間內播放動畫的時間。 EndAtAudioTime – 可選的時間，在音頻持續時間內結束動畫。

客戶端架構

Schema.OnRun = function()
	print("OnRun (客戶端)")

	local MainAudio = Schema:audio({
		StartTime = 1,
		SoundId = "rbxassetid://1838673350",
	})

	local DanceAnimation = Schema:animate({
		AnimationId = "rbxassetid://3695333486",
		Rig = Dummy,
		Speed = 1,
		FadeInTime = 0.1,
		FadeOutTime = 0.3,
		SyncToAudio = {
			Audio = MainAudio,
			StartAtAudioTime = 5,
		},
		OnStart = function(self)
			print("動畫播放中")
		end,
		OnEnd = function(self)
			print("動畫停止")
		end
	})
end

tween

創建一個可配置的 Tween，該 Tween 在尋找和動態加入時被保留，這意味著您可以在不同的時間點鏈接過渡，並且一切應該按預期播放和同步。

配置鍵	描述
StartTimes	與場景持續時間相關的開始時間表，以秒為單位。
Tween	定義要過渡的物件和屬性的表格。接受以下鍵： Object – 要過渡的物件。 Info – TweenInfo 實例，用於過渡，定義其持續時間、Enum.EasingStyle、Enum.EasingDirection 等。 Properties – 物件屬性和目標值的關聯。
OnStart	過渡開始播放時觸發的自定義函數。
OnHeartbeat	在每個 Heartbeat 上觸發的自定義函數；接收過渡 alpha 作為第二個參數。
OnEnd	過渡播放結束時觸發的自定義函數。
SyncToAudio	定義是否將過渡與音頻配置同步的表格。接受以下鍵： Audio – 參考一個音頻配置。 StartAtAudioTimes – 定義在音頻持續時間內何時播放過渡的開始時間表。

客戶端架構

Schema.OnRun = function()
	print("OnRun (客戶端)")

	local MainAudio = Schema:audio({
		StartTime = 1,
		SoundId = "rbxassetid://1838673350",
	})

	local LightFadeOut = Schema:tween({
		StartTimes = {29.884},
		Tween = {
			Object = game:GetService("Lighting"),
			Info = TweenInfo.new(2, Enum.EasingStyle.Sine, Enum.EasingDirection.Out),
			Properties = {
				Brightness = 0,
			}
		},
		SyncToAudio = {
			Audio = MainAudio,
			StartAtAudioTimes = {5, 7.2, 9.4, 11.6},
		},
		OnStart = function(self)
			print("過渡播放中")
		end,
		OnHeartbeat = function(self, alpha)
			print("過渡 alpha", alpha)
		end,
		OnEnd = function(self)
			print("過渡完成")
		end,
	})
end

interval

在指定的持續時間內以指定的頻率（以秒為單位）執行自定義回調函數。對於重複事件（例如閃爍燈光、脈衝音頻強度等）非常有用。最低頻率為 0 秒，但技術上最低頻率始終限制為 Heartbeat。

配置鍵	描述
StartTime	在場景持續時間內的間隔持續時間開始時間，以秒為單位。
EndTime	在場景持續時間內的間隔持續時間結束時間，以秒為單位。
Frequency	OnInterval 函數應該觸發的頻率，以秒為單位，第一次執行在 StartTime。
OnStart	一系列間隔開始時觸發的自定義函數。
OnInterval	在指定的持續時間內（StartTime 到 EndTime）的每個間隔內觸發的自定義函數。
OnEnd	一系列間隔結束時觸發的自定義函數。
SyncToAudio	定義是否將間隔持續時間與音頻配置同步的表格。接受以下鍵： Audio – 參考一個音頻配置。 StartAtAudioTime – 在音頻持續時間內何時開始間隔持續時間。 EndAtAudioTime – 可選的時間，在音頻持續時間內結束間隔持續時間。

客戶端架構

Schema.OnRun = function()
	print("OnRun (客戶端)")

	local MainAudio = Schema:audio({
		StartTime = 1,
		SoundId = "rbxassetid://1838673350",
	})

	local ClientTimerUpdate = Schema:interval({
		Frequency = 1,
		SyncToAudio = {
			StartAtAudioTime = 2.5,
			EndAtAudioTime = 10,
			Audio = MainAudio
		},
		OnInterval = function(self)
			print(MainAudio.Sound.TimePosition, MainAudio.CurrentSoundIntensityRatio)
		end,
	})
end

schedule

類似於 interval，但您可以為同一事件定義多個特定的開始時間，例如在場景中安排兩次煙火表演。

配置鍵	描述
StartTimes	與場景持續時間相關的開始時間表，以秒為單位。
OnStart	在 StartTimes 表中每個指定時間觸發的自定義函數。
Skippable	布爾值，定義是否可以跳過已安排的事件，對於晚加入的用戶或在已安排的開始時間之前尋找的用戶。如果設置為 false，則所有在加入/尋找時間之前安排的事件開始時間將在該加入/尋找時間發生。如果設置為 true，則僅在加入/尋找之後安排的開始時間將發生。默認為 false。
SyncToAudio	定義是否將計劃與音頻配置同步的表格。接受以下鍵： Audio – 參考一個音頻配置。 StartAtAudioTimes – 定義在音頻持續時間內何時觸發 OnStart 函數的開始時間表。

客戶端架構

Schema.OnRun = function()
	print("OnRun (客戶端)")

	Schema:schedule({
		StartTimes = {5, 27.25},
		OnStart = function(self)
			-- 初始化臨時心跳連接
			local tempConnection = RunService.Heartbeat:Connect(function()

			end)
			-- 通知框架連接
			Schema:inform(tempConnection)
		end
	})
end

inform

通知框架任何在 OnRun 生命週期鉤子中創建的模組、UI 物件、連接等，確保它們在尋找時正確清理。用例包括：

通知框架臨時的臨時連接，例如 RunService.Heartbeat，以便在尋找早期場景的時候清理該連接。

伺服器架構

Schema.OnRun = function()
	print("OnRun (伺服器)")

	Schema:schedule({
		StartTimes = {5},
		OnStart = function(self)
			-- 初始化臨時心跳連接
			local tempConnection = RunService.Heartbeat:Connect(function()

			end)
			-- 通知框架連接
			Schema:inform(tempConnection)
		end
	})
end

在 OnRun 生命週期鉤子中初始化連接或其他引用的 ModuleScript 中調用自定義“清理”函數。

伺服器架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local RunService = game:GetService("RunService")

local customModule = require(ReplicatedStorage:WaitForChild("CustomModule"))

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

Schema.OnRun = function()
	print("OnRun (伺服器)")

	Schema:schedule({
		StartTimes = {5},
		OnStart = function(self)
			-- 調用自定義模組中的“init”函數
			customModule.init()
			-- 在場景清理時調用自定義模組中的“clean”函數
			Schema:inform(customModule, customModule.clean)
		end,
	})
end

ModuleScript - CustomModule

local RunService = game:GetService("RunService")

local CustomModule = {}

CustomModule.init = function()
	-- 初始化心跳連接
	CustomModule.connection = RunService.Heartbeat:Connect(function()

	end)
end

CustomModule.clean = function()
	-- 斷開並清除心跳連接
	if CustomModule.connection then
		CustomModule.connection:Disconnect()
		CustomModule.connection = nil
	end
end

return CustomModule

雖然 inform 對於尋找支持至關重要，但您應該僅在 OnRun 生命週期鉤子中創建/初始化的任何模組、UI 物件、連接等通知框架。如果您希望在整個場景中引用某些內容，只需在 OnSetup 中初始化它，並在 OnEndScene 中清理它。

函數

loadScene

loadScene(sceneName: string, startTime: number ?)

通過 sceneName 程序性地加載場景，並從其開始的 startTime 開始。場景將有 5 秒的“寬限期”從伺服器加載，然後再進行尋找並開始播放場景。這意味著如果您在 4:15:00 PM 精確調用 loadScene("[SceneName]", 20)，則框架將在請求的 20 秒之外再等待 5 秒，於是場景將在 4:15:25 PM 開始。

腳本

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

-- 當當前場景結束時，找出下一個要加載的場景
EventSequencer.onOrchestrationFinished:Connect(function(endedSceneName)
	if endedSceneName == "PreShow" then
		-- "PreShow" 結束；加載音樂會中的第一個場景
		EventSequencer.loadScene("Track1")
	elseif endedSceneName == "Track1" then
		-- "Track1" 結束；加載音樂會中的第二個場景
		EventSequencer.loadScene("Track2")
	else
		-- 循環回預演場景
		EventSequencer.loadScene("PreShow")
	end
end)

請勿在架構生命週期鉤子中調用 loadScene，因為事件序列器期望場景過渡和多場景事件的整體序列在單獨的場景之外處理。

createSchema

createSchema(): table

返回場景架構的實例，以創建場景的邏輯。

客戶端架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

Schema.OnSetup = function(timePositionObject)
	print("OnSetup (客戶端)")
end

seek

seek(time: number)

從當前加載的場景的開始尋找 time 值，以秒為單位。

腳本

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

EventSequencer.seek(95.58)

請勿在架構生命週期鉤子中調用 seek，因為事件序列器期望場景尋找和加載在單獨的場景之外處理。

setSceneWarningTime

setSceneWarningTime(endSceneTimeWindow: number)

設置從所有場景結束的時間，發送警告的時間。您可以通過 onSceneEndingWarningForClient 或 onSceneEndingWarningForServer 在客戶端或伺服器端檢測到警告。

腳本

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

-- 加載場景
EventSequencer.loadScene("BeautifulScene")

-- 將警告時間設置為場景結束前 5 秒
EventSequencer.setSceneWarningTime(5)

-- 檢測場景即將結束時
EventSequencer.onSceneEndingWarningForServer:Connect(function()
	warn("場景即將結束！")
end)

setSeekingPermissions

setSeekingPermissions(permissions: table)

根據事件的 PlaceId 以及特定的 UserIds 和/或群組及其內部角色授予尋找權限。請參見尋找和切換場景以獲取更多信息。

getCurrentSceneEnvironment

getCurrentSceneEnvironment(): Folder (YIELDS)

根據從客戶端架構腳本或伺服器架構腳本調用的情況，返回當前場景的客戶端或伺服器端環境文件夾。

請勿在行內模式中使用此函數，因為該模式期望您使用現有資產和地方的全局屬性設置，而不是從場景的環境文件夾加載場景特定的資產/屬性。此函數將無限等待如果文件夾不存在。

客戶端架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

local clientEnvironment
local serverEnvironment

Schema.OnSetup = function(timePositionObject)
	print("OnSetup (客戶端)")

	-- 訪問場景環境；不適用於行內模式
	clientEnvironment = EventSequencer.getCurrentSceneEnvironment()
	serverEnvironment = EventSequencer.getCurrentServerEnvironmentFromClient()

	print("當前時間是:", timePositionObject.Value)
end

伺服器架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

local serverEnvironment
local partColorConnection
local changePartColorEvent = script.Parent.Events.ChangePartColor

Schema.OnSetup = function(timePositionObject)
	print("OnSetup (伺服器)")

	serverEnvironment = EventSequencer.getCurrentSceneEnvironment()

	partColorConnection = changePartColorEvent.OnServerEvent:Connect(function(player, changedPart, newColor)
		serverEnvironment.changedPart.Color = newColor
	end)
end

getCurrentServerEnvironmentFromClient

getCurrentServerEnvironmentFromClient(): Folder (YIELDS)

返回當前場景的伺服器端環境文件夾。與 getCurrentSceneEnvironment 不同，您可以從客戶端架構腳本調用此函數。

客戶端架構

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

local Schema = EventSequencer.createSchema()

local clientEnvironment
local serverEnvironment

Schema.OnSetup = function(timePositionObject)
	print("OnSetup (客戶端)")

	-- 訪問場景環境；不適用於行內模式
	clientEnvironment = EventSequencer.getCurrentSceneEnvironment()
	serverEnvironment = EventSequencer.getCurrentServerEnvironmentFromClient()

	print("當前時間是:", timePositionObject.Value)
end

isLoadingScene

isLoadingScene(): boolean

從伺服器調用以知道場景是否正在加載。

請勿在行內模式中使用此函數，因為該模式期望您使用現有資產和地方的全局屬性設置，而不是從場景的環境文件夾加載場景特定的資產/屬性。

腳本

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

print(EventSequencer.isLoadingScene())

while EventSequencer.isLoadingScene() do
	task.wait()
end
print("場景已加載")

事件

onSceneEndingWarningForClient

在場景即將結束之前在客戶端觸發。默認時間為 3 秒，但您可以通過 setSceneWarningTime 進行配置。此事件只能在 LocalScript 中連接。

LocalScript

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

-- 檢測場景即將結束（客戶端）
EventSequencer.onSceneEndingWarningForClient:Connect(function()
	warn("場景即將結束！")
end)

onSceneEndingWarningForServer

在場景即將結束之前在伺服器觸發。默認時間為 3 秒，但您可以通過 setSceneWarningTime 進行配置。此事件只能在 Script 中連接。

腳本

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

-- 檢測場景即將結束（伺服器）
EventSequencer.onSceneEndingWarningForServer:Connect(function()
	warn("場景即將結束！")
end)

onSceneLoadedForClient

在場景開始時在客戶端觸發。此事件只能在 LocalScript 中連接。

不要在行內模式中使用此事件，因為該模式期望您使用現有資產和地方的全局屬性設置，而不是從場景的環境文件夾加載場景特定的資產/屬性。

LocalScript

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

-- 檢測場景開始（客戶端）
EventSequencer.onSceneLoadedForClient:Connect(function()
	warn("場景正在開始！")
end)

onOrchestrationFinished

在場景達到其時間長度並有效結束時在伺服器觸發。此事件接收一個 endedSceneName 字符串名稱參數，表示剛剛結束的場景，您可以根據此事件有條件地加載另一個場景。只能在 Script 中連接。

腳本

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local EventSequencer = require(ReplicatedStorage:WaitForChild("EventSequencer"))

-- 當當前場景結束時，找出下一個要加載的場景
EventSequencer.onOrchestrationFinished:Connect(function(endedSceneName)
	if endedSceneName == "PreShow" then
		-- "PreShow" 結束；加載音樂會中的第一個場景
		EventSequencer.loadScene("Track1")
	elseif endedSceneName == "Track1" then
		-- "Track1" 結束；加載音樂會中的第二個場景
		EventSequencer.loadScene("Track2")
	else
		-- 循環回預演場景
		EventSequencer.loadScene("PreShow")
	end
end)