AvatarEditorService

Hiển Thị Bản Đã Lỗi Thời

*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Không Thể Tạo
Dịch Vụ
Không Sao Chép

Dịch vụ AvatarEditor là một dịch vụ hỗ trợ các biên tập viên Avatar của nhà phát triển.Nó cung cấp các phương pháp để thay đổi avatar nền tảng của người chơi, yêu cầu thông tin về kho đồ của người dùng và yêu cầu thông tin về danh mục.

Để biết thêm thông tin về Trình chỉnh Chỉnh Sửa Avatar, xem Dịch vụ Trình chỉnh sửa Avatar.

Giảm tốc

Các điểm cuối sau đây trên AvatarEditorService có giới hạn cấp độ kinh nghiệm:

Đối với mỗi trải nghiệm, giới hạn này cho phép bạn gửi tối đa 100 yêu cầu mỗi giây đến các điểm cuối AvatarEditorService này, bất kể số lượng máy chủ hoặc số lượng người dùng.Vượt quá các giới hạn này trả về lỗi 429 Too Many Requests .

Nếu bạn thấy rằng trải nghiệm của bạn cần điều chỉnh để giảm tải này, bạn có thể gửi yêu cầu tính năng yêu cầu tính năng.

Tóm Tắt

Phương Pháp

Sự Kiện

Thuộc Tính

Phương Pháp

GetAccessoryType

Tham Số

avatarAssetType: Enum.AvatarAssetType
Giá Trị Mặc Định: ""

Lợi Nhuận

PromptAllowInventoryReadAccess

()

Yêu cầu Players.LocalPlayer để cho phép nhà phát triển đọc các mục mà người dùng có trong kho hàng và thông tin liên quan đến trình chỉnh sửa avatar khác.Lời nhắc cần được xác nhận bởi người dùng để nhà phát triển sử dụng AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits()AvatarEditorService:GetFavorite() .Quyền không tồn tại giữa các phiên.


Lợi Nhuận

()

PromptCreateOutfit

()

Yêu cầu Players.LocalPlayer lưu các đường dẫn được cho HumanoidDescription như một bộ trang phục. Không thể hiện. Kết quả có thể được lấy lại bằng cách lắng nghe sự kiện AvatarEditorService.PromptCreateOutfitCompleted .

Tham Số

Cái Outfit mà người chơi sẽ được yêu cầu tạo.

Giá Trị Mặc Định: ""

Các Enum.RigType mà trang phục sẽ được tạo ra nếu người chơi xác nhận lời nhắc.

Giá Trị Mặc Định: ""

Lợi Nhuận

()

PromptDeleteOutfit

()

Yêu cầu Players.LocalPlayer để xóa trang phục đã cho. Không thể thu được. Kết quả có thể được lấy lại bằng cách lắng nghe sự kiện AvatarEditorService.PromptDeleteOutfitCompleted.

Tham Số

outfitId: number

The outfitId của trang phục để xóa.

Giá Trị Mặc Định: ""

Lợi Nhuận

()

PromptRenameOutfit

()

Yêu cầu Players.LocalPlayer đổi tên trang phục đã cho. Không thể thu được kết quả. Kết quả có thể được lấy lại bằng cách lắng nghe sự kiện AvatarEditorService.PromptRenameOutfitCompleted.

Tham Số

outfitId: number

The outfitId của trang phục để đổi tên.

Giá Trị Mặc Định: ""

Lợi Nhuận

()

PromptSaveAvatar

()

Chức năng này yêu cầu Players.LocalPlayer để cập nhật avatar của họ dựa trên HumanoidDescriptionEnum.RigType (R6 hoặc R15).Không trả và có thể nhận được kết quả bằng cách lắng nghe sự kiện PromptSaveAvatarCompleted.Điều này tương tự như cách các thông báo khác như PromptPurchase hoạt động.

Tham Số

humanoidDescription: HumanoidDescription

The given HumanoidDescription được yêu cầu lưu.

Giá Trị Mặc Định: ""

Cái Enum.RigType mà avatar sẽ được lưu nếu người chơi xác nhận lời nhắc.

Giá Trị Mặc Định: ""

Lợi Nhuận

()

