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.

Tổng Quan

Trải Nghiệm

Avatar

Tài Sản

Open Cloud

Tạo

Khám Phá

Bản Địa Hóa

Phân Tích

Thiết Kế

Scale

Nhóm liên kết

Monetize

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] ({longRunningOperationsLink}) về các hoạt động kéo dài để biết thêm thông tin.
            
Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Các đầu cuối beta đã sẵn sàng cho việc sử dụng công khai. Có thể xuất hiện những thay đổi bất ngờ, nhưng trường hợp này rất hiếm.

Trường này có thể được đặt khi tạo tài nguyên, nhưng không thể được sửa đổi bởi các yêu cầu tiếp theo.

Các trường này có thể được đặt khi tạo tài nguyên, nhưng không thể được sửa đổi bởi các yêu cầu tiếp theo.

Trường này có thể được cung cấp trong các yêu cầu, nhưng sẽ không bao giờ được đưa vào các phản hồi.

Mỗi Khóa API: {maxInPeriod} yêu cầu mỗi {periodInSeconds} giây cho mỗi Địa Chỉ IP

Trường này có thể được đặt thành các phản hồi, nhưng sẽ bị bỏ qua trong các yêu cầu.

Cần có các quyền khóa API sau đây để gọi ra điểm cuối này. Để biết thêm
thông tin về cách tạo các khóa thích hợp, hãy xem [Quản lý khóa API] ({apiKeyReferenceDocLink}).

Các điểm cuối sau đây có trong đường dẫn liên quan đến URL cơ sở.

Chuỗi này được định dạng là [Mặt nạ trường](/cloud/reference/types#timestamp).

Giá trị JSON có thể là `null`, `boolean`, `string`, `number`, `array` hoặc `object`.

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng ký và đánh giá ứng dụng]({oauth2ReferenceDocLink}).

Các đối tượng sau đây mô tả payload được chấp nhận hoặc bị trả về. Xem từng điểm cuối để biết thêm thông tin về thời điểm sử dụng các đối tượng này.

