AvatarEditorService

Visualizza tutti gli elementi ereditati da Instance

Metodi

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():void
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.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Invita il Players.LocalPlayer a salvare il HumanoidDescription come un abito.
PromptDeleteOutfit(outfitId : number):void
Invita il Players.LocalPlayer a eliminare l'abito fornito.
PromptRenameOutfit(outfitId : number):void
Invita il Players.LocalPlayer a rinominare l'abito fornito.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Richiede che il Players.LocalPlayer aggiorna il proprio avatar in base alla HumanoidDescription e Enum.RigType di R6 o R15.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : bool):void
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.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Resa
Utilizzato per applicare l'abbigliamento predefinito alla HumanoidDescription se necessario.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Resa
GetAvatarRules():Dictionary
Resa
Restituisce le regole della piattaforma Avatar per cose come l'aggiustamento, le camicie e i pantaloni di base, il numero di risorse indossabili.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Resa
Ottiene i dettagli dell'elemento per una lista di elementi alla volta.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):bool
Resa
Restituisce se il Players.LocalPlayer ha preferito il pacchetto o la risorsa fornita.
GetInventory(assetTypes : Array):InventoryPages
Resa
Restituisce un oggetto InventoryPages con informazioni sugli oggetti di proprietà nell'inventario utente con i tipi di risorse avatar forniti.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Resa
Restituisce i dettagli dell'Articoloper l'elemento fornito.
GetOutfitDetails(outfitId : number):Dictionary
Resa
Restituisce i dettagli dell'outfit per l'outfit specificato.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Resa
Restituisce i dati dell'outfit per il Players.LocalPlayer .
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Resa
Restituisce un elenco di risorse raccomandate in base a un dato Enum.AssetType e id risorsa.
GetRecommendedBundles(bundleId : number):Array
Resa
Restituisce un elenco di pacchetti raccomandati per un determinato ID di pacchetto.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Resa
Restituisce un oggetto CatalogPages che contiene il risultato della Cercarefornita.

Visualizza tutti gli elementi ereditati da Instance

Eventi

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Si attiva quando la richiesta AvatarEditorService:PromptAllowInventoryReadAccess() è risposta dall'utente.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
Si attiva quando l'operazione PromptSaveOutfit è completata.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Si attiva quando l'operazione PromptDeleteOutfit è completata.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Si attiva quando l'operazione PromptRenameOutfit è completata.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Si attiva quando l'operazione AvatarEditorService:PromptSaveAvatar() è completata.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Si attiva quando l'operazione AvatarEditorService:PromptSetFavorite() è completata.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Si attiva quando l'operazione AvatarEditorService:PromptUpdateOutfit() è completata.

Visualizza tutti gli elementi ereditati da Instance

Proprietà

Metodi

PromptAllowInventoryReadAccess

void

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

void

PromptCreateOutfit

void

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

outfit: HumanoidDescription

Il Outfit che il giocatore sarà invitato a creare.

rigType: Enum.HumanoidRigType

Il Enum.RigType che l'abito verrà creato se il giocatore conferma la richiesta.

Restituzioni

void

PromptDeleteOutfit

void

Invita il Players.LocalPlayer a eliminare l'outfit fornito. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptDeleteOutfitCompleted .

Parametri

outfitId: number

L'outfitId dell'outfit da Eliminare.

Restituzioni

void

PromptRenameOutfit

void

Richiede il Players.LocalPlayer per rinominare l'outfit fornito. Non produce risultati. Il risultato può essere recuperato ascoltando l'evento AvatarEditorService.PromptRenameOutfitCompleted .

Parametri

outfitId: number

L'outfitId dell'outfit da rinominare.

Restituzioni

void

PromptSaveAvatar

void

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

humanoidDescription: HumanoidDescription

Il HumanoidDescription salvato.

rigType: Enum.HumanoidRigType

Il Enum.RigType che l'avatar salverà se il giocatore conferma la richiesta.

Restituzioni

void

PromptSetFavorite

void

Questa funzione invita il Players.LocalPlayer a preferire o non preferire l'asset o il pacchetto fornito.

Parametri

itemId: number

L'ItemId dell'elemento richiesto per essere Favorire.

itemType: Enum.AvatarItemType

Il tipo di oggetto che viene richiesto di Favorire.

shouldFavorite: bool

Restituzioni

void

PromptUpdateOutfit

void

Richiede al Players.LocalPlayer di aggiornare l'abito dato con la descrizione umanoide data.

Parametri

outfitId: number

L'outfitId dell'outfit da Aggiornarmento.

updatedOutfit: HumanoidDescription

Una HumanoidDescription che rappresenta i nuovi dati di abbigliamento.

rigType: Enum.HumanoidRigType

Il tipo di attrezzatura umanoide per aggiornare l'outfit.

Restituzioni

void

CheckApplyDefaultClothing

Resa

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

humanoidDescription: HumanoidDescription

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

Resa

Parametri

humanoidDescription: HumanoidDescription

Restituzioni

GetAvatarRules

Resa

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

Resa

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

itemIds: Array

La lista degli ID dell'elemento per ottenere i dettagli.

itemType: Enum.AvatarItemType

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

bool

Resa

Questa funzione restituisce se il Players.LocalPlayer ha preferito il pacchetto o la risorsa fornita.

Parametri

itemId: number

L'ID dell'asset o del pacchetto specificato.

itemType: Enum.AvatarItemType

Il Enum.AvatarItemType dell'asset o del pacchetto.

Restituzioni

bool

Se il LocalPlayer ha preferito il pacchetto o la risorsa fornita.

GetInventory

InventoryPages

Resa

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

assetTypes: Array

Il Enum.AvatarAssetType che può essere controllato nell'Inventario, reportoriodel Giocatore.

Restituzioni

InventoryPages

GetItemDetails

Resa

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 :

Parametri

itemId: number

L'ID dell'elemento cui sono in corso le operazioni di recupero dei dettagli.

itemType: Enum.AvatarItemType

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

Resa

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

outfitId: number

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

OutfitPages

Resa

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

outfitSource: Enum.OutfitSource

Valore predefinito: "All"

outfitType: Enum.OutfitType

Valore predefinito: "All"

Restituzioni

OutfitPages

GetRecommendedAssets

Resa

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

assetType: Enum.AvatarAssetType

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 .

contextAssetId: number

L'ID di una risorsa con un tipo corrispondente al tipo fornito per il contesto quando si recupera le raccomandazioni.

Valore predefinito: 0

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

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

bundleId: number

Un elenco di pacchetti raccomandati.

Restituzioni

Visualizza tutti gli elementi ereditati da Instance

L'ID del pacchetto che i pacchetti raccomandati restituiranno.

SearchCatalog

CatalogPages

Resa

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

searchParameters: CatalogSearchParams

Un oggetto che contiene i parametri utilizzati per la Cercare.

Restituzioni

CatalogPages

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.

failureType: Variant

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.

humanoidDescription: HumanoidDescription

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

Visualizza tutti gli elementi ereditati da Instance

Il risultato dell'invito.