Represents a game template in API endpoint responses.

Whether this game template has tutorials.

A model containing information about a group

The Roblox.Platform.Groups.IGroup's name.

A model containing information about a place

A model containing information about a place to be configured

Returns the id of the place's universe, or null - if the place is not part of a universe.

Model for private server details responses from the UniverseSettings controller.

The number of active VIP servers for this universe. A negative value indicates at least this many exist (i.e. -100 means 100+ active private servers).

The number of active VIP server subscriptions. A negative value indicates at least this many exist (i.e. -100 means 100+ active subscriptions).

Whether or not VIP servers are enabled on this universe.

Whether the user can vote on this !:IAsset.

Whether the user has voted on this !:IAsset.

The reason this !:IAsset cannot be voted on.

Whether or not the universe should be enabled for team create

Request model for a TeamCreate membership

A model containing information about a universe permissions

Determines whether or not consumer can cloud the target universe
This is only nullable/optional in the context of https://develop.roblox.com/docs#!/Universes/get_v1_universes_universeId_context_permissions endpoint which is consumed only internally. It should be computed and set for all other usages.

Determines whether or not consumer can manage the target universe

The universe Id these permissions reference

Represents a universe in API endpoint results.

The id of the user or group that created this universe.

The creator type, either "User" or "Group"

Model for UniverseSettings patch requests

Sets the base price of the experience for Fiat purchases.

Determines the change type of the Fiat Product Change request.
Can either Activate the product, Update the price, or Deactivate the product.

Whether game access is limited to friends for user-owned games or group members for group-owned games.

Sets whether access to APIs for mesh and texture is enabled for this universe.

Set is rewarded on-demand ads are allowed for this universe.

List of device types this game can be played on.

 ['Computer' = 1, 'Phone' = 2, 'Tablet' = 3, 'Console' = 4, 'VR' = 5]

Whether custom animations are allowed in the universe.

Which avatar types are allowed in the universe.

What avatar body types are allowed by the universe.

What type of collisions are used by the universe.

What avatar joint positioning type is allowed by the universe.

Whether custom scales allowed in the universe.

Model for UniverseSettings controller responses

If the universe allows the use of private servers.

The current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]

Game genre. ['All' = 0, 'Tutorial' = 1, 'Scary' = 2, 'TownAndCity' = 3, 'War' = 4, 'Funny' = 5, 'Fantasy' = 6, 'Adventure' = 7, 'SciFi' = 8, 'Pirate' = 9, 'FPS' = 10, 'RPG' = 11, 'Sports' = 12, 'Ninja' = 13, 'WildWest' = 14]

Whether the game is offered for sale in fiat.

Whether access to APIs for mesh and texture is enabled for this universe.

Whether rewarded on-demand ads are allowed for this universe.

Whether studio access to APIs is allowed or not.

The price to purchase a private server in robux.

Whether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]

Which avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]

What avatar body types are allowed by the universe. ['Standard' = 1, 'PlayerChoice' = 2]

What type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]

What avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]

Whether custom scales allowed in the universe. ['NoScales' = 1, 'AllScales' = 2]

Whether or not the universe is enabled for team create

Whether or not comments should be enabled.

Whether or not the plugin allows comments to be posted.

Develop Api v1

The ids of the Roblox.Platform.Assets.IAsset.

assetIds

Gets the voting information of the given assets

Templates subject to change without notice.
Sort order of templates specified by Roblox.

Gets a page of templates that can be used to start off making games.

groupId

isArchived

limit

The paging cursor for the previous or next page.

cursor

sortOrder

Gets a list of universes for the given group.

Currently the only supported functionality for updating the configuration is around Name, and Description.

The place id for the place to be updated.

placeId

configuration

0: Authorization has been denied for this request.

Authenticated user is not authorized to manage this place.
0: Token Validation Failed

Updates the place configuration for the place with the id placeId

1: The universe is invalid.
5: The place is invalid.

2: Not authorized to perform this action.
4: TeamCreate on universe is disabled.

6: Multiple active sessions in a Team Create place.

List of users in the active Team Create session

pluginIds

1: Too many ids.
2: The format of the ids are invalid.

pluginId

The Roblox.Develop.Api.UpdatePluginRequest.

request

5: Description too long.
6: Text moderated.
7: Invalid name.
8: The request body is missing.

0: Token Validation Failed
4: Insufficient permissions.

If a universe can not be found for a given ID (such as -1) it will be skipped.

8: No universe IDs sent to get.
9: Too many universe IDs sent to get, the limit is: 