Chuỗi này được định dạng là [Dấu thời gian](/cloud/reference/types#timestamp).

Cần có các phạm vi sau đây để ứng dụng OAuth 2.0 của bạn sử dụng điểm cuối này. Để biết thêm thông tin về cách đăng ký ứng dụng OAuth 2.0, hãy xem [Đăng Ký và Đánh Giá Ứng Dụng]({oauth2ReferenceDocLink}).

Không có mô tả nào được cung cấp.

Điều này cho phép bạn xem thông tin về tài sản của mình.

Điều này cho phép bạn tải lên và cập nhật tài sản vào Roblox.

Cấp khả năng cập nhật huy hiệu mà người dùng sở hữu.

Điều này cho phép bạn xem thông tin về vật phẩm thương mại của mình.

Điều này cho phép bạn chỉnh sửa các kết nối người bán thương mại.

Điều này cho phép bạn xem thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn sửa đổi thông tin về các sản phẩm trong Cửa Hàng Nhà Sáng Tạo của bạn.

Điều này cho phép bạn xem thông tin về cộng đồng của mình.

Điều này cho phép bạn quản lý các yêu cầu tham gia cộng đồng và cập nhật vai trò của thành viên cộng đồng bậc thấp cho tài khoản của bạn.

Điều này cho phép bạn xem thông tin về kho của mình.

Cấp quyền truy cập để quản lý huy hiệu của bạn.

Cấp quyền để quản lý huy hiệu của bạn và chi tiêu robux.

Cấp quyền quản lý các sản phẩm phát triển của bạn.

Cấp quyền đọc thông tin về các trải nghiệm mà bạn đang theo dõi.

Cấp quyền thay mặt bạn theo dõi và bỏ theo dõi các trải nghiệm.

Cấp quyền truy cập để quản lý vé của bạn.

Cấp quyền truy cập để quản lý các cộng đồng của bạn.

Cấp quyền để đọc thông tin cộng đồng.

Cấp quyền để đọc và ghi các bảng bản địa hóa của bạn

Cấp quyền truy cập để quản lý hoạt động cộng tác đội cho tất cả các trải nghiệm của bạn.

Cấp quyền truy cập để quản lý các trải nghiệm của bạn và một số thông tin cụ thể gắn liền với các trải nghiệm đó (ví dụ: thông tin bản địa hóa).

Cấp quyền để đọc thông tin bản địa hóa của các trải nghiệm của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa trải nghiệm của bạn.

Cấp quyền truy cập để quản lý tài khoản người dùng của bạn.

Cấp quyền để sửa đổi các tùy chọn bản địa hóa của người dùng.

Điều này cho phép bạn đăng tải tin nhắn thay mặt cho người dùng.

Điều này cho phép gửi các thông báo từ trải nghiệm của bạn đến người dùng.

Điều này cho phép bạn liệt kê mã liên quan đến trải nghiệm của bạn.

Điều này cho phép bạn tạo và cập nhật mã liên quan đến trải nghiệm của bạn.

Cấp quyền để đọc về các trang bị đặc quyền của bạn.

Cấp khả năng đọc thông tin địa điểm.

Cấp khả năng chỉnh sửa thông tin địa điểm.

Thao tác này cấp quyền đăng tải các phiên bản mới của trải nghiệm cho Roblox.

Cấp khả năng đọc thông tin trải nghiệm.

Cấp khả năng chỉnh sửa thông tin trải nghiệm.

Cho phép bạn xem các hạn chế của người dùng trong trải nghiệm.

Cho phép bạn chỉnh sửa các hạn chế người dùng trong trải nghiệm.

Cấp khả năng đọc trạng thái premium và trạng thái đã xác thực của người dùng.

Điều này cho phép bạn xem các tài khoản mạng xã hội của người dùng.

Điều này cho phép kích hoạt chức năng Đăng Nhập Một Lần.

Điều này cho phép người dùng đọc thông tin hồ sơ của bạn.

Giá Trị Mặc Định: {defaultValueStart}{defaultValueEnd}

Mảng là danh sách các giá trị được sắp xếp theo thứ tự. Mảng rất hữu ích để lưu trữ các bộ dữ liệu.

Một tập hợp các cặp giá trị khóa, trong đó khóa có thể là bất kỳ số, chuỗi hoặc đối tượng nào.

Chẳng hạn {tuples}, một danh sách các giá trị.

Hàm này sẽ trả về kết quả ngay lập tức nếu có thể, nhưng cũng có khả năng tạm dừng luồng đã gọi hàm cho đến khi hàm có giá trị để trả về.

{nameStart}tên{nameEnd} không còn được hỗ trợ hoặc duy trì bởi Roblox.

Phép toán này không còn được hỗ trợ hoặc duy trì bởi Roblox.

Thành phần này không xuất hiện trong trình duyệt đối tượng và không dành cho mục đích sử dụng rộng rãi.

Chỉ có thể truy cập thành phần thông qua thanh lệnh. Việc sử dụng thành phần này trong kịch bản sẽ gây ra lỗi.

Hàm này không thể tạm dừng luồng Lua đã gọi hàm.

Việc cố gắng truy cập thành phần này trong kịch bản sẽ gây ra lỗi. Tuy nhiên, bạn có thể truy cập thành phần này từ cửa sổ thuộc tính của Roblox Studio.

Thành phần này không xuất hiện trong Trình duyệt Đối tượng của Roblox Studio.

Bạn không thể tạo một phiên bản của lớp này với hàm khởi tạo Instance.new.

Roblox không sao chép thành phần này qua ranh giới máy chủ - máy khách.

Mã Lua không thể truy cập thành phần này. Bạn có thể thay đổi giá trị của nó từ cửa sổ thuộc tính trong Roblox Studio.

Thành viên này có thể truy cập từ các nhiệm vụ thực thi OpenCloud Luau.

Hành vi sao chép của đối tượng này phụ thuộc vào người chơi sở hữu nó.

Có thể truy cập thành phần thông qua thanh lệnh và plugin. Việc sử dụng thành phần này trong tập lệnh sẽ gây ra lỗi.

Thành phần này ở dạng chỉ đọc. Việc cố ghi vào thành phần này sẽ gây ra lỗi.

Thuộc tính này ở dạng chỉ đọc và có thể đọc an toàn trên các luồng không đồng bộ. Việc cố gắng ghi vào thuộc tính này sẽ gây ra lỗi.

Chỉ có thể truy cập thành phần này trong CoreScripts.

Chỉ Roblox CoreScripts mới có thể truy cập thành phần này, và Người Chơi không thể truy cập được.

Bạn có thể đọc và ghi vào thuộc tính này một cách an toàn từ nhiều luồng.

Lớp này là một singleton hàng đầu. Hãy lấy một phiên bản của lớp này bằng hàm GetService.

Nhiều luồng có thể ghi thuộc tính này, vì vậy việc đọc từ các luồng không đồng bộ sẽ là một việc không an toàn.

Hàm này sẽ tạm dừng luồng Lua đã gọi hàm cho đến khi hàm này trả về một kết quả. Tuy nhiên, việc tạm dừng này không ảnh hưởng đến các kịch bản khác đang chạy.

Develop v1