AvatarEditorService

Metody

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():()
Powiadamia Players.LocalPlayer, aby umożliwić programiście odczytanie przedmiotów, które użytkownik ma w swoim ekwipunku i innych informacji związanych z edytorem awatara.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Wymaga od Players.LocalPlayer zapisania podanych HumanoidDescription jako stroju.
PromptDeleteOutfit(outfitId : number):()
Wymaga od Players.LocalPlayer usunięcia podanego stroju.
PromptRenameOutfit(outfitId : number):()
Wymaga od Players.LocalPlayer zmiany nazwy podanego stroju.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Wymaga od Players.LocalPlayer aktualizacji awatara na podstawie podanych HumanoidDescription i Enum.RigType R6 lub R15.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : boolean):()
Pyta Players.LocalPlayer o ulubienie lub nieulubienie danego zasobu lub pakietu.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Wymaga od Players.LocalPlayer aktualizacji podanego stroju.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Wynik
Używany do zastosowania domyślnej odzieży do HumanoidDescription w razie potrzeby.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Wynik
GetAvatarRules():Dictionary
Wynik
Zwraca zasady awatara platformy dla rzeczy takich jak skalowanie, domyślne koszule i spodnie, liczba noszonych aktywów.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Wynik
Zdobywa szczegóły przedmiotu dla listy przedmiotów naraz
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):boolean
Wynik
Wyświetla, jeśli Players.LocalPlayer dodał ulubiony pakiet lub zasób.
GetInventory(assetTypes : Array):InventoryPages
Wynik
Zwraca obiekt InventoryPages z informacjami o posiadanych przedmiotach w ekwipunku użytkownika z danymi typami zasobów awatara.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Wynik
Zwraca szczegóły przedmiotu dla podanego przedmiotu.
GetOutfitDetails(outfitId : number):Dictionary
Wynik
Zwraca szczegóły stroju dla podanego stroju.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Wynik
Zwraca dane o stroju dla Players.LocalPlayer.
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Wynik
Zwraca listę zalecanych zasobów w oparciu o określone Enum.AssetType i ID zasoby.
GetRecommendedBundles(bundleId : number):Array
Wynik
Zwraca listę zalecanych pakietów dla danego ID pakietu.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Wynik
Zwraca obiekt CatalogPages zawierający wynik wyszukiwaćpodanych.

Zdarzenia

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Wystrzeliwuje, gdy monit o AvatarEditorService:PromptAllowInventoryReadAccess() odpowiada użytkownik.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
Wybucha, gdy operacja PromptSaveOutfit zostanie zakończona.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Wybucha, gdy operacja PromptDeleteOutfit zostanie zakończona.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Wybucha, gdy operacja PromptRenameOutfit zostanie zakończona.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Wypala się, gdy operacja AvatarEditorService:PromptSaveAvatar() zostanie zakończona.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Wypala się, gdy operacja AvatarEditorService:PromptSetFavorite() zostanie zakończona.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Wypala się, gdy operacja AvatarEditorService:PromptUpdateOutfit() zostanie zakończona.

Właściwości

Metody

GetAccessoryType

Enum.AccessoryType

Parametry

avatarAssetType: Enum.AvatarAssetType

Wartość domyślna: ""

Zwroty

Enum.AccessoryType

PromptAllowInventoryReadAccess

()

Powiadamia Players.LocalPlayer, aby umożliwić programiście odczytanie przedmiotów, które użytkownik ma w swoim ekwipunku i innych informacji związanych z edytorem awatara.Powiadomienie musi zostać potwierdzone przez użytkownika, aby programista mógł używać AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() i AvatarEditorService:GetFavorite() .Uprawnienie nie utrzymuje się między sesjami.

Zwroty

()

PromptCreateOutfit

()

Wymaga od Players.LocalPlayer zapisania podanych HumanoidDescription jako strój. Nie zwraca wyniku. Wynik można odzyskać poprzez wysłuchanie wydarzenia AvatarEditorService.PromptCreateOutfitCompleted.

Parametry

outfit: HumanoidDescription

