AvatarEditorService

Parâmetros

Devolução

Solicita ao Players.LocalPlayer para permitir que o desenvolvedor leia quais itens o usuário tem em seu inventário e outras informações relacionadas ao editor de avatar.O prompt precisa ser confirmado pelo usuário para o desenvolvedor usar AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() e AvatarEditorService:GetFavorite() .A permissão não persiste entre sessões.

Devolução

Solicita ao Players.LocalPlayer para salvar o dado HumanoidDescription como uma roupa. Não retorna. O resultado pode ser recuperado ao ouvir o evento AvatarEditorService.PromptCreateOutfitCompleted.

Parâmetros

Devolução

Solicita ao Players.LocalPlayer para excluir o conjunto dado. Não produz resultado. O resultado pode ser recuperado ao ouvir o evento AvatarEditorService.PromptDeleteOutfitCompleted.

Parâmetros

Devolução

Solicita ao Players.LocalPlayer que renomeie o traje dado. Não produz resultado. O resultado pode ser recuperado ao ouvir o evento AvatarEditorService.PromptRenameOutfitCompleted.

Parâmetros

Devolução

Essa função solicita que o Players.LocalPlayer atualize seu avatar com base no dado HumanoidDescription e Enum.RigType (R6 ou R15).Não retorna e pode obter o resultado ao ouvir o evento PromptSaveAvatarCompleted.Isso é semelhante ao modo como outros prompts, como o PromptPurchase, funcionam.

Parâmetros

Devolução

Essa função solicita que o Players.LocalPlayer adicione ou remova o recurso ou pacote dado como favorito ou desfavorito.

Parâmetros

Devolução

Solicita ao Players.LocalPlayer para atualizar o traje dado com a Descrição Humanoide dada.

Parâmetros

Devolução

Retorna um novo HumanoidDescription com as propriedades Camisa e Calças atualizadas se necessário. Retorna nil se a roupa padrão não fosse necessária.

A roupa padrão é necessária se a Descrição Humanoide não tiver atualmente Camisa e Calças equipadas e as cores do corpo forem muito semelhantes.

Parâmetros

Devolução

Parâmetros

Devolução

Essa função retorna as regras do Avatar da plataforma para coisas como escalonamento, camisas e calças padrão, número de recursos vestíveis, etc.

A tabela retornada inclui os seguintes campos:

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

Devolução

Obtém os detalhes do item para uma lista de itens de uma vez.Mais eficiente que AvatarEditorService:GetItemDetails se você precisar obter todos os detalhes do item de uma lista.

Parâmetros

Devolução

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

Essa função retorna se o Players.LocalPlayer favoreceu o pacote ou ativodado.

Parâmetros

Devolução

Retorna um objeto InventoryPages com informações sobre itens possuídos no inventário dos usuários com o dado AvatarAssetTypes.

A tabela retornada inclui os seguintes campos:

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

Parâmetros

Devolução

Essa função retorna os detalhes do item para o item dado.Ele aceita dois parâmetros - o primeiro indicando o ID do item a ser recuperado e o segundo indicando seu Enum.ItemType .

Dados retornados no formato:

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

Para solicitar recursos limitados ou ilimitados, use os seguintes valores itemRestrictions :

| itemRestrictions | Limitado ou Ilimitado | | :--------------: | :-------------------: | | empty | Ilimitado | | Collectible | UGC Limitado | | Limited | Roblox Limitado Único | | LimitedUnique | Roblox Limitado Único |

Parâmetros

Devolução

Essa função retorna os detalhes da roupa para a roupa dada. Ela aceita um parâmetro: o ID da roupa.

Retornos de dados no seguinte formato:

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

Parâmetros

Devolução

Essa função retorna dados de roupa para o Players.LocalPlayer.Isso seria usado com Players:GetHumanoidDescriptionFromOutfitId() para atualizar o personagem dos jogadores para a roupa.O acesso a isso também dependeria de AvatarEditorService:PromptAllowInventoryReadAccess().

A tabela retornada inclui os seguintes campos:

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

<th>digitar</th>

    <th>Descrição</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>id</td><td>int</td>

    <td />
  </tr>

  <tr>
    <td>nome</td><td>string</td>

    <td />
  </tr>

  <tr>
    <td>éEditável</td><td>booleano</td>

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

Parâmetros

Devolução

Retorna uma lista de recursos recomendados com base em um determinado Enum.AssetType e ID de recurso.Use isso para reunir uma lista de recursos semelhantes ao recurso fornecido.Dê uma olhada no exemplo de código abaixo para mais informações sobre possíveis usos para essa função.

Os dados estão no formato:

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

Parâmetros

Devolução

local AvatarEditorService = game:GetService("AvatarEditorService")

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

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

Essa função retorna uma lista de pacotes recomendados para um determinado ID de pacote.

Os dados estão no formato:

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

Parâmetros

Devolução

Essa função retorna um objeto CatalogPages que contém o resultado da pesquisardada.

Os dados retornados têm o formato:

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

Parâmetros

Devolução

Este evento é disparado quando o AvatarEditorService:PromptAllowInventoryReadAccess() prompt é respondido pelo usuário.Ele só pode retornar os status de Sucesso ou Permissão Negada enum pois não realiza nenhuma solicitação web que possa falhar.

Parâmetros

Este evento é disparado quando a operação Salvar Conjunto Rápido é concluída.Ele dá um status enum indicando se o prompt foi bem-sucedido, falhou ou a permissão não foi concedida pelo usuário.

Parâmetros

Incêndios quando a operação PromptDeleteOutfit é concluída.Ele dá um status enum indicando se o prompt foi bem-sucedido, falhou ou a permissão não foi concedida pelo usuário.

Parâmetros

Incêndios quando a operação PromptRenameOutfit é concluída.Ele dá um status enum indicando se o prompt foi bem-sucedido, falhou ou a permissão não foi concedida pelo usuário.

Parâmetros

Este evento é disparado quando a operação AvatarEditorService:PromptSaveAvatar() é concluída.Ele dá um status enum indicando se o prompt foi bem-sucedido, falhou ou a permissão não foi concedida pelo usuário.

Parâmetros

Incêndios quando a operação AvatarEditorService:PromptSetFavorite() é concluída.Ele dá um status enum indicando se o prompt foi bem-sucedido, falhou ou a permissão não foi concedida pelo usuário.

Parâmetros

Incêndios quando a operação AvatarEditorService:PromptUpdateOutfit() é concluída.Ele dá um status enum indicando se o prompt foi bem-sucedido, falhou ou a permissão não foi concedida pelo usuário.

Parâmetros