Studio 命令列介面 | 文件 - Roblox 創作者中心

Roblox Studio 支援命令列參數，讓您以特殊功能啟動它，例如在 Studio 啟動時打開特定的地方或腳本。Roblox Studio 可執行檔通常安裝在以下位置：

OS	位置
Windows	%localappdata%\Roblox\Versions\[version]\RobloxStudioBeta.exe
Mac	/Applications/RobloxStudio.app/Contents/MacOS/RobloxStudio

從命令列啟動時，Studio 會將詳細日誌通過 stdout 輸出，這些日誌比 Output 視窗中顯示的內容更加詳細。參數使用雙破折號前綴，並且不區分大小寫。包含空格的檔案路徑必須用引號包住。

在此未記錄的任何參數僅供內部使用，並且可能會在不通知的情況下變更。

開啟一個地方

要開啟已發布的地方，請指定地方 ID、宇宙 ID 和一個任務。

必需的參數

參數	描述
--placeId <placeId>	要開啟的地方的數字 ID。
--universeId <universeId>	擁有該地方的宇宙。
--task <taskName>	根據給定的任務指定 Studio 如何開啟該地方。更多信息請參見下面的支援的任務表格。

支援的任務

參數	描述
EditPlace	打開地方的最新已發布版本以供編輯。
EditPlaceRevision	打開地方的特定先前版本。需要 --placeVersion <versionNumber> 來指定版本。

可選參數

參數	描述
--targetInstanceId <guid>	在地方加載後，將 Studio 相機移動焦點至此 GUID 的實例。
--annotationId <guid>	在地方加載後，打開此 GUID 的註解。

範例


# 開啟地方的最新版本
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708

# 開啟特定的先前版本
RobloxStudio.exe --task EditPlaceRevision --placeId 74265016723074 --universeId 7127583708 --placeVersion 2

開啟一個本地檔案

要開啟一個本地地方，請使用 --task EditFile 並提供以下參數。

參數	描述
--localPlaceFile <path>	本地 .rbxl 或 .rbxlx 地方檔案的絕對路徑。

您也可以通過將檔案路徑作為第一個位置參數而不使用標誌名稱來開啟本地地方檔案。

範例


# 開啟一個本地地方檔案
RobloxStudio.exe --task EditFile --localPlaceFile "Projects\MyGame.rbxl"

# 簡寫
RobloxStudio.exe "Projects\MyGame.rbxl"

開啟一個腳本

要開啟一個腳本，請指定地方 ID、宇宙 ID 和任務，如開啟一個地方部分所述。然後根據您想要如何開啟腳本提供以下參數之一。

參數	描述
--openScriptPath <path>	腳本的路徑。必須使用 / 作為分隔符，並遵循絕對的 require-by-string 語義。
--openScriptFromId <uniqueId>	要開啟的腳本的唯一 ID。

可選高亮顯示

可選地，在開啟腳本時高亮顯示特定行或字元範圍。

參數	描述
--startLine <n>	高亮顯示範圍的起始行。基於 1 的計數且包含。
--endLine <n>	高亮顯示範圍的結束行。基於 1 的計數且不包含。
--startCharacter <n>	行內的起始字元位置。基於 1 的計數。
--endCharacter <n>	行內的結束字元位置。基於 1 的計數且不包含。

範例


# 根據路徑開啟腳本
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript

# 根據 ID 開啟腳本
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptFromId 604a6aa2-04cc-c820-09b3-a1dc0000537f

# 開啟腳本並高亮顯示特定行
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 5

# 開啟腳本並高亮顯示字元範圍
RobloxStudio.exe --task EditPlace --placeId 74265016723074 --universeId 7127583708 --openScriptPath Workspace/MyFolder/MyScript --startLine 1 --endLine 1 --startCharacter 1 --endCharacter 6

執行腳本

使用 --task RunScript 在地方載入完畢後執行 Luau 腳本。腳本以與 Studio 命令列的權限等級執行。您可以將此與 --placeId 和 --universeId 組合使用，以便在特定體驗中運行腳本，或使用 --localPlaceFile 在本地地方檔案中運行腳本。如果省略這些參數，Studio 則打開預設的空白基地板範本並在那裡運行腳本。

必需的參數

參數	描述
--runScriptFile <path>	要執行的 .lua 或 .luau 檔案的絕對路徑。

可選參數

參數	描述
--outputFile <path>	腳本輸出寫入的檔案路徑。
--quitAfterExecution	如提供，則在腳本執行完成後關閉 Studio。

範例


# 在特定體驗中運行腳本，並在完成時退出
RobloxStudio.exe --task RunScript --placeId 74265016723074 --universeId 7127583708 --runScriptFile smokeTest.luau --outputFile out.log --quitAfterExecution

# 在預設的基座板中運行腳本
RobloxStudio.exe --task RunScript --runScriptFile smokeTest.luau

嘗試一個資產

使用 --task TryAsset 將特定資產插入基座板模版並開啟以便編輯。

必需的參數

參數	描述
--assetId <id>	要插入的資產 ID。

範例


RobloxStudio.exe --task TryAsset --assetId 53326

API 傳輸

使用 --api、--fullApi 或 --apiV2 將 Roblox API 表面寫入檔案並退出。

參數	描述
--api <path>	將 Luau 腳本 API 寫入指定檔案的 JSON。
--fullApi <path>	將完整的 API 表面寫入指定檔案的 JSON。
--apiV2 <path>	將完整的 API 以 V2 架構格式寫入指定檔案的 JSON。

範例


RobloxStudio.exe --api "Desktop/output.json"

RobloxStudio.exe --fullApi "Desktop/output.json"

RobloxStudio.exe --apiV2 "Desktop/output.json"