The Outfit które gracz zostanie poproszony o utworzenie.

Wartość domyślna: ""

rigType: Enum.HumanoidRigType

The Enum.RigType że strój zostanie utworzony, jeśli gracz potwierdzi monit o wypełnienie.

Wartość domyślna: ""

Zwroty

()

PromptDeleteOutfit

()

Wymaga od Players.LocalPlayer usunięcia podanego stroju. Nie zwraca wyniku. Wynik można odzyskać, słuchając wydarzenia AvatarEditorService.PromptDeleteOutfitCompleted.

Parametry

outfitId: number

ID stroju do usuwać.

Wartość domyślna: ""

Zwroty

()

PromptRenameOutfit

()

Wymaga od Players.LocalPlayer zmiany nazwy podanego stroju. Nie zwraca wyniku. Wynik można odzyskać, słuchając wydarzenia AvatarEditorService.PromptRenameOutfitCompleted.

Parametry

outfitId: number

Id stroju stroju do zmiany nazwy.

Wartość domyślna: ""

Zwroty

()

PromptSaveAvatar

()

Funkcja ta wymaga od Players.LocalPlayer aktualizacji awatara na podstawie podanych HumanoidDescription i Enum.RigType (R6 lub R15).Nie zwraca się i może uzyskać wynik, słuchając wydarzenia PromptSaveAvatarCompleted.Jest to podobne do sposobu działania innych komunikatów, takich jak PromptPurchase.

Parametry

humanoidDescription: HumanoidDescription

Podany HumanoidDescription jest poproszony o zapisanie.

Wartość domyślna: ""

rigType: Enum.HumanoidRigType

The Enum.RigType że awatar zostanie zapisany, jeśli gracz potwierdzi monit o potwierdzenie.

Wartość domyślna: ""

Zwroty

()

PromptSetFavorite

()

Funkcja ta poprosi Players.LocalPlayer o ulubienie lub odulubienie danego zasobu lub pakietu.

Parametry

itemId: number

Identyfikator przedmiotu, który ma być dodany do dodawać do ulubionych.

Wartość domyślna: ""

itemType: Enum.AvatarItemType

Typ przedmiotu, który ma być dodany do dodawać do ulubionych.

Wartość domyślna: ""

shouldFavorite: boolean

Wartość domyślna: ""

Zwroty

()

PromptUpdateOutfit

()

Wymaga od Players.LocalPlayer aktualizacji podanego stroju z podaną HumanoidDescription.

Parametry

outfitId: number

Id stroju stroju do aktualizacja.

Wartość domyślna: ""

updatedOutfit: HumanoidDescription

Opis humanoida, który reprezentuje nowe dane o stroju.

Wartość domyślna: ""

rigType: Enum.HumanoidRigType

Typ HumanoidRig, aby zaktualizować strój.

Wartość domyślna: ""

Zwroty

()

CheckApplyDefaultClothing

Wynik

Zwraca nowy HumanoidDescription z właściwościami koszul i spodni zaktualizowanymi, jeśli jest to konieczne. Zwraca nil jeśli domyślna odzież nie była potrzebna.

Domyślna odzież jest niezbędna, jeśli opis Humanoida nie ma obecnie wyposażonej koszuli i spodni oraz kolory ciała są zbyt podobne.

Parametry

humanoidDescription: HumanoidDescription

Opis ludzkiegooida, aby sprawdzić, czy wymagana jest domyślna odzież.

Wartość domyślna: ""

Zwroty

Zwraca opis humanoida, jeśli domyślna odzież była konieczna. W przeciwnym razie zwraca nil .

ConformToAvatarRules

Wynik

Parametry

humanoidDescription: HumanoidDescription

Wartość domyślna: ""

Zwroty

GetAvatarRules

Wynik

Funkcja ta zwraca zasady awatara platformy dla rzeczy takich jak skalowanie, domyślne koszule i spodnie, liczba noszonych aktywów itp.

Zwrócony stół zawiera następujące pola:


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

Zwroty