PromptSetFavorite

()

Chức năng này yêu cầu Players.LocalPlayer để yêu thích hoặc không yêu thích tài sản hoặc gói được cung cấp.

Tham Số

itemId: number

ItemId của vật phẩm được yêu cầu để yêu thích.

Giá Trị Mặc Định: ""

Loại vật phẩm được yêu cầu để yêu thích.

Giá Trị Mặc Định: ""
shouldFavorite: boolean
Giá Trị Mặc Định: ""

Lợi Nhuận

()

PromptUpdateOutfit

()

Yêu cầu Players.LocalPlayer để cập nhật trang phục đã cho với HumanoidDescription được cung cấp.

Tham Số

outfitId: number

The outfitId của trang phục để cập nhật.

Giá Trị Mặc Định: ""
updatedOutfit: HumanoidDescription

Một mô tả Humanoid đại diện cho dữ liệu trang phục mới.

Giá Trị Mặc Định: ""

HumanoidRigType để cập nhật trang phục.

Giá Trị Mặc Định: ""

Lợi Nhuận

()

CheckApplyDefaultClothing

Sinh Lợi

Trả về một cái mới HumanoidDescription với các thuộc tính Áo và Quần được cập nhật nếu cần thiết. Trả về nil nếu quần áo mặc định không cần thiết.

Trang phục mặc định là cần thiết nếu HumanoidDescription hiện không có áo sơ mi và quần được trang bị và màu cơ thể quá giống nhau.

Tham Số

humanoidDescription: HumanoidDescription

Mô tả Humanoid để kiểm tra xem có cần phải có quần áo mặc mặc định hay không.

Giá Trị Mặc Định: ""

Lợi Nhuận

Trả về một HumanoidDescription nếu quần áo mặc định là cần thiết. Nếu không, trả về nil .

ConformToAvatarRules

Sinh Lợi

Tham Số

humanoidDescription: HumanoidDescription
Giá Trị Mặc Định: ""

Lợi Nhuận

GetAvatarRules

Sinh Lợi

Chức năng này trả về các quy tắc Avatar của nền tảng cho những thứ như phóng to, áo sơ mi và quần, số lượng tài sản có thể mặc, v.v.

Bảng trả về bao gồm các trường sau:


{
"PlayerAvatarTypes": [
"R6"
],
"Scales": {},
"WearableAssetTypes": [
{
"MaxNumber": 0,
"Id": 0,
"Name": "string"
}
],
"BodyColorsPalette": [
{
"BrickColorId": 0,
"NexColor": "string",
"Name": "string"
}
],
"BasicBodyColorsPalette": [
{
"BrickColorId": 0,
"HexColor": "string",
"Name": "string"
}
],
"MinimumDeltaEBodyColorDifference": 0,
"ProportionsAndBodyTypeEnabledForUser": true,
"DefaultClothingAssetLists": {
"DefaultShirtAssetIds": [
0
],
"DefaultPantAssetIds": [
0
]
},
"BundlesEnabledForUser": true,
"EmotesEnabledForUser": true
}

Lợi Nhuận

Một từ điển chứa các quy tắc Avatar cho những thứ như phóng to, áo sơ mi và quần, số lượng tài sản có thể mặc, v.v.Xem ví dụ trả về trong phần mô tả chính phía trên.

GetBatchItemDetails

Sinh Lợi

Nhận chi tiết vật phẩm cho một danh sách vật phẩm cùng một lúc.Hiệu quả hơn AvatarEditorService:GetItemDetails nếu bạn cần nhận tất cả chi tiết vật phẩm của một danh sách.

Tham Số

itemIds: Array

Danh sách ID mục để có chi tiết.

Giá Trị Mặc Định: ""

Loại của các ID mục được cung cấp.

Giá Trị Mặc Định: ""

Lợi Nhuận

Trả về một array các chi tiết vật phẩm với các trường sau:


{
"AssetType" = "string",
"CreatorName" = "string",
"CreatorTargetId" = 0,
"CreatorType" = "string",
"Description" = "string",
"FavoriteCount" = 0,
"Genres" = [
"All"
],
"Id" = 0,
"ItemRestrictions" = [
"Limited"
],
"ItemStatus": [
"New"
],
"ItemType" = "string",
"LowestPrice" = 0,
"Name" = "string",
"Price" = 0,
"ProductId" = 0
}

