AvatarEditorService

Phương Pháp

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():void
Yêu cầu Players.LocalPlayer để cho phép nhà phát triển đọc những mục nào mà người dùng có trong kho đồ và các thông tin khác của avatar editor.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Yêu cầu Players.LocalPlayer lưu các thông tin đã được cho HumanoidDescription như một trang phục.
PromptDeleteOutfit(outfitId : number):void
Yêu cầu Players.LocalPlayer xóa trang phục đã được cung cấp.
PromptRenameOutfit(outfitId : number):void
Yêu cầu Players.LocalPlayer đổi tên trang phục đã được cung cấp.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Yêu cầu Players.LocalPlayer để cập nhật avatar của họ dựa trên các thông tin đã được cung cấp HumanoidDescription và Enum.RigType của R6 hoặc R15.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : bool):void
Yêu cầu Players.LocalPlayer thích hoặc bỏ thích tài sản hoặc gói đã được cung cấp.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Yêu cầu Players.LocalPlayer để cập nhật trang phục đã được cung cấp.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Sinh Lợi
Được sử dụng để áp dụng quần áo mặc định vào HumanoidDescription nếu cần thiết.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Sinh Lợi
GetAvatarRules():Dictionary
Sinh Lợi
Quay lại các quy tắc Avatar cho các thứ như thước đo, áo thun mặc định và quần, số lượng tài sản có thể mặc.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Sinh Lợi
Lấy chi tiết mục cho một danh sách mục đồng thời.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):bool
Sinh Lợi
Quay lại nếu Players.LocalPlayer đã yêu thích gói tài nguyên hoặc bộ đồ đã cho.
GetInventory(assetTypes : Array):InventoryPages
Sinh Lợi
Đ반환 một InventoryPages đối tượng với thông tin về các mục sở hữu trong kho đồ của người dùng với các điều kiện đã được cung cấp bởi AvatarAssetTypes.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Sinh Lợi
Trả lại chi tiết mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho mục đã cho vật phẩmđã cho mục đã cho
GetOutfitDetails(outfitId : number):Dictionary
Sinh Lợi
Trả lại chi tiết trang phục cho trang phục đã được cung cấp.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Sinh Lợi
Trả lại dữ liệu trang phục cho Players.LocalPlayer .
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Sinh Lợi
Trả lại một danh sách các tài nguyên được đề xuất dựa trên một danh sách các id tài nguyên được cung cấp và danh sách các tài nguyên.
GetRecommendedBundles(bundleId : number):Array
Sinh Lợi
Trả lại một danh sách các gói được đề xuất cho một id gói cụ thể.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Sinh Lợi
Trả lại một CatalogPages đối tượng chứa kết quả của cuộc tìm kiếm đã được cung cấp.

Sự Kiện

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Lửa khi AvatarEditorService:PromptAllowInventoryReadAccess() yêu cầu được phản hồi bởi người dùng.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
Lửa khi hoạt động nhận lệnh SaveOutfit đã hoàn thành.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Lửa khi hành động Xóa trang phục yêu cầu đã hoàn thành.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Lửa khi hoạt động PromptRenameOutfit xong.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Làm việc khi hoạt động AvatarEditorService:PromptSaveAvatar() đã hoàn thành.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Làm nổ khi hoạt động AvatarEditorService:PromptSetFavorite() đã hoàn thành.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Làm nổ khi hoạt động AvatarEditorService:PromptUpdateOutfit() đã hoàn thành.

Thuộc Tính

Phương Pháp

PromptAllowInventoryReadAccess

void

Yêu cầu Players.LocalPlayer để cho phép nhà phát triển đọc những vật phẩm mà người dùng có trong kho và thông tin avatar khác liên quan đến nhà phát triển. Yêu cầu n

Lợi Nhuận

void

PromptCreateOutfit

void

Yêu cầu Players.LocalPlayer lưu món đồ HumanoidDescription đã được cho là một trang phục. Không tạo ra kết quả. Kết quả có thể được lấy bằng cách lắng nghe sự kiện AvatarEditorService.PromptCreateOutfitCompleted .

Tham Số

outfit: HumanoidDescription

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

rigType: Enum.HumanoidRigType

The Enum.RigType that the outfit will be created for if the player confirms the prompt.

Lợi Nhuận

void

PromptDeleteOutfit

void

Yêu cầu Players.LocalPlayer xóa trang phục đã được cung cấp. Không tạo ra kết quả. 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

Thông số trang phục để xóa.

Lợi Nhuận

void

PromptRenameOutfit

void

Yêu cầu Players.LocalPlayer đổi tên trang phục đã được cung cấp. Không tạo ra 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.

Lợi Nhuận

void

PromptSaveAvatar

void

Hành động này yêu cầu Players.LocalPlayer để cập nhật avatar của họ dựa trên HumanoidDescription và Enum.RigType (R6 hoặc R15). Không đưa ra kết quả và có thể nhận kết quả b

Tham Số

humanoidDescription: HumanoidDescription

Các thẻ đã được yêu cầu lưu.

rigType: Enum.HumanoidRigType

The Enum.RigType that the avatar will be saved for if the player confirms the prompt.

Lợi Nhuận

void

PromptSetFavorite

void

Hành động này yêu cầu Players.LocalPlayer để thêm hoặc bỏ bớt yêu thích hoặc bỏ bớt bộ góiđã được cung cấp.

Tham Số

itemId: number

Id Item của mục được yêu cầu để thêm vào bộ sưu yêu thích.

itemType: Enum.AvatarItemType

Loại mục được yêu cầu để thêm vào yêu thích.

shouldFavorite: bool

Lợi Nhuận

void

PromptUpdateOutfit

void

Yêu cầu Players.LocalPlayer để cập nhật trang phục đã được cung cấp với mô tả người dùng được cho.

Tham Số

outfitId: number

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

updatedOutfit: HumanoidDescription

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

rigType: Enum.HumanoidRigType

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

Lợi Nhuận

void

CheckApplyDefaultClothing

Sinh Lợi

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

Trang phục mặc định là cần thiết nếu HumanoidDescription hiện đang không có áo thun và quần để đeo và màu thân hình quá giống nhau.

Tham Số

humanoidDescription: HumanoidDescription

Mô tả người nhiều để kiểm tra có cần phải mặc đồng phục mặc định hay không.

Lợi Nhuận

Trả lại một DescriptionHumanoid nếu cần thiết phải mặc đồng phục. Ngược lại, trả lại nil.

ConformToAvatarRules

Sinh Lợi

Tham Số

humanoidDescription: HumanoidDescription

Lợi Nhuận

GetAvatarRules

Sinh Lợi

Chức năng này trả lại các quy tắc Avatar cho các thứ như thước đo, áo thun và quần, số lượng tài nguyên đeo, vv.

Bảng trả lại 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 các thứ như thương mại, áo thun và quần, số lượng tài sản có thể mặc, vv. Tham khảo ví dụ trở lại trong mô tả chính trên cùng.

GetBatchItemDetails

Sinh Lợi

Lấy chi tiết mục để có một danh sách các mục đồng thời. Hiệu quả hơn AvatarEditorService:GetItemDetails nếu bạn cần phải lấy tất cả chi tiết mục của một danh sách.

Tham Số

itemIds: Array

Danh sách các mục để nhận chi tiết.

itemType: Enum.AvatarItemType

Loại của các ID cung cấp.

Lợi Nhuận

Trả một loạt các chi tiết mục với các trường sau đây:


{
    "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

bool

Sinh Lợi

Hàm này trả về nếu Players.LocalPlayer đã yêu thích hàng tập tin hoặc tài nguyên đã được cung cấp.

Tham Số

itemId: number

ID của tài nguyên hoặc gói được chỉ định.

itemType: Enum.AvatarItemType

Amount.AvatarItemType của tài nguyên hoặc gói được chỉ định.

Lợi Nhuận

bool

Có phải LocalPlayer đã yêu thích gói tài nguyên hoặc mục yêu thích đã được cung cấp không?

GetInventory

InventoryPages

Sinh Lợi

Đ반환 một InventoryPages đối tượng với thông tin về các mục đã sở hữu trong kho đồ của người dùng với AvatarAssetTypes được cung cấp.

Bảng trả lại bao gồm các trường sau:


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

Tham Số

assetTypes: Array

Amount.AvatarAssetType mà người chơi có thể kiểm tra trong kho đồ của họ.

Lợi Nhuận

InventoryPages

GetItemDetails

Sinh Lợi

Hàm này trả lại chi tiết của vật phẩmđược cho để lấy. Nó chấp nhận hai tham số - thứ nhất là thể hiện ID của mục được lấy và thứ hai là thể hiện Enum.ItemType của nó.

Dữ liệu được trả lại trong 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
}

Để tìm kiếm cho các tài nguyên giới hạn hoặc không giới hạn, hãy sử dụng các giá trị itemRestrictions sau đây:

Tham Số

itemId: number

ID của mục được lấy chi tiết.

itemType: Enum.AvatarItemType

Một giá trị열 định loại của một món đồ đang được lấy chi tiết.

Lợi Nhuận

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

GetOutfitDetails

Sinh Lợi

Hàm này trả lại chi tiết trang phục cho trang phục được cung cấp. Nó chấp nhận một tham số: ID của trang phục.

Dữ liệu trả lại trong định dạng sau đây:


{
  "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.

Lợi Nhuận

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

GetOutfits

OutfitPages

Sinh Lợi

Hàm này trả lại 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 người chơi với trang phục. Điều này cũng sẽ phụ

Bảng trả lại bao gồm các trường sau:


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


<tbody>
  <tr>
    <td>nhận dạng</td>
    <td>int</td>

    <td />
  </tr>

  <tr>
    <td>tên</td>
    <td>chuỗi</td>

    <td />
  </tr>

  <tr>
    <td>isEditable</td>
    <td>boolean</td>

    <td />
  </tr>
</tbody>

Tên	đánh máy	Mô tả

Tham Số

outfitSource: Enum.OutfitSource

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

outfitType: Enum.OutfitType

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

Lợi Nhuận

OutfitPages

GetRecommendedAssets

Sinh Lợi

Điều chỉnh một danh sách các tài nguyên được đề xuất dựa trên một danh sách các tài nguyên được đề xuất và id của tài nguyên. Sử dụng này để thu thập một danh sách các tài nguyên tương tự như tài nguyên được cung cấp. Hãy xem mẫu code bên dưới cho thêm thông

Dữ liệu được biểu tượng như:


[
    {
      "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ố

assetType: Enum.AvatarAssetType

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

contextAssetId: number

ID của tài nguyên với một loại tương ứng với loại tài nguyên được sử dụng cho ngữ cảnh khi lấy lại các khuyến nghị.

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ã

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

Hàm này trả lại một danh sách các gói được đề xuất cho một ID gói cụ thể.

Dữ liệu được biểu tượng như:


[
    {
      "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.

Lợi Nhuận

ID gói được quyền bị trả lại cho các gói được đề xuất.

SearchCatalog

CatalogPages

Sinh Lợi

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

Dữ liệu đã được trả lại có 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 tìm kiếm.

Lợi Nhuận

CatalogPages

Sự Kiện

PromptAllowInventoryReadAccessCompleted

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

Tham Số

Kết quả của hộp thoại.

PromptCreateOutfitCompleted

Sự kiện này được tích hợp khi hoạt động PromptSaveOutfit được hoàn thành. Nó cho một trạng thái enum cho thấy có thành công, thất bại hoặc không được cấp quyền bởi người dùng.

Tham Số

Kết quả của hộp thoại.

failureType: Variant

PromptDeleteOutfitCompleted

Làm nổ khi hoạt động PromptDeleteOutfit đã hoàn thành. Nó cho thêm một status enum cho biết liệu yêu cầu thành công, thất bại hay không được cấp quyền bởi người dùng.

Tham Số

Kết quả của hộp thoại.

PromptRenameOutfitCompleted

Làm nổ khi hoạt động PromptRenameOutfit đã hoàn thành. Nó cho thêm một status enum cho biết liệu hộp thoại đã thành công, không thành công hoặc không được cấp quyền bởi người dùng.

Tham Số

Kết quả của hộp thoại.

PromptSaveAvatarCompleted

Sự kiện này bắt đầu khi hoạt động AvatarEditorService:PromptSaveAvatar() đã hoàn thành. Nó cho một status enum cho thấy có thành công, thất bại hoặc không được cấp quyền bởi người dùng.

Tham Số

Kết quả của hộp thoại.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Kích hoạt khi hoạt động AvatarEditorService:PromptSetFavorite() đã hoàn thành. Nó cho một trạng thái enum cho thấy có thành công, thất bại hoặc không được cấp quyền bởi người dùng.

Tham Số

Kết quả của hộp thoại.

PromptUpdateOutfitCompleted

Kích hoạt khi hoạt động AvatarEditorService:PromptUpdateOutfit() đã hoàn thành. Nó cho một trạng thái enum cho biết có thành công, thất bại hoặc không được cấp quyền bởi người dùng.

Tham Số

Kết quả của hộp thoại.