Słownik zawierający zasady Avatara platformy dla rzeczy takich jak skalowanie, domyślne koszule i spodnie, liczbę noszonych aktywów, itp.Zobacz przykład zwrotu w główym opisie powyżej.

GetBatchItemDetails

Wynik

Zdobywa szczegóły przedmiotu dla listy przedmiotów narazBardziej wydajny niż AvatarEditorService:GetItemDetails, jeśli musisz uzyskać wszystkie szczegóły przedmiotu z listy.

Parametry

itemIds: Array

Lista identyfikatorów przedmiotów do uzyskania szczegółów.

Wartość domyślna: ""

itemType: Enum.AvatarItemType

Typ dostarczonych identyfikatorów przedmiotów.

Wartość domyślna: ""

Zwroty

Zwraca tablicę szczegółów przedmiotu z następującymi polami:


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

boolean

Wynik

Funkcja ta zwraca, jeśli Players.LocalPlayer preferuje dany pakiet lub zasób.

Parametry

itemId: number

ID określonego zasobu lub pakietu.

Wartość domyślna: ""

itemType: Enum.AvatarItemType

The Enum.AvatarItemType z określonego zasobu lub pakietu.

Wartość domyślna: ""

Zwroty

boolean

Czy LocalPlayer ma ulubione pakiet lub zasób podany.

GetInventory

InventoryPages

Wynik

Zwraca obiekt InventoryPages z informacjami o posiadanych przedmiotach w ekwipunku użytkownika za pomocą podanego AvatarAssetTypes.

Zwrócony stół zawiera następujące pola:


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

Parametry

assetTypes: Array

The Enum.AvatarAssetType które mogą zostać sprawdzone w wyposażeniegracza.

Wartość domyślna: ""

Zwroty

InventoryPages

GetItemDetails

Wynik

Funkcja ta zwraca szczegóły przedmiotu dla podanego przedmiotu.Przyjmuje dwa parametry - pierwszy wskazujący na ID przedmiotu, który jest odzyskiwany, a drugi wskazujący na jego Enum.ItemType.

Dane powracające w formacie:


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

Aby zapytać o ograniczone lub nieograniczone zasoby, użyj następujących itemRestrictions wartości:

Parametry

itemId: number

ID przedmiotu, których szczegóły są odzyskiwane.

Wartość domyślna: ""

itemType: Enum.AvatarItemType

Wartość enum wskazująca rodzaj przedmiotu, których szczegóły są odzyskiwane.

Wartość domyślna: ""

Zwroty

Tabela zawierająca informacje o przedmiocie dla odzyskanych przedmiotów. Zobacz powyżej, jak wygląda przykładowa tabela.

GetOutfitDetails

Wynik

Funkcja ta zwraca szczegóły stroju dla podanego stroju. Akceptuje jeden parametr: ID stroju.

Dane powracają w następującym formacie:


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

Parametry

outfitId: number

ID stroju, których szczegóły są odzyskiwane.

Wartość domyślna: ""

Zwroty

Tabela zawierająca informacje o stroju dla odzyskanych strojów. Zobacz powyżej, jak wygląda przykładowa tabela.

GetOutfits

OutfitPages

Wynik

Funkcja ta zwraca dane o stroju dla Players.LocalPlayer.Zostanie to wykorzystane z Players:GetHumanoidDescriptionFromOutfitId() w celu aktualizacji postaci gracza do stroju.Dostęp do tego również zależeć będzie od AvatarEditorService:PromptAllowInventoryReadAccess() akceptacji przez użytkownika.

Zwrócony stół zawiera następujące pola:


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


<th>wpisywać</th>

    <th>Opis</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>identyfikator</td><td>int</td>

    <td />
  </tr>

  <tr>
    <td>nazwa</td><td>ciąg</td>

    <td />
  </tr>

  <tr>
    <td>jestEdytowalny</td><td>boolean</td>

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

Nazwa

Parametry

outfitSource: Enum.OutfitSource

Wartość domyślna: "All"

outfitType: Enum.OutfitType

Wartość domyślna: "All"

Zwroty

OutfitPages

GetRecommendedAssets

Wynik

Zwraca listę zalecanych zasobów w oparciu o określone Enum.AssetType i ID zasoby.Użyj tego, aby zebrać listę podobnych zasobów do zasobu dostarczonego.Spójrz na przykład kodu poniżej, aby uzyskać więcej informacji o możliwych zastosowaniach tej funkcji.

Dane są w formacie:


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

Parametry

assetType: Enum.AvatarAssetType

Typ rekomendacji dotyczących aktywów, aby odzyskać rekomendacje.Dotyczy tylko odpowiedzi, gdy rekomendacje oparte na przedmiotach nie istnieją dla danego contextAssetId.

Wartość domyślna: ""

contextAssetId: number

Identyfikator aktywa z typem pasującym do dostarczonego typu aktywa używanego do kontekstu podczas pobierania rekomendacji.

Wartość domyślna: 0

Zwroty

Lista zaleceń opartych na podanych Enum.AssetType .

Przykłady kodu

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

Wynik

Funkcja ta zwraca listę zalecanych pakietów dla danego ID pakietu.

Dane są w formacie:


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

Parametry

bundleId: number

Lista zalecanych pakietów.

Wartość domyślna: ""

Zwroty

ID pakietu, za który zostaną zwrócone zalecane pakiety.

SearchCatalog

CatalogPages

Wynik

Funkcja ta zwraca obiekt CatalogPages zawierający wynik wyszukiwaćpodanych.

Powracające dane mają format:


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

Parametry

searchParameters: CatalogSearchParams

Obiekt zawierający parametry używane do wyszukiwać.

Wartość domyślna: ""

Zwroty

CatalogPages

Zdarzenia

PromptAllowInventoryReadAccessCompleted

To wydarzenie wystrzeliwuje się, gdy polecenie AvatarEditorService:PromptAllowInventoryReadAccess() jest odpowiedziane przez użytkownika.Może tylko zwrócić statusy Success lub PermissionDenied enum, ponieważ nie wykonuje żadnych żądań sieciowych, które mogłyby zawieść.

Parametry

Wynik polecenia.

PromptCreateOutfitCompleted

To wydarzenie wystrzeliwuje się, gdy operacja SaveOutfitPrompt zostanie zakończona.Daje status enum, który wskazuje, czy monit o powodzenie powiodła się, nie powiodła się lub nie została przyznana przez użytkownika zgoda.

Parametry

Wynik polecenia.

failureType: Variant

PromptDeleteOutfitCompleted

Wybucha, gdy operacja PromptDeleteOutfit zostanie zakończona.Daje status enum, który wskazuje, czy monit o powodzenie powiodła się, nie powiodła się lub nie została przyznana przez użytkownika zgoda.

Parametry

Wynik polecenia.

PromptRenameOutfitCompleted

Wybucha, gdy operacja PromptRenameOutfit zostanie zakończona.Daje status enum, który wskazuje, czy monit o powodzenie powiodła się, nie powiodła się lub nie została przyznana przez użytkownika zgoda.

Parametry

Wynik polecenia.

PromptSaveAvatarCompleted

To wydarzenie wystrzeliwuje, gdy operacja AvatarEditorService:PromptSaveAvatar() zostanie zakończona.Daje status enum, który wskazuje, czy monit o powodzenie powiodła się, nie powiodła się lub nie została przyznana przez użytkownika zgoda.

Parametry

Wynik polecenia.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Wypala się, gdy operacja AvatarEditorService:PromptSetFavorite() zostanie zakończona.Daje status enum, który wskazuje, czy monit o powodzenie powiodła się, nie powiodła się lub nie została przyznana przez użytkownika zgoda.

Parametry

Wynik polecenia.

PromptUpdateOutfitCompleted

Wypala się, gdy operacja AvatarEditorService:PromptUpdateOutfit() zostanie zakończona.Daje status enum, który wskazuje, czy monit o powodzenie powiodła się, nie powiodła się lub nie została przyznana przez użytkownika zgoda.

Parametry

Wynik polecenia.