AvatarEditorService

Visualizza obsoleti

*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.

Non costruibile
Assistenza
Non Replicato

AvatarEditorService è un servizio per supportare gli editor di Avatar dei sviluppatori.Fornisce metodi per modificare l'avatar della piattaforma del giocatore, richiedere informazioni sull'inventario di un utente e richiedere informazioni sul catalogo.

Per ulteriori informazioni sull'Editor di Avatar, vedi Servizio Editor di Avatar.

Accelerazione

I seguenti endpoint su AvatarEditorService hanno un ridimensionamento a livello di esperienza:

Per ogni esperienza, questo throttling ti consente di inviare fino a 100 richieste al secondo a questi AvatarEditorService, indipendentemente dal numero di server o dal conteggio utente.Superare questi limiti restituisce un errore 429 Too Many Requests .

Se trovi che la tua esperienza richieda un'aggiustamento a questo throttling, puoi inviare una richiesta di funzione.

Sommario

Metodi

Eventi

Proprietà

Metodi

GetAccessoryType

Parametri

avatarAssetType: Enum.AvatarAssetType
Valore predefinito: ""

Restituzioni

PromptAllowInventoryReadAccess

()

Richiede al Players.LocalPlayer di consentire al programmatore di leggere quali oggetti l'utente ha nel suo inventario e altre informazioni relative all'editor di avatar.L'invito deve essere confermato dall'utente per il developer di utilizzare AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() e AvatarEditorService:GetFavorite() .Il permesso non persiste tra le sessioni.


Restituzioni

()

PromptCreateOutfit

()

Invita il Players.LocalPlayer a salvare il dato HumanoidDescription come abito. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptCreateOutfitCompleted .

Parametri

Il Outfit che il giocatore verrà richiesto di creare.

Valore predefinito: ""

Il Enum.RigType che l'outfit verrà creato per se il giocatore conferma l'invito.

Valore predefinito: ""

Restituzioni

()

PromptDeleteOutfit

()

Richiede al Players.LocalPlayer di eliminare l'outfit specificato. Non si arrende. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptDeleteOutfitCompleted.

Parametri

outfitId: number

L'outfitId dell'outfit da eliminare.

Valore predefinito: ""

Restituzioni

()

PromptRenameOutfit

()

Invita il Players.LocalPlayer a rinominare l'outfit dato. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptRenameOutfitCompleted .

Parametri

outfitId: number

L'outfitId dell'outfit da rinominare.

Valore predefinito: ""

Restituzioni

()

PromptSaveAvatar

()

Questa funzione richiede al Players.LocalPlayer di aggiornare il loro avatar in base al dato HumanoidDescription e Enum.RigType (R6 o R15).Non produce e può ottenere il risultato ascoltando l'evento PromptSaveAvatarCompleted.Questo è simile a come funzionano altre richieste come PromptPurchase.

Parametri

humanoidDescription: HumanoidDescription

Il dato HumanoidDescription viene richiesto di salvare.

Valore predefinito: ""

Il Enum.RigType che l'avatar verrà salvato per se il giocatore conferma l'invito.

Valore predefinito: ""

Restituzioni

()

PromptSetFavorite

()

Questa funzione richiede al Players.LocalPlayer di preferire o disfavorire l'asset o il bundle dato.

Parametri

itemId: number

L'ItemId dell'elemento che viene richiesto di aggiungere ai preferiti.

Valore predefinito: ""

Il tipo di oggetto richiesto di essere preferito.

Valore predefinito: ""
shouldFavorite: boolean
Valore predefinito: ""

Restituzioni

()

PromptUpdateOutfit

()

Richiede al Players.LocalPlayer di aggiornare l'outfit fornito con la descrizione umanoide fornita.

Parametri

outfitId: number

L'outfitId dell'outfit da aggiornare.

Valore predefinito: ""
updatedOutfit: HumanoidDescription

Una descrizione umanoide che rappresenta i nuovi dati dell'outfit.

Valore predefinito: ""

L'HumanoidRigType per aggiornare l'outfit a.

Valore predefinito: ""

Restituzioni

()

CheckApplyDefaultClothing

Resa

Restituisce un nuovo HumanoidDescription con le proprietà Camicia e Pantaloni aggiornate se necessario. Restituisce nil se l'abbigliamento predefinito non era necessario.

L'abbigliamento predefinito è necessario se la Descrizione Umanoide non ha attualmente la camicia e i pantaloni equipaggiati e i colori del corpo sono troppo simili.

Parametri

humanoidDescription: HumanoidDescription

La descrizione umanoide per controllare se è richiesto l'abbigliamento predefinito.

Valore predefinito: ""

Restituzioni

Restituisce una descrizione umanoide se l'abbigliamento predefinito era necessario. Altrimenti restituisce nil .

ConformToAvatarRules

Resa

Parametri

humanoidDescription: HumanoidDescription
Valore predefinito: ""

Restituzioni

GetAvatarRules

Resa

Questa funzione restituisce le regole dell'Avatar della piattaforma per cose come ridimensionamento, camicie e pantaloni predefiniti, numero di risorse indossabili, ecc.

La tabella restituita include i seguenti campi:


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

Restituzioni

Un dizionario che contiene le regole dell'Avatar della piattaforma per cose come ridimensionamento, camicie e pantaloni predefiniti, numero di risorse indossabili, ecc.Vedi l'esempio di restituzione nella descrizione principale sopra.

GetBatchItemDetails

Resa

Ottiene i dettagli dell'elemento per un elenco di elementi in una volta.Più efficiente di AvatarEditorService:GetItemDetails se devi ottenere tutti i dettagli dell'articolo di una lista.

Parametri

itemIds: Array

L'elenco degli ID dell'elemento per ottenere dettagli.

Valore predefinito: ""

Il tipo degli ID dell'articolo forniti.

Valore predefinito: ""

Restituzioni

Restituisce un array di dettagli dell'elemento con i seguenti campi:


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

Resa

Questa funzione restituisce se il Players.LocalPlayer ha favorito il bundle o l'asset dato.

Parametri

itemId: number

L'ID della risorsa o del bundle specificato.

Valore predefinito: ""

Il Enum.AvatarItemType della risorsa o del bundle specificato.

Valore predefinito: ""

Restituzioni

Se il LocalPlayer ha favorito il pacchetto o l'asset dato.

GetInventory

Resa

Restituisce un oggetto InventoryPages con informazioni sugli oggetti posseduti nell'inventario degli utenti con il dato AvatarAssetTypes.

La tabella restituita include i seguenti campi:


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

Parametri

assetTypes: Array

Il Enum.AvatarAssetType che può essere controllato nell'inventario del giocatore.

Valore predefinito: ""

Restituzioni

GetItemDetails

Resa

Questa funzione restituisce i dettagli dell'elemento per l'elemento dato.Accetta due parametri - il primo che indica l'ID dell'elemento recuperato e il secondo che indica il suo Enum.AvatarItemType .

Dati restituiti nel 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
}

Per interrogare per risorse limitate o illimitate, usa i seguenti valori itemRestrictions :

| itemRestrictions | Limitato o Illimitato | | :--------------: | :-------------------: | | empty | Illimitato | | Collectible | UGC Limitato | | Limited | Roblox Limitato Unico | | LimitedUnique | Roblox Limitato Unico |

Parametri

itemId: number

L'ID dell'elemento il cui dettaglio viene recuperato.

Valore predefinito: ""

Un valore enum che indica il tipo di oggetto i cui dettagli vengono recuperati.

Valore predefinito: ""

Restituzioni

Una tabella che contiene le informazioni sull'elemento per l'elemento recuperato. Vedi sopra per un esempio di tabella.

GetOutfitDetails

Resa

Questa funzione restituisce i dettagli dell'abito per l'abito specificato. Accetta un parametro: l'ID dell'abito.

I dati vengono restituiti nel seguente 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
},
}

Parametri

outfitId: number

L'ID dell'outfit i cui dettagli vengono recuperati.

Valore predefinito: ""

Restituzioni

Un tavolo che contiene le informazioni sull'outfit per l'outfit recuperato. Vedi sopra per un esempio di tavolo.

GetOutfits

Resa

Questa funzione restituisce i dati dell'abito per il Players.LocalPlayer .Questo verrebbe utilizzato con Players:GetHumanoidDescriptionFromOutfitId() per aggiornare il personaggio del giocatore all'outfit.L'accesso a questo dipenderà anche dal fatto che AvatarEditorService:PromptAllowInventoryReadAccess() venga accettato dall'utente.

La tabella restituita include i seguenti campi:


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

<th>tipo</th>
<th>Descrizione</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td><td>int</td>
<td />
</tr>
<tr>
<td>nome</td><td>struttura</td>
<td />
</tr>
<tr>
<td>è modificabile</td><td>booleano</td>
<td />
</tr>
</tbody>
Nome

Parametri

outfitSource: Enum.OutfitSource
Valore predefinito: "All"
outfitType: Enum.OutfitType
Valore predefinito: "All"

Restituzioni

GetRecommendedAssets

Resa

Restituisce una lista di risorse raccomandate in base a un dato Enum.AssetType e ID risorsa.Usa questo per raccogliere un elenco di risorse simili a quelle fornite.Dai un'occhiata al campione di codice qui sotto per ulteriori informazioni sugli usi possibili di questa funzione.

I dati sono nel 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
}
}
]

Parametri

Il tipo di raccomandazioni di risorse da recuperare per recuperare le raccomandazioni.Affecta solo la risposta quando le raccomandazioni basate sull'oggetto non esistono per il dato contextAssetId .

Valore predefinito: ""
contextAssetId: number

L'ID di una risorsa con un tipo corrispondente al tipo di risorsa fornito utilizzato per il contesto durante il recupero delle raccomandazioni.

Valore predefinito: 0

Restituzioni

Un elenco di raccomandazioni basate sul dato Enum.AssetType .

Campioni di codice

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

Resa

Questa funzione restituisce un elenco di pacchetti raccomandati per un determinato ID del pacchetto.

I dati sono nel 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
}
}
}
]

Parametri

bundleId: number

Un elenco di pacchetti raccomandati.

Valore predefinito: ""

Restituzioni

L'ID del pacchetto che verrà restituito per i pacchetti raccomandati.

SearchCatalog

Resa

Questa funzione restituisce un oggetto CatalogPages contenente il risultato della ricerca data.

I dati restituiti hanno il 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
}
]

Parametri

searchParameters: CatalogSearchParams

Un oggetto che contiene i parametri utilizzati per la ricerca.

Valore predefinito: ""

Restituzioni

Eventi

PromptAllowInventoryReadAccessCompleted

Questo evento si attiva quando il prompt AvatarEditorService:PromptAllowInventoryReadAccess() viene risposto dall'utente.Può restituire solo gli stati Success o PermissionDenied enum poiché non esegue alcuna richiesta web che potrebbe fallire.

Parametri

Il risultato della richiesta.


PromptCreateOutfitCompleted

Questo evento si attiva quando l'operazione PromptSaveOutfit è completata.Fornisce uno stato enum indicando se l'avviso è riuscito, fallito o il permesso non è stato concesso dall'utente.

Parametri

Il risultato della richiesta.

failureType: Variant

PromptDeleteOutfitCompleted

Si attiva quando l'operazione PromptDeleteOutfit è completata.Fornisce uno stato enum indicando se l'avviso è riuscito, fallito o il permesso non è stato concesso dall'utente.

Parametri

Il risultato della richiesta.


PromptRenameOutfitCompleted

Si attiva quando l'operazione RinominaPromptOutfit è completata.Fornisce uno stato enum indicando se l'avviso è riuscito, fallito o il permesso non è stato concesso dall'utente.

Parametri

Il risultato della richiesta.


PromptSaveAvatarCompleted

Questo evento si attiva quando l'operazione AvatarEditorService:PromptSaveAvatar() viene completata.Fornisce uno stato enum indicando se l'avviso è riuscito, fallito o il permesso non è stato concesso dall'utente.

Parametri

Il risultato della richiesta.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Si accende quando l'operazione AvatarEditorService:PromptSetFavorite() viene completata.Fornisce uno stato enum indicando se l'avviso è riuscito, fallito o il permesso non è stato concesso dall'utente.

Parametri

Il risultato della richiesta.


PromptUpdateOutfitCompleted

Si accende quando l'operazione AvatarEditorService:PromptUpdateOutfit() viene completata.Fornisce uno stato enum indicando se l'avviso è riuscito, fallito o il permesso non è stato concesso dall'utente.

Parametri

Il risultato della richiesta.