Gets a System.Collections.Generic.List`1.

Returns an array of granted and declined permissions related to the universes with the ids in ids for the authenticated user.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.TooManyUniverseIdsSent

Gets TeamCreate settings for multiple universes specified by Ids

universeId

Gets a Roblox.Api.Develop.Models.UniverseModel.

1: The universe does not exist.
2: This universe does not have a root place.

0: Token Validation Failed
3: You are not authorized to configure this universe.
6: The root place for this universe is under review and can not be activated.
7: Creator already has the maximum number of places active.

2: You are not authorized to configure this universe.

The Roblox.Api.Develop.Models.UniverseSettingsRequest model.

model

1: The universe does not exist.
3: Invalid UniverseAvatarType.
4: Invalid UniverseScaleType.
5: Invalid UniverseAnimationType.
6: Invalid UniverseCollisionType.
7: New universe name or description has been rejected.
8: New universe name is too long.
10: Invalid UniverseBodyType.
11: Invalid UniverseJointPositioningType.
12: The universe has no root place.
15: Price is required when isForSale is true.
16: This game cannot be offered for sale because it is not public.
17: This game cannot be offered for sale because it has private servers enabled.
18: The game price is outside of the allowed range.
19: Invalid genre.
20: The request body is missing.
21: Invalid device type.
22: Invalid asset type.
23: Invalid value, the min must be less than or equal to the max
24: Invalid scale value

0: Token Validation Failed
2: You are not authorized to configure this universe.
14: You are not authorized to sell games.

9: Failed to shutdown all intances of game after changing AvatarType. The change has been reverted.

Update universe settings for an owned universe.

Get settings for an owned universe's VIP servers.

0: Token Validation Failed
3: You are not authorized to configure this universe.

Returns list of granted and declined permissions related to the universe with the id universeId for authenticated user

isUniverseCreation

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUniverse

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.Unauthorized

Gets TeamCreate settings for an Roblox.Platform.Universes.IUniverse.

Enables, or disables team create for a universe.

The request body containing the team create settings.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.Unauthorized
0: Token Validation Failed

Edit team create settings for a universe.

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUniverse OR Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.InvalidUser

Roblox.Api.Develop.ResponseEnums.TeamCreateErrors.TeamCreateDisabled
0: Token Validation Failed

Removes a user from a TeamCreate permissions list.

Gets a list of Groups that a user can manage.

Gets a list of groups a user can manage games or items for.

Gets a list of universes for the authenticated user.

概覽

指南

教學

參考

資源

美術

設計

引擎

虛擬人偶

雲端

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

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

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

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

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

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

呼叫此端點需要以下 API 金鑰權限。有關如何產生正確金鑰的更多資訊，請查看[管理 API 金鑰]({apiKeyReferenceDocLink})。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

授予讀取您所追蹤體驗之相關資訊的權限。

授予代您追蹤體驗和取消追蹤的權限。

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

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

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

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

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

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

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

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

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

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

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

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

此操作將會允許發布新版本的體驗到 Roblox。

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

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

授予讀取使用者高級會員狀態與驗證狀態的能力。

這能讓您檢視使用者的社群帳號。

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

預設值：{defaultValueStart}{defaultValueEnd}

陣列是值的有序列表。陣列在儲存資料組合時很實用。

一組鍵值對，鍵可以是任何數字、字串或物件。

此函式將允許時將會立刻傳回，但在能傳回值之前可以暫停呼叫自己的執行緒。

Roblox 已不再支援或維護 {nameStart}name{nameEnd}。

Roblox 已不再支援或維護這項數學運算。

此成員未在物件瀏覽器出現，不應廣泛使用。

此成員只能透過指令列存取。從指令碼存取此成員將會導致錯誤。

此函式無法暫停呼叫自己的 Lua 執行緒。

在指令碼存取此成員將會導致錯誤。您可能可以從 Roblox Studio 的屬性視窗存取此成員。

此成員不再 Roblox Studio 的物件瀏覽器中。

您無法使用 Instance.new 建構式建立此類別的個體。

Roblox 不會跨越伺服器與用戶端界限而複製此成員。

Lua 程式碼無法存取此成員。您可能可以從 Roblox Studio 的屬性視窗變更其值。

此成員可從 OpenCloud Luau 執行任務存取。

此物件的複製行為取決於擁有的玩家。

此成員能透過指令列和外掛程式存取。從指令碼存取此成員將會導致錯誤。

此為唯讀成員。寫入此成員將會導致錯誤。

此為唯讀屬性，可以在未同步的執行緒讀取。嘗試寫入將會導致錯誤。

只有 Roblox CoreScript 可以存取此成員，Player 不可使用。

您可以安全地從多個執行緒對此屬性讀寫。

此類別為頂層 Singleton。使用 GetService 函式取得此類別的個體。

多個執行緒可以寫入此屬性，從未同步的執行緒讀取將有風險。

此函式在傳回結果前將會暫停呼叫自己的執行緒。此操作不會中斷其他指令碼。

在同個地方集中管理和分析您的所有體驗。

透過為所有創作者準備的文件和資源來學習。

透過各種指南、教學和程式碼範本，學習如何打造 Roblox 體驗。

在我們全方位的整合開發環境 Studio 中打造您的體驗，並將其部署到多種裝置上。

Develop v1