AvatarEditorService

Pokaż przestarzałe

*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

Brak możliwości tworzenia
Usługa
Bez replikacji

AvatarEditorService to usługa służąca do wsparcia edytorów awatarów. Dostarcza metody zmiany awatara gracza, wymaga informacji o wyposażenieużytkownika i wymaga informacji o katalogu.

For more information regarding the Edytor awatara, see Service Avatar Editora .

Przyspieszanie

Poniższe końce AvatarEditorService mają doświadczony poziom ograniczania:

Dla każdego doświadczenia, ten pulsator pozwala na wysyłanie do 100 prośb na sekundę do tych AvatarEditorService końców, niezależnie od liczby serwerów lub liczby użytkowników. Przekroczenie tych limitów powoduje powstanie błędu 429 Too Many Requests.

Jeśli znajdziesz, że twoje doświadczenie wymaga dostosowania do tego spowolnienia, możesz złożyć żądanie funkcji.

Podsumowanie

Metody

Zdarzenia

Właściwości

Metody

GetAccessoryType

Parametry

avatarAssetType: Enum.AvatarAssetType

Zwroty

PromptAllowInventoryReadAccess

void

Prosi Players.LocalPlayer, aby umożliwić rozwinięcia programu rozwoju dla programistów, aby czytać co przedmioty użytkownik ma w ekwipunku i inne informacje o edytorze awatarów. Prompt musi być potwierdzony przez użytkownika dla programu rozwo


Zwroty

void

PromptCreateOutfit

void

Prosi Players.LocalPlayer o zapisanie danej HumanoidDescription jako strój. Nie daje wyniku. Rezultat można odzyskać poprzez słuchanie wydarzenia AvatarEditorService.PromptCreateOutfitCompleted.

Parametry

Outfit, którego gracz będzie proszony o stworzenie.

ENSEM.RIGTYPE, który stworzy strój, jeśli gracz potwierdzi prośbę.


Zwroty

void

PromptDeleteOutfit

void

Prosi Players.LocalPlayer, aby usunąć podany strój. Nie daje wyniku. Rezultat można odzyskać poprzez słuchanie wydarzenia AvatarEditorService.PromptDeleteOutfitCompleted.

Parametry

outfitId: number

Id strzymać strój do usuwać.


Zwroty

void

PromptRenameOutfit

void

Prosi Players.LocalPlayer, aby zmienił nazwę udzieloną odzieży. Nie daje wyniku. Wynik można uzyskać poprzez słuchanie wydarzenia AvatarEditorService.PromptRenameOutfitCompleted.

Parametry

outfitId: number

Id strój do zmiany nazwy.


Zwroty

void

PromptSaveAvatar

void

Funkcja ta prosi Players.LocalPlayer aby zaktualizować ich awatar na podstawie danych HumanoidDescription i Enum.RigType (R6 lub R15). Nie wykonuje i można uzyskać wynik poprzez słuchanie wydarzenia 1> Class.HumanoidDescription1> i 4> Class.Rig

Parametry

humanoidDescription: HumanoidDescription

Podany HumanoidDescription proszony o zapisanie.

ENSEGURANCE.RIGTYPE Zapisywany awatar zostanie, jeśli gracz potwierdzi prośbę.


Zwroty

void

PromptSetFavorite

void

Ta funkcja prosi Players.LocalPlayer o ulubienie lub odlubienie danej zasoby lub pakiet.

Parametry

itemId: number

Id pozycji wskazanej jako ulubiony.

Typ przedmiotu do dodawać do ulubionych.

shouldFavorite: bool

Zwroty

void

PromptUpdateOutfit

void

Prosi Players.LocalPlayer o aktualizację udzieloną odzieży zgodnie z opisem ludzkiego kształtu.

Parametry

outfitId: number

Id strój do aktualizacja.

updatedOutfit: HumanoidDescription

Opis Humanoid, który przedstawia nowe dane o odzieży.

The HumanoidRigType do aktualizacji strój.


Zwroty

void

CheckApplyDefaultClothing

Wynik

Powoduje powrót nowej HumanoidDescription z aktualizowanymi właściwościami koszuli i spodni, jeśli to konieczne. Wynika nil, jeśli ubrania domyślne nie były wymagane.

Domyślna odzież jest wymagana, jeśli opis Humanoid nie ma obecnie używanych koszul i spodni i kolory ciała są zbyt podobne.

Parametry

humanoidDescription: HumanoidDescription

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


Zwroty

Zwraca opis ludzkiego jeśli ubrania byłyby potrzebne. W innym przypadku zwraca nil.

ConformToAvatarRules

Wynik

Parametry

humanoidDescription: HumanoidDescription

Zwroty

GetAvatarRules

Wynik

Funkcja ta zwraca wszystkie zasady dla witryny Avatar dla rzeczy takich jak skalowanie, domyślne koszule i spodnie, liczba dostępnych zasobów do użytku, itp.

Zwrócony tabela 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 platformy Avatar dla rzeczy takich jak skalowanie, domyślne koszule i spodnie, liczba miennych zasobów, itp. Zobacz przykładowy zwrot w głównym opisie powyżej.

GetBatchItemDetails

Wynik

Dostarcza szczegóły przedmiotu dla listy przedmiotów jednocześnie. Bardziej wydajne niż AvatarEditorService:GetItemDetails, jeśli musisz uzyskać wszystkie szczegóły przedmiotu w jednej liście.

Parametry

itemIds: Array

Lista identyfikatorów przedmiotów, aby uzyskać szczegóły.

Typ dostarczonych identyfikatorów przedmiotu.


Zwroty

Wyświetla arkusz 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

Wynik

Funkcja ta zwraca, jeśli Players.LocalPlayer ulubił dany zestaw lub zasób.

Parametry

itemId: number

Identyfikator zasobu lub pakietokreślonego.

Encyklopedia awatarów of the specified asset or pakiet.


Zwroty

Czy LocalPlayer ulubił dany zestaw lub zasoby.

GetInventory

Wynik

Zwraca obiekt InventoryPages z informacjami o posiadanych przedmiotach w ekwipunku użytkownika z AvatarAssetTypes .

Zwrócony tabela zawiera następujące pola:


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

Parametry

assetTypes: Array

Menu.AvatarAssetType, które można sprawdzić w wyposażeniegracza.


Zwroty

GetItemDetails

Wynik

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

Dane zwrócone 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 uzyskać ograniczone lub nieograniczone zasoby, użyj następujących wartości itemRestrictions :

| itemRestrictions | Limitowany lub Nieograniczony | | :--------------: | :-------------------: | | empty | Unlimited | | Collectible | UGC Limitowany | | Limited | Roblox Limitowany Unique |

Parametry

itemId: number

Identyfikator przedmiotu, którego szczegóły są odczytywane.

Wartość zmiennej listy określającej typ przedmiotu, który jest odczytywany.


Zwroty

Tabela zawierająca informacje o poziomie dla odczytanego przedmiotu. Zobacz powyżej dla przykładowej tabeli.

GetOutfitDetails

Wynik

Funkcja ta zwraca szczegóły strój dla podanego strój. Przyjmuje jeden parametr: ID strój.

Wyświetlenie danych w następującej formie:


{
"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 strój, który jest odczytywany.


Zwroty

Tabela zawierająca informacje o odzyskanej odzieży. Zobacz powyżej, aby uzyskać przykładową tabelę.

GetOutfits

Wynik

Funkcja ta powoduje, że ​​dane ostrzału są przesłane do Players.LocalPlayer . Będzie to używane z Players:GetHumanoidDescriptionFromOutfitId() , aby aktualizować postać gracza do strzału. Dostęp do tego będzie również zależał od AvatarEditorService:PromptAllowInventoryReadAccess() przyjmowanego przez

Zwrócony tabela zawiera następujące pola:


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

<tbody>
<tr>
<td>identyfikator</td>
<td>int</td>
<td />
</tr>
<tr>
<td>imię</td>
<td>ciąg</td>
<td />
</tr>
<tr>
<td>jestEdytalny</td>
<td>boolean</td>
<td />
</tr>
</tbody>
NazwawpisywaćOpis

Parametry

outfitSource: Enum.OutfitSource
Wartość domyślna: "All"
outfitType: Enum.OutfitType
Wartość domyślna: "All"

Zwroty

GetRecommendedAssets

Wynik

Wyświetla listę zalecanych zasobów w oparciu o dany Enum.AssetType i ID zasobu. Użyj tego, aby zebrać listę podobnych zasobów do zasobu dostarczonego. Spójrz na przykładowy kod poniżej dla więcej informacji o możliwych użyciach dla funkcji tego.

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

Typ rekomendacji zasobów do odzyskania rekomendacji. Dotyczy tylko odpowiedzi, gdy nie istnieją zasobowe rekomendacje dla podanego contextAssetId .

contextAssetId: number

Identyfikator zasobu z typem pasującym do podanych typów zasobów używanych do kontekstu podczas odszukiwania rekomendacji.

Wartość domyślna: 0

Zwroty

Lista zaleceń oparta na podanym Enum.AssetType .

Przykłady kodu

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 zestawów dla określonego identyfikatora zestawu.

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 zestawów.


Zwroty

ID zestawu, do którego zostaną zwrócone rekomendowane zestawy.

SearchCatalog

Wynik

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

Wyemesłane 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ć.


Zwroty

Zdarzenia

PromptAllowInventoryReadAccessCompleted

Ten wąż się łączy, gdy użytkownik odpowiada na wąż AvatarEditorService:PromptAllowInventoryReadAccess(), który jest odpowiedziany na zapytanie enum za pośrednictwem EnumerateAvatarPromptResult. Może on tylko zwrócić status 1>Sucess lub PermissionDenied1>, ponieważ nie wykonuje żadnych wążów webowych, które mogłyby się zepsuć.

Parametry

Rezultat weryfikacji pola.


PromptCreateOutfitCompleted

Ten ewent zostanie wywołany, gdy zakończona zostanie operacja PromptSaveOutfit. Daje status enum wskazujący, czy prośba zakończyła się sukcesem, nie powiodła się lub nie została przyznana przez użytkownika.

Parametry

Rezultat weryfikacji pola.

failureType: Variant

PromptDeleteOutfitCompleted

Wyst?puje, gdy operacja usuwania zapisu ubrania zako?czona jest enum, co wskazuje, czy zapis zako?czony, nie powiod? si? lub nie by? przyznany przez u?ytkownika.

Parametry

Rezultat weryfikacji pola.


PromptRenameOutfitCompleted

Wyst?puje, gdy operacja PromptRenameOutfit zostanie zako?czona. Daje status enum, który wskazuje, czy prośba zako?czy?a si?. nie powiod?a si?. lub nie by? przyznany przez u?ytkownika.

Parametry

Rezultat weryfikacji pola.


PromptSaveAvatarCompleted

Ten wąż pojawia się, gdy operacja AvatarEditorService:PromptSaveAvatar() jest zakończona. Daje status enum, który wskazuje, czy prośba zakończyła się, nie powiodła się lub nie została przyznana przez użytkownika.

Parametry

Rezultat weryfikacji pola.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Wykonuje się po zakończeniu operacji AvatarEditorService:PromptSetFavorite(), która zwraca status enum wskazujący, czy prośba zakończyła się sukcesem, nie powiodła się lub nie została przyznana zgoda przez użytkownika.

Parametry

Rezultat weryfikacji pola.


PromptUpdateOutfitCompleted

Wykonuje się po zakończeniu operacji AvatarEditorService:PromptUpdateOutfit(), która zwraca status enum wskazujący, czy prośba zakończyła się sukcesem, nie powiodła się lub nie została przyznana zgoda przez użytkownika.

Parametry

Rezultat weryfikacji pola.