AvatarEditorService

參數

返回

提示 Players.LocalPlayer 以允許開發人員閱取使用者的道具欄和其他虛擬人偶編輯器相關資訊。提示需要由使用者確認才能使用 AvatarEditorService:GetInventory() ，

返回

提示 Players.LocalPlayer 儲存所提供的 HumanoidDescription 作為服裝。不會產生。結果可以通過聆聽 AvatarEditorService.PromptCreateOutfitCompleted 事件來取回。

參數

返回

提示 Players.LocalPlayer 刪除所提供的服裝。不會產生。結果可以通過聆聽 AvatarEditorService.PromptDeleteOutfitCompleted 事件來取回。

參數

返回

提示 Players.LocalPlayer 重新命名所提供的服裝。 不會產生。 結果可以通過聆聽 AvatarEditorService.PromptRenameOutfitCompleted 事件來取回。

參數

返回

此功能提示 Players.LocalPlayer 更新他們的虛擬人偶基於所提供的 HumanoidDescription 和 Enum.RigType (R6 或 R15)。不會產生結果並且可以通過聆聽提示儲存完成事件來取得結果。這與其他提示，

參數

返回

此功能提示 Players.LocalPlayer 要喜歡或取消喜歡指定資產或組合包。

參數

返回

提示 Players.LocalPlayer 更新指定服裝以反映指定人形描述。

參數

返回

如有必要，會返回新的 HumanoidDescription 以 Shirt 和 Pants 屬性更新。如果沒有預設服裝，則會返回零。

如果人形描述沒有上衣和褲子，則需要預設服裝，因為身體顏色太相似。

參數

返回

參數

返回

此功能返回平台 Avatar 規則，例如縮放、預設上衣和褲子、可穿戴的資產數量等。

返回的表包括以下字段：

{
  "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 個對象，包含用戶存取用戶道具欄中所有擁有物品的資訊。

返回的表包括以下字段：

[
    {
      "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 | 無限 | | Collectible | UGC 限定 | | Limited | Roblox 無限 | | 1> LimitedUnique1> | Roblox 無限 | | 4> Collectible

參數

返回

此函數為指定服裝的服裝細節返回。它接受一個參數：服裝的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>id</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": 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 指示提示成功、失敗或沒有授權由用戶授權。

參數

此事件發生當 Class.AvatarEditorService:PromptSaveAvatar() 操作完成時。它讓狀態 Ennum.AvatarPromptResult|enuム 指示是否成功、失敗或沒有給予權限給予用戶。

參數

在 Class.AvatarEditorService:PromptSetFavorite() 操作完成時發射。它會提供狀態 Ennum.AvatarPromptResult|enuム，表示是否成功、失敗或沒有給予權限。

參數

在 AvatarEditorService:PromptUpdateOutfit() 操作完成時發射。它讓狀態 enum 表示是否成功、失敗或沒有給予權限。

參數