.

GetFavorite

Sinh Lợi

Chức năng này trả về nếu Players.LocalPlayer đã yêu thích gói hoặc tài sản được cung cấp.

Tham Số

itemId: number

ID của tài sản hoặc gói được định nghĩa.

Giá Trị Mặc Định: ""

The Enum.AvatarItemType của tài sản hoặc gói được chỉ định.

Giá Trị Mặc Định: ""

Lợi Nhuận

Cho dù LocalPlayer có yêu thích gói hoặc tài sản được cho hay không.

GetInventory

Sinh Lợi

Trả về một đối tượng InventoryPages với thông tin về các vật phẩm đã sở hữu trong kho hàng của người dùng với AvatarAssetTypes được cung cấp.

Bảng trả về bao gồm các trường sau:


[
{
"AssetId": 0,
"AssetType" : "string",
"Created": "string",
"Name": "string",
}
]

Tham Số

assetTypes: Array

Các Enum.AvatarAssetType có thể sẽ được kiểm tra trong kho hàng của người chơi.

Giá Trị Mặc Định: ""

Lợi Nhuận

GetItemDetails

Sinh Lợi

Chức năng này trả về chi tiết vật phẩm cho vật phẩm được cho.Nó chấp nhận hai tham số - thứ nhất chỉ ra ID của mục được truy xuất và thứ hai chỉ ra Enum.ItemType của nó.

Dữ liệu được trả lại trong định dạng:


{
"IsForRent": true,
"ExpectedSellerId": 0,
"Owned": true,
"IsPurchasable": true,
"Id": 0,
"ItemType": "Asset",
"AssetType": "Image",
"BundleType": "BodyParts",
"Name": "string",
"Description": "string",
"ProductId": 0,
"Genres": [
"All"
],
"BundledItems": [
{
"Owned": true,
"Id": 0,
"Name": "string",
"Type": "string"
}
],
"ItemStatus": [
"New"
],
"ItemRestrictions": [
"ThirteenPlus"
],
"CreatorType": "User",
"CreatorTargetId": 0,
"CreatorName": "string",
"Price": 0,
"PremiumPricing": {
"PremiumDiscountPercentage": 0,
"PremiumPriceInRobux": 0
},
"LowestPrice": 0,
"PriceStatus": "string",
"UnitsAvailableForConsumption": 0,
"PurchaseCount": 0,
"FavoriteCount": 0
}

Để truy vấn các tài sản giới hạn hoặc không giới hạn, sử dụng các giá trị sau itemRestrictions :

| itemRestrictions | Giới hạn hoặc Vô giới hạn | | :--------------: | :-------------------: | | empty | Vô giới hạn | | Collectible | UGC Giới hạn | | Limited | Roblox Giới hạn duy nhất | | LimitedUnique | Roblox Giới hạn duy nhất Unique |

Tham Số

itemId: number

ID của mục có chi tiết đang được truy xuất.

Giá Trị Mặc Định: ""

Một giá trị enum chỉ ra loại vật phẩm mà chi tiết đang được truy xuất.

Giá Trị Mặc Định: ""

Lợi Nhuận

Một bảng chứa thông tin về mục cho vật phẩmđã lấy. Xem phía trên để có một bảng mẫu.

GetOutfitDetails

Sinh Lợi

Chức năng này trả lại chi tiết trang phục cho trang phục đã cho. Nó chấp nhận một tham số: ID của trang phục.

Dữ liệu trả về theo định dạng sau:


{
"Assets": [
{
"AssetType": {
"Id": 31,
"Name": "RightLeg"
}
"CurrentVersionId": 16447385805,
"Id": 11584239464,
"Name": "Anime Female - Right Leg"
}
],
"BodyColors": {
"HeadColor": Color3(204, 142, 105),
"LeftArmColor": Color3(204, 142, 105),
"LeftLegColor": Color3(204, 142, 105),
"RightArmColor": Color3(204, 142, 105),
"RightLegColor": Color3(204, 142, 105),
"TorsoColor": Color3(204, 142, 105)
},
"Id": 14703770624,
"IsEditable": true,
"Name": "Your Costume",
"OutfitType": "Avatar",
"PlayerAvatarType": "R15",
"Scale": {
"BodyType": 0,
"Depth": 1,
"Head": 1,
"Height": 1,
"Proportion": 0,
"Width": 1
},
}

Tham Số

outfitId: number

ID của trang phục mà chi tiết đang được lấy lại.

Giá Trị Mặc Định: ""

Lợi Nhuận

Một bảng chứa thông tin trang phục cho trang phục đã lấy. Xem phía trên để có một bảng mẫu.

GetOutfits

Sinh Lợi

Chức năng này trả về dữ liệu trang phục cho Players.LocalPlayer .Điều này sẽ được sử dụng với Players:GetHumanoidDescriptionFromOutfitId() để cập nhật nhân vật của người chơi lên trang phục.Truy cập vào nó cũng sẽ phụ thuộc vào AvatarEditorService:PromptAllowInventoryReadAccess() được chấp nhận bởi người dùng.

Bảng trả về bao gồm các trường sau:


[
{
"Id": 0,
"Name": "string",
"IsEditable": true
}
]

<th>đánh máy</th>
<th>Mô tả</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td><td>nhân</td>
<td />
</tr>
<tr>
<td>tên</td><td>chuỗi</td>
<td />
</tr>
<tr>
<td>có thể chỉnh sửa</td><td>boolean</td>
<td />
</tr>
</tbody>
Tên

Tham Số

outfitSource: Enum.OutfitSource
Giá Trị Mặc Định: "All"
outfitType: Enum.OutfitType
Giá Trị Mặc Định: "All"

Lợi Nhuận

GetRecommendedAssets

Sinh Lợi

Trả về một danh sách các tài sản được đề xuất dựa trên một địa chỉ Enum.AssetType và ID tài sản đã cho.Sử dụng cái này để thu thập một danh sách các tài sản tương tự với tài sản được cung cấp.Hãy xem mẫu mã code bên dưới để biết thêm thông tin về các trường hợp sử dụng có thể cho chức năng này.

Dữ liệu có định dạng:


[
{
"Item": {
"AssetId": 0,
"Name": "string",
"Price": 0,
"PremiumPrice": 0,
},
"Creator": {
"CreatorId": 0,
"CreatorType": "string",
"Name": "string",
},
"Product": {
"Id": 0,
"PriceInRobux": 0,
"IsForSale": true,
"IsResellable": true,
"IsLimited": true,
"IsLimitedUnique": true,
"TotalPrivateSales": 0,
"OffsaleDeadline": "string",
"IsFree": true
}
}
]

Tham Số

Loại lời khuyên về tài sản để lấy lời khuyên.Chỉ ảnh hưởng đến phản hồi khi lời khuyên dựa trên mục không tồn tại cho contextAssetId được cho.

Giá Trị Mặc Định: ""
contextAssetId: number

ID của một tài sản với loại phù hợp với loại tài sản được cung cấp được sử dụng cho ngữ cảnh khi lấy lại lời khuyên.

Giá Trị Mặc Định: 0

Lợi Nhuận

Một danh sách các khuyến nghị dựa trên Enum.AssetType được cung cấp.

Mẫu mã

This will return a list of similar hats much like how similar assets are displayed when viewing the catalog page on the website. The contextAssetId is optional and if not provided it will return some popular items from that category.

Getting a Hat Recommendation

local AvatarEditorService = game:GetService("AvatarEditorService")
local assets = AvatarEditorService:GetRecommendedAssets(Enum.AvatarAssetType.Hat, 9255093)
for _, asset in ipairs(assets) do
print(asset.Item.Name)
end

GetRecommendedBundles

Sinh Lợi

Chức năng này trả về một danh sách các gói được đề xuất cho một ID gói cụ thể.

Dữ liệu có định dạng:


[
{
"Id": 0,
"Name": "string",
"Description": "string",
"BundleType": "string",
"Items": [
{
"Owned": true,
"Id": 0,
"Name": "string",
"Type": "string"
}
],
"Creator": {
"Id": 0,
"Name": "string",
"Type": "string"
},
"Product": {
"Id": 0,
"Type": "string",
"IsPublicDomain": true,
"IsForSale": true,
"PriceInRobux": 0,
"PremiumPricing": {
"PremiumDiscountPercentage": 0,
"PremiumPriceInRobux": 0
}
}
}
]

Tham Số

bundleId: number

Một danh sách các gói được đề xuất.

Giá Trị Mặc Định: ""

Lợi Nhuận

ID gói mà các gói được đề xuất sẽ được trả về.

SearchCatalog

Sinh Lợi

Chức năng này trả về một đối tượng CatalogPages chứa kết quả của cuộc tìm kiếm đã cho.

Dữ liệu trả về có định dạng:


[
{
"Id": 0,
"ItemType": "Asset",
"AssetType": "Image",
"BundleType": "BodyParts",
"Name": "string",
"Description": "string",
"ProductId": 0,
"Genres": [
"All"
],
"BundledItems": [
{
"Owned": true,
"Id": 0,
"Name": "string",
"Type": "string"
}
],
"ItemStatus": [
"New"
],
"ItemRestrictions": [
"ThirteenPlus"
],
"CreatorType": "User",
"CreatorTargetId": 0,
"CreatorName": "string",
"Price": 0,
"PremiumPricing": {
"PremiumDiscountPercentage": 0,
"PremiumPriceInRobux": 0
},
"LowestPrice": 0,
"PriceStatus": "string",
"UnitsAvailableForConsumption": 0,
"PurchaseCount": 0,
"FavoriteCount": 0
}
]

Tham Số

searchParameters: CatalogSearchParams

Một đối tượng chứa các tham số được sử dụng cho việc tìm kiếm.

Giá Trị Mặc Định: ""

Lợi Nhuận

Sự Kiện

PromptAllowInventoryReadAccessCompleted

Sự kiện này xảy ra khi lời nhắc AvatarEditorService:PromptAllowInventoryReadAccess() được đáp lại bởi người dùng.Nó chỉ có thể trả về tình trạng Thành công hoặc Bị từ chối enum vì nó không thực hiện bất kỳ yêu cầu web nào có thể thất bại.

Tham Số

Kết quả của cuộc khảo sát.


PromptCreateOutfitCompleted

Sự kiện này bắt lửa khi hoạt động PromptSaveOutfit được hoàn thành.Nó cung cấp một trạng thái enum cho thấy liệu lời nhắc có thành công, thất bại hay không được cho phép bởi người dùng.

Tham Số

Kết quả của cuộc khảo sát.

failureType: Variant

PromptDeleteOutfitCompleted

Bắt lửa khi hoạt động PromptDeleteOutfit được hoàn thành.Nó cung cấp một trạng thái enum cho thấy liệu lời nhắc có thành công, thất bại hay không được cho phép bởi người dùng.

Tham Số

Kết quả của cuộc khảo sát.


PromptRenameOutfitCompleted

Nổ khi hoạt động PromptRenameOutfit được hoàn thành.Nó cung cấp một trạng thái enum cho thấy liệu lời nhắc có thành công, thất bại hay không được cho phép bởi người dùng.

Tham Số

Kết quả của cuộc khảo sát.


PromptSaveAvatarCompleted

Sự kiện này bắt lửa khi hoạt động AvatarEditorService:PromptSaveAvatar() hoàn thành.Nó cung cấp một trạng thái enum cho thấy liệu lời nhắc có thành công, thất bại hay không được cho phép bởi người dùng.

Tham Số

Kết quả của cuộc khảo sát.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Bắt lửa khi hoạt động AvatarEditorService:PromptSetFavorite() hoàn thành.Nó cung cấp một trạng thái enum cho thấy liệu lời nhắc có thành công, thất bại hay không được cho phép bởi người dùng.

Tham Số

Kết quả của cuộc khảo sát.


PromptUpdateOutfitCompleted

Bắt lửa khi hoạt động AvatarEditorService:PromptUpdateOutfit() hoàn thành.Nó cung cấp một trạng thái enum cho thấy liệu lời nhắc có thành công, thất bại hay không được cho phép bởi người dùng.

Tham Số

Kết quả của cuộc khảo sát.