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})。

相对于基础 URL 的路径，下列端点是可用的。

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

JSON 值可以是 “null”、“boolean”、“string”、“number”、“array” 或 “object”。

若要使用此端点，你的 OAuth 2.0 应用程序需要以下范围。关于如何注册 OAuth 2.0 应用程序的更多信息，请查看【应用程序注册及评价】({oauth2ReferenceDocLink})。

下列对象描述了接受或返回的有效载荷。请参阅每个单独的端点，以了解更多关于这些对象用途的信息。

这将允许查看关于你素材的信息。

这将允许在 Roblox 上传或更新素材。

Grants the ability to update badges owned by the user.

This allows viewing information about your commerce items.

This allows editing of your commerce merchant connections.

This allows you to view information about your Creator Store products.

This allows you to modify information about your Creator Store products.

This allows you to manage community join requests and role updates of lower-ranked community members for your account.

这将允许查看你的道具栏信息。

Grants access to mange your badges and spend robux.

Grants access to manage your developer products.

Grants access to read information about the experiences you follow.

Grants access to follow and unfollow experiences on your behalf.

Grants access to manage your communities.

Grants permission to read community information.

Grants access to read and write your localization tables

Grants access to manage team collaboration for all experiences you own.

Grants access to manage your experiences and certain information associated with your experiences (e.g. localization information).

Grants access to read your experiences' localization information.

Grants access to modify your experiences' localization preferences.

Grants access to manage your user account.

Grants access to modify user localization preferences.

授予代替用户发布信息的权力。

This allows sending notifications from your experience to users.

这将允许列出与你的作品相关联的密钥。

这将允许创作和更新与你的作品相关联的密钥。

Grants access to read about your subscription products.

Grants the ability to read place information.

Grants the ability to edit place information.

此操作将会允许发布作品的新版本至 Roblox。

Grants the ability to read experience information.

Grants the ability to edit experience information.

Allows you to view user restrictions in the experience.

Allows you to edit user restrictions in the experience.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

默认值：{defaultValueStart}{defaultValueEnd}

数组是一个有序的数值列表。数组有助于存储数据集。

一组键值对，键值可以是任意数字、字符串或对象。

正如{tuples}一样，是一系列的值。

此函数将在可能是立即返回，但在返回值之前可以暂停调用自己的线程。

Roblox 已不再支持或维护{nameStart}名称{nameEnd}。

Roblox 已不再支持或维护这项数学运算。

此成员未在对象浏览器中出现，不应广泛使用。

此成员只能通过命令行访问。从脚本尝试访问此成员将导致错误。

此函数无法暂停调用自己的 Lua 线程。

从脚本尝试访问此成员将导致错误。你可能可以从 Roblox Studio 的属性窗口访问。

此成员不在 Roblox Studio 的对象浏览器中。

你无法使用 Instance.new 构造器创建此类别的实例。

Roblox 不会在跨服务器与客户机界限而复制此成员。

Lua 编程码无法访问此成员。你可能可以从 Roblox Studio 的属性窗口更改其值。

此会员可以从 OpenCloud Luau 执行任务访问。

此对象的复制行为取决于拥有它的玩家。

此成员可以通过命令行和插件访问。从脚本尝试访问此成员将导致错误。

此成员为只读。尝试写入此成员将会导致错误。

此属性为只读，可以从未同步的线程读取。尝试写入可能会导致错误。

只有 Roblox CoreScript 可以访问此成员，Players 不可用。

你可以安全地从多线程对此属性进行读写。

此类别为顶级类单例。使用 GetService 函数获取此类别的实例。

多线程可以写入此属性，所以从未同步的线程读取将会有风险。

此函数在返回借过前将会暂停调用自己的的线程。此操作不会中断其他脚本。

Develop v1