AvatarEditorService
*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.
AvatarEditorService è un servizio per supportare gli Editor di Avatar dei giocatori. Fornisce metodi per modificare l'avatar del Giocatore, richiede informazioni sull'Inventario, reportoriodi un utente e richiede informazioni sul catalogo.
For more information regarding the Editor di Avatar, see Servizio Editor del Avatar .
Acceleratore
I seguenti punti di interruzione di livello AvatarEditorService hanno un livello di esperienza di limitazione:
Per ciascuna esperienza, questo limitatore ti consente di inviare fino a 100 richieste per secondo a questi AvatarEditorService punti di fine, indipendentemente dal numero di server o dal numero di utenti. L'eccedenza di questi limiti restituisce un errore 429 Too Many Requests .
Se trovi che la tua esperienza richieda un adattamento a questo acceleramento, puoi inviare una richiesta di funzione Richiesta di funzione .
Sommario
Proprietà
Metodi
Invita il Players.LocalPlayer a consentire al sviluppatore di leggere quali oggetti l'utente ha nel loro inventario e altre informazioni sull'editor avatar correlate.
Invita il Players.LocalPlayer a salvare il HumanoidDescription come un abito.
Invita il Players.LocalPlayer a eliminare l'abito fornito.
Invita il Players.LocalPlayer a rinominare l'abito fornito.
Richiede che il Players.LocalPlayer aggiorna il proprio avatar in base alla HumanoidDescription e Enum.RigType di R6 o R15.
Invita il Players.LocalPlayer a preferire o non preferire l'asset o il pacchetto fornito.
- PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Richiede al Players.LocalPlayer di aggiornare l'abito fornito.
Utilizzato per applicare l'abbigliamento predefinito alla HumanoidDescription se necessario.
Restituisce le regole della piattaforma Avatar per cose come l'aggiustamento, le camicie e i pantaloni di base, il numero di risorse indossabili.
Ottiene i dettagli dell'elemento per una lista di elementi alla volta.
Restituisce se il Players.LocalPlayer ha preferito il pacchetto o la risorsa fornita.
Restituisce un oggetto InventoryPages con informazioni sugli oggetti di proprietà nell'inventario utente con i tipi di risorse avatar forniti.
Restituisce i dettagli dell'Articoloper l'elemento fornito.
Restituisce i dettagli dell'outfit per l'outfit specificato.
Restituisce i dati dell'outfit per il Players.LocalPlayer .
Restituisce un elenco di risorse raccomandate in base a un dato Enum.AssetType e id risorsa.
Restituisce un elenco di pacchetti raccomandati per un determinato ID di pacchetto.
Restituisce un oggetto CatalogPages che contiene il risultato della Cercarefornita.
Eventi
Si attiva quando la richiesta AvatarEditorService:PromptAllowInventoryReadAccess() è risposta dall'utente.
Si attiva quando l'operazione PromptSaveOutfit è completata.
Si attiva quando l'operazione PromptDeleteOutfit è completata.
Si attiva quando l'operazione PromptRenameOutfit è completata.
- PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Si attiva quando l'operazione AvatarEditorService:PromptSaveAvatar() è completata.
Si attiva quando l'operazione AvatarEditorService:PromptSetFavorite() è completata.
Si attiva quando l'operazione AvatarEditorService:PromptUpdateOutfit() è completata.
Proprietà
Metodi
GetAccessoryType
Parametri
Restituzioni
PromptAllowInventoryReadAccess
Richiede il Players.LocalPlayer per consentire al sviluppatore di leggere quali oggetti l'utente ha nel loro inventario e altre informazioni sull'avatar editor correlate. Il prompt deve essere confermato dall'utente per il sviluppatore di utilizzare AvatarEditorService:GetInventory() ,
Restituzioni
PromptCreateOutfit
Invita il Players.LocalPlayer a salvare il HumanoidDescription come un abito. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptCreateOutfitCompleted .
Parametri
Il Outfit che il giocatore sarà invitato a creare.
Il Enum.RigType che l'abito verrà creato se il giocatore conferma la richiesta.
Restituzioni
PromptDeleteOutfit
Invita il Players.LocalPlayer a eliminare l'outfit fornito. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptDeleteOutfitCompleted .
Parametri
L'outfitId dell'outfit da Eliminare.
Restituzioni
PromptRenameOutfit
Richiede il Players.LocalPlayer per rinominare l'outfit fornito. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptRenameOutfitCompleted .
Parametri
L'outfitId dell'outfit da rinominare.
Restituzioni
PromptSaveAvatar
Questa funzione richiede che il Players.LocalPlayer aggiorni il proprio avatar in base alla richiesta data HumanoidDescription e Enum.RigType (R6 o R15). Non produce risultati e può ottenere il risultato ascoltando l'evento PromptSaveAvatarCompleted . Ciò è simile a come funzionano altri promemoria come PromptPurchase
Parametri
Il HumanoidDescription salvato.
Il Enum.RigType che l'avatar salverà se il giocatore conferma la richiesta.
Restituzioni
PromptSetFavorite
Questa funzione invita il Players.LocalPlayer a preferire o non preferire l'asset o il pacchetto fornito.
Parametri
L'ItemId dell'elemento richiesto per essere Favorire.
Il tipo di oggetto che viene richiesto di Favorire.
Restituzioni
PromptUpdateOutfit
Richiede al Players.LocalPlayer di aggiornare l'abito dato con la descrizione umanoide data.
Parametri
L'outfitId dell'outfit da Aggiornarmento.
Una HumanoidDescription che rappresenta i nuovi dati di abbigliamento.
Il tipo di attrezzatura umanoide per aggiornare l'outfit.
Restituzioni
CheckApplyDefaultClothing
Restituisce un nuovo HumanoidDescription con le proprietà Shirt e Pants aggiornate se necessario. Ritorna null se l'abbigliamento predefinito non era necessario.
L'abbigliamento predefinito è necessario se la descrizione dell'uomo non ha attualmente camicia e pantaloni equipaggiati e i colori del corpo sono troppo simili.
Parametri
La descrizione umanoide per controllare se è richiesta l'abbigliamento predefinito.
Restituzioni
Restituisce una descrizione umanoide se l'abbigliamento predefinito era necessario. Altrimenti restituisce null.
ConformToAvatarRules
Parametri
Restituzioni
GetAvatarRules
Questa funzione restituisce le regole del platform Avatar per cose come l'aggiungimento di dimensioni, 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 della piattaforma Avatar per cose come l'aggiustamento, le camicie e i pantaloni di base, il numero di risorse indossabili, ecc. Vedi il ritorno dell'esempio nella descrizione principale sopra.
GetBatchItemDetails
Ottiene i dettagli dell'elemento per una lista di elementi contemporaneamente. Più efficiente di AvatarEditorService:GetItemDetails se hai bisogno di ottenere tutti i dettagli dell'elemento di una lista.
Parametri
La lista degli ID dell'elemento per ottenere i dettagli.
Il tipo di ID dell'elemento fornito.
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
Questa funzione restituisce se il Players.LocalPlayer ha preferito il pacchetto o la risorsa fornita.
Parametri
L'ID dell'asset o del pacchetto specificato.
Il Enum.AvatarItemType dell'asset o del pacchetto.
Restituzioni
Se il LocalPlayer ha preferito il pacchetto o la risorsa fornita.
GetInventory
Restituisce un oggetto InventoryPages con informazioni sugli oggetti di proprietà nell'inventario utente con il AvatarAssetTypes .
La tabella restituita include i seguenti campi:
[{"AssetId": 0,"AssetType" : "string","Created": "string","Name": "string",}]
Parametri
Il Enum.AvatarAssetType che può essere controllato nell'Inventario, reportoriodel Giocatore.
Restituzioni
GetItemDetails
Questa funzione restituisce i dettagli dell'Articoloper l'elemento fornito. Accetta due parametri - il primo che indica l'ID dell'elemento che viene recuperato e il secondo che indica il suo Enum.ItemType .
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 ottenere risorse limitate o illimitate, usa i seguenti valori itemRestrictions :
| itemRestrictions | Limitato o Illimitato | | :--------------: | :-------------------: | | empty | Unlimited | | Collectible | UGC Limitato | Limited | Roblox Limitato Unico |
Parametri
L'ID dell'elemento cui sono in corso le operazioni di recupero dei dettagli.
Un valore dell'enum che indica il tipo di oggetto cui i suoi dettagli vengono recuperati.
Restituzioni
Una tabella che contiene le informazioni dell'elemento per l'Articolorecuperato. Vedi sopra per un esempio di tabella.
GetOutfitDetails
Questa funzione restituisce i dettagli dell'outfit per l'outfit fornito. Accetta un parametro: l'ID dell'outfit.
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
L'ID dell'outfit cui sono in corso le operazioni di recupero dei dettagli.
Restituzioni
Una tabella che contiene le informazioni sull'outfit per l'outfit recuperato. Vedi sopra per un esempio di tabella.
GetOutfits
Questa funzione restituisce i dati dell'outfit per il Players.LocalPlayer . Questo sarebbe utilizzato con Players:GetHumanoidDescriptionFromOutfitId() per aggiornare il personaggio dei giocatori all'outfit. L'accesso a questo dipenderà anche dal fatto che AvatarEditorService:PromptAllowInventoryReadAccess() sia accettato dall'utente.
La tabella restituita include i seguenti campi:
[{"Id": 0,"Name": "string","IsEditable": true}]
<tbody><tr><td>identificatore</td><td>int</td><td /></tr><tr><td>nome</td><td>stringa</td><td /></tr><tr><td>èModificabile</td><td>booleano</td><td /></tr></tbody>
Nome | inserisci / scrivi | Descrizione |
---|
Parametri
Restituzioni
GetRecommendedAssets
Restituisce un elenco di risorse raccomandate in base a un dato Enum.AssetType e l'ID della risorsa. Usa questo per raccogliere un elenco di risorse simili a quella fornita. Dai un'occhiata al codice di esempio seguente per ulteriori informazioni sui possibili usi per 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 tipo di risorsa da recuperare raccomandazioni per. Affects only the response when item based recommendations don't exist for the given contextAssetId .
L'ID di una risorsa con un tipo corrispondente al tipo fornito per il contesto quando si recupera le raccomandazioni.
Restituzioni
Una lista di raccomandazioni basate sul Enum.AssetType0> En 3> En 4> En 7> En 9> En 0> En 1> En 4> En 7> En 8> En 1> En 4> En 7> En 9> En 0> En 1> En 4> En 7> En 9> En 0>
Campioni di codice
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
Questa funzione restituisce un elenco di pacchetti raccomandati per un determinato ID di 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
Un elenco di pacchetti raccomandati.
Restituzioni
L'ID del pacchetto che i pacchetti raccomandati restituiranno.
SearchCatalog
Questa funzione restituisce un oggetto CatalogPages che contiene il risultato della Cercarefornito.
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
Un oggetto che contiene i parametri utilizzati per la Cercare.
Restituzioni
Eventi
PromptAllowInventoryReadAccessCompleted
Questo evento si attiva quando la richiesta AvatarEditorService:PromptAllowInventoryReadAccess() viene risposta dall'utente. Può restituire solo il successo o il permesso negato enum stati come non esegue alcuna richiesta web che potrebbe fallire.
Parametri
Il risultato dell'invito.
PromptCreateOutfitCompleted
Questo evento si attiva quando l'operazione PromptSaveOutfit è completata. Dà uno stato enum che indica se l'invito ha avuto successo, è fallito o l'autorizzazione non è stata concessa dall'utente.
Parametri
Il risultato dell'invito.
PromptDeleteOutfitCompleted
Si attiva quando l'operazione PromptDeleteOutfit è completata. Mostra uno stato enum che indica se l'invito ha avuto successo, è fallito o l'autorizzazione non è stata concessa dall'utente.
Parametri
Il risultato dell'invito.
PromptRenameOutfitCompleted
Si attiva quando l'operazione RinominaPromptOutfit è completata. Dà uno stato enum che indica se l'operazione è riuscita, non riuscita o non è stato concesso l'autorizzazione dall'utente.
Parametri
Il risultato dell'invito.
PromptSaveAvatarCompleted
Questo evento si attiva quando l'operazione AvatarEditorService:PromptSaveAvatar() è completata. Fornisce uno stato enum che indica se l'invito è riuscito, non riuscito o non è stato concesso l'autorizzazione dall'utente.
Parametri
Il risultato dell'invito.
PromptSetFavoriteCompleted
Si attiva quando l'operazione AvatarEditorService:PromptSetFavorite() è completata. Fornisce uno stato enum che indica se l'invito è riuscito, non riuscito o non è stato concesso l'autorizzazione dall'utente.
Parametri
Il risultato dell'invito.
PromptUpdateOutfitCompleted
Si attiva quando l'operazione AvatarEditorService:PromptUpdateOutfit() è completata. Fornisce uno stato enum che indica se l'invito è riuscito, non riuscito o non è stato concesso l'autorizzazione dall'utente.
Parametri
Il risultato dell'invito.