AvatarEditorService

参数

返回

提示 Players.LocalPlayer 允许开发人员读取用户在其库存和其他虚拟形象编辑器相关信息。提示需要由用户确认才能使用 AvatarEditorService:GetInventory() 、 AvatarEditorService:GetOutfits() 和 <

返回

提示 Players.LocalPlayer 保存给定的 HumanoidDescription 作为服装。不会生成。结果可以通过听取 AvatarEditorService.PromptCreateOutfitCompleted 事件来获取。

参数

返回

提示 Players.LocalPlayer 删除所提供的服装。不会产生。结果可以通过听取 AvatarEditorService.PromptDeleteOutfitCompleted 事件来恢复。

参数

返回

提示 Players.LocalPlayer 重命名所指定的服装。不会产生。结果可以通过听取 AvatarEditorService.PromptRenameOutfitCompleted 事件来获取。

参数

返回

此函数提示 Players.LocalPlayer 更新他们的头像，根据所提供的 HumanoidDescription 和 Enum.RigType (R6 或 R15) 来更新他们的头像。不会生成结果，可以通过听取提示保存头像完成后获得。这与其他提示，例如提示购买工作的方

参数

返回

此功能提示 Players.LocalPlayer 收藏或取消收藏指定资产或套装。

参数

返回

提示 Players.LocalPlayer 更新所提供的服装以反映所提供的人形描述。

参数

返回

如果需要，会更新 Shirt 和 Pants 属性，以反映 Shirt 和 Pants 的更新。如果不需要，则返回 nil 。

默认服装是否有人形描述尚未装备上衣和裤子，以及身体颜色过于相似，否则。

参数

返回

参数

返回

此函数返回平台虚拟形象规则，例如缩放、默认上衣和裤子、服装资产数量等。

返回的表包括以下字段：

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

返回

获取列表中的项目详情。 比 AvatarEditorService:GetItemDetails 更有效率，如果您需要获取列表中的所有项目详情。

参数

返回

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

此函数返回，如果 Players.LocalPlayer 已经收藏了指定的包裹或资产。

参数

返回

返回一个 InventoryPages 对象，包含用户存储的用户拥有物品的信息。用户存储的用户拥有物品为 AvatarAssetTypes 。

返回的表包括以下字段：

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

参数

返回

此函数为指定的物品返回物品详细信息。它接受两个参数 - 第一个表示要检索的物品的ID，第二个表示其 Enum.ItemType 。

数据以该格式返回：

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

要查询有限或无限资产，请使用以下 itemRestrictions 值：

|itemRestrictions|限或无限| | | :--------------: | :-------------------: | | empty | Unlimited | | Collectible | UGC Limited | | Limited | Roblox Limited Unique |

参数

返回

这个函数为指定的服装返回服装详细信息。它接受一个参数：服装的ID。

数据以下格式返回：

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

参数

返回

此函数为 Players.LocalPlayer 返回装扮数据。这将与 Players:GetHumanoidDescriptionFromOutfitId() 使用，用于更新玩家角色到装扮。与此相关的权限也取决于 AvatarEditorService:PromptAllowInventoryReadAccess() 被接受用户。

返回的表包括以下字段：

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

<tbody>
  <tr>
    <td>身份证</td>
    <td>int</td>

    <td />
  </tr>

  <tr>
    <td>名称</td>
    <td>字符串</td>

    <td />
  </tr>

  <tr>
    <td>可编辑</td>
    <td>boolean</td>

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

参数

返回

根据指定的 Enum.AssetType 和资产 id 返回列表推荐资产。 使用此示例来收集类似资产的列表。 查看下面的代码示例获取更多信息。

数据以下格式：

[
    {
      "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
      }
    }
]

参数

返回

local AvatarEditorService = game:GetService("AvatarEditorService")

local assets = AvatarEditorService:GetRecommendedAssets(Enum.AvatarAssetType.Hat, 9255093)

for _, asset in ipairs(assets) do
	print(asset.Item.Name)
end

此函数返回一个给定束组 ID 的推荐列表。

数据以下格式：

[
    {
      "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
        }
      }
    }
]

参数

返回

此函数返回一个 CatalogPages 对象，包含给定搜索的结果。

返回的数据格式如下：

[
    {
      "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
    }
]

参数

返回

当 AvatarEditorService:PromptAllowInventoryReadAccess() 提示被用户回应时，此事件会触发。它只能返回成功或权限被拒绝的 enum 状态，因为它不会执行任何可能导致失败的网络请求。

参数

此事件发生在提示保存服装操作完成后。它给出一个状态 enum 表示是否成功、失败或被用户授权。

参数

提示删除服装操作完成时触发。它给出一个状态 enum 表示是否成功、是否失败或是否被用户授权。

参数

提示重命名服装操作完成时触发。它给出一个状态 enum 表示是否成功、是否失败或是否被用户授权。

参数

这个事件发生 when the AvatarEditorService:PromptSaveAvatar() 操作完成时。它给出一个状态 enum 表示是否成功、失败或被用户授权。

参数

触发Class.AvatarEditorService:PromptSetFavorite()操作完成时。它给出一个状态enum，表示是否成功、失败或由用户授权。

参数

触发Class.AvatarEditorService:PromptUpdateOutfit()操作完成时。它给出一个状态enum，表示是否成功、是否失败或是否被用户授权。

参数