AvatarEditorService

Methoden

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():void
Bittet den Players.LocalPlayer, die Entwickler erlauben, in ihrem Inventar und anderen Avatar-Editor-bezogenen Informationen zu lesen, die Benutzer haben.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Bittet den Players.LocalPlayer, die angegebene HumanoidDescription als Outfit zu speichern.
PromptDeleteOutfit(outfitId : number):void
Bittet den Players.LocalPlayer, das angegebene Outfit zu löschen.
PromptRenameOutfit(outfitId : number):void
Fordert den Players.LocalPlayer auf, das gegebene Outfit umzubenennen.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Bietet die Players.LocalPlayer an, ihre Avatar basierend auf der angegebenen HumanoidDescription und Enum.RigType von R6 oder R15 zu aktualisieren.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : bool):void
Fordert den Players.LocalPlayer dazu, das gegebene Asset oder Bündelfavorisieren oder abfavorisieren.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Bittet den Players.LocalPlayer , das angegebene Outfit zu aktualisieren.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Angehalten
Wird verwendet, um Standardkleidung auf der HumanoidDescription anzuwenden, wenn nötig.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Angehalten
GetAvatarRules():Dictionary
Angehalten
Gibt die Plattform-Avatar-Regeln für Dinge wie Skalierung, Standardhemd und Hose, Anzahl der anziezbaren Assets zurück.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Angehalten
Bietet die Item-Details für eine Liste von Elementen auf einmal an.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):bool
Angehalten
Gibt zurück, ob das Players.LocalPlayer das angegebene Bundle oder Objektfavorisiert hat.
GetInventory(assetTypes : Array):InventoryPages
Angehalten
Gibt ein InventoryPages-Objekt mit Informationen über besitzte Gegenstände im Benutzerinventar mit den angegebenen AvatarAssetTypes zurück.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Angehalten
Rückgibt die Item-Details für das angegebene Artikel.
GetOutfitDetails(outfitId : number):Dictionary
Angehalten
Rückgibt die Outfit-Details für das gegebene Outfit.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Angehalten
Rückgibt Outfit-Daten für den Players.LocalPlayer.
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Angehalten
Gibt eine Liste von empfohlenen Assets basierend auf einem angegebenen Enum.AssetType und Asset-ID zurück.
GetRecommendedBundles(bundleId : number):Array
Angehalten
Zurückgibt eine Liste von empfohlenen Bundles für eine bestimmte Bundle-ID.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Angehalten
Gibt ein CatalogPages-Objekt zurück, das das Ergebnis der angegebenen suchenenthält.

Ereignisse

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Feuert, wenn die AvatarEditorService:PromptAllowInventoryReadAccess() Anfrage des Benutzers mit dem Fire-Token beantwortet wird.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
Feuert, wenn die Operation PromptSaveOutfit abgeschlossen ist.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Feuert, wenn die Operation PromptDeleteOutfit abgeschlossen ist.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Feuert, wenn die Operation PromptRenameOutfit abgeschlossen ist.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Feuert, wenn die Class.AvatarEditorService:PromptSaveAvatar() -Operation abgeschlossen ist.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Feuert, wenn die AvatarEditorService:PromptSetFavorite() Operation abgeschlossen ist.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Feuert, wenn die AvatarEditorService:PromptUpdateOutfit() Operation abgeschlossen ist.

Eigenschaften

Methoden

PromptAllowInventoryReadAccess

void

Fordert den Players.LocalPlayer auf, die Entwickler-Anwendung zu lesen, was die Benutzer in ihrem Inventar und anderen Avatar-Editor-Informationen haben. Die Benachrichtigung muss vom Benutzer bestätigt werden, um die Entwickler-Anwendung AvatarEditorService:GetInventory() , Class.Av

Rückgaben

void

PromptCreateOutfit

void

Bittet den Players.LocalPlayer, die gegebene HumanoidDescription als Outfit zu speichern. Gibt kein Ergebnis zurück. Das Ergebnis kann durch das Zuhören des AvatarEditorService.PromptCreateOutfitCompleted-Ereignisses abgerufen werden.

Parameter

outfit: HumanoidDescription

Das Outfit, das der Spieler angegeben werden muss, um zu erstellen.

rigType: Enum.HumanoidRigType

Der Enum.RigType, der für das Outfit verwendet wird, wenn der Spieler die Anfrage bestätigt.

Rückgaben

void

PromptDeleteOutfit

void

Bietet die Players.LocalPlayer an, das gegebene Outfit zu löschen. Gibt nicht aus. Das Ergebnis kann durch das Zuhören des AvatarEditorService.PromptDeleteOutfitCompleted Ereignisses abgerufen werden.

Parameter

outfitId: number

Die Outfit-ID des Outfits zum löschen.

Rückgaben

void

PromptRenameOutfit

void

Fordert den Players.LocalPlayer auf, das gegebene Outfit umzubenennen. Gibt keine Ergebnisse zurück. Das Ergebnis kann abgerufen werden, indem das Ereignis AvatarEditorService.PromptRenameOutfitCompleted abgehört wird.

Parameter

outfitId: number

Die Outfit-ID des Outfits, das umbenannt werden soll.

Rückgaben

void

PromptSaveAvatar

void

Diese Funktion fordert den Players.LocalPlayer auf, seinen Avatar basierend auf der angegebenen HumanoidDescription und Enum.RigType (R6 oder R15) zu aktualisieren. Gibt kein Ergebnis aus und kann das Ergebnis erhalten, indem Sie auf das Ereignis PromptSaveAvatarCompleted hören. Dies ist ähnlich wie, wie

Parameter

humanoidDescription: HumanoidDescription

Der angegebene HumanoidDescription wird aufgefordert, gespeichert zu werden.

rigType: Enum.HumanoidRigType

Der Enum.RigType, der der Avatar für gespeichert wird, wenn der Spieler die Anfrage bestätigt.

Rückgaben

void

PromptSetFavorite

void

Diese Funktion bittet den Players.LocalPlayer , das angegebene Asset oder Bündelfavorisiert oder abzufavorisiert zu speichern.

Parameter

itemId: number

Die ItemId des Items, das zu Favoriten angezeigt wird.

itemType: Enum.AvatarItemType

Der Typ des Items, der zu Favoriten angezeigt wird.

shouldFavorite: bool

Rückgaben

void

PromptUpdateOutfit

void

Bittet den Players.LocalPlayer, die angegebene Kleidung mit der angegebenen HumanoidDescription zu aktualisieren.

Parameter

outfitId: number

Die Outfit-ID des Outfits, das Updatewerden soll.

updatedOutfit: HumanoidDescription

Eine HumanoidDescription, die die neuen Outfit-Daten repräsentiert.

rigType: Enum.HumanoidRigType

Der HumanoidRigType, um das Outfit zu aktualisieren.

Rückgaben

void

CheckApplyDefaultClothing

Angehalten

Gibt eine neue HumanoidDescription mit den Shirt- und Hosen属性en aktualisiert zurück, wenn nötig. Gibt null zurück, wenn keine Standardkleidung benötigt wurde.

Standard-Kleidung ist erforderlich, wenn die HumanoidDescription derzeit kein Shirt und keine Hosen trägt und die Körperfarben zu ähnlich sind.

Parameter

humanoidDescription: HumanoidDescription

Die HumanoidDescription, um zu überprüfen, ob Standardkleidung erforderlich ist.

Rückgaben

Gibt eine HumanoidDescription zurück, wenn Standardkleidung erforderlich war. Andernfalls gibt es nil zurück.

ConformToAvatarRules

Angehalten

Parameter

humanoidDescription: HumanoidDescription

Rückgaben

GetAvatarRules

Angehalten

Diese Funktion gibt die Plattform-Avatar-Regeln für Dinge wie Skalierung, Standard-Hemden und Hosen, Anzahl der tragbaren Assets usw. zurück.

Die zurückgegebene Tabelle enthält die folgenden Felder:


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

Rückgaben

Ein Wörterbuch mit den Plattform-Avatar-Regeln für Dinge wie Skalierung, Standard-Hemden und Hosen, Anzahl der anziezbaren Assets usw. Siehe Beispielrückgabe in der Hauptbeschreibung oben.

GetBatchItemDetails

Angehalten

Erhalte die Item-Details für eine Liste von Items auf einmal. Effizienter als AvatarEditorService:GetItemDetails, wenn du alle Details eines Items benötigst.

Parameter

itemIds: Array

Die Liste der Item-IDs, um Details zu erhalten.

itemType: Enum.AvatarItemType

Die Art der bereitgestellten Item-IDs.

Rückgaben

Kehre ein Array von Artikel-Details mit den folgenden Feldern zurück:


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

Angehalten

Diese Funktion gibt zurück, wenn der Players.LocalPlayer das angegebene Bundle oder Objektfavorisiert hat.

Parameter

itemId: number

Die ID der angegebenen Asset oder Bündel.

itemType: Enum.AvatarItemType

Der Enum.AvatarItemType des angegebenen Assets oder der angegebenen Bündel.

Rückgaben

bool

Ob der LocalPlayer das angegebene Bundle oder Objektfavorisiert hat.

GetInventory

InventoryPages

Angehalten

Gibt ein InventoryPages-Objekt mit Informationen über besitzte Gegenstände im Benutzerinventar mit dem angegebenen AvatarAssetTypes zurück.

Die zurückgegebene Tabelle enthält die folgenden Felder:


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

Parameter

assetTypes: Array

Die Enum.AvatarAssetType, die für das Inventar des Spieler:inüberprüft werden kann.

Rückgaben

InventoryPages

GetItemDetails

Angehalten

Diese Funktion gibt die Item-Details für das angegebene Artikelzurück. Sie akzeptiert zwei Argumente - das erste, das die ID des abgerufenen Elements anzeigt, und das zweite, das seine Enum.ItemType anzeigt.

Daten im Format zurückgegeben:


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

Um für begrenzte oder unbegrenzte Assets zu fragen, verwenden Sie die folgenden itemRestrictions Werte:

Parameter

itemId: number

Die ID des Elements, whose Details abgerufen werden.

itemType: Enum.AvatarItemType

Ein Liste-Wert, der die Artikelart anzeigt, deren Details abgerufen werden.

Rückgaben

Eine Tabelle, die die Item-Info für das abgerufene Artikelenthält. Siehe oben für eine Beispiel-Tabelle.

GetOutfitDetails

Angehalten

Diese Funktion gibt die Outfit-Details für das angegebene Outfit zurück. Sie akzeptiert einen Parameter: die ID des Outfits.

Daten werden in der folgenden Form zurückgegeben:


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

Parameter

outfitId: number

Die ID des Outfits, dessen Details abgerufen werden.

Rückgaben

Eine Tabelle, die die Outfit-Info für das abgerufene Outfit enthält. Siehe oben für eine Beispiel-Tabelle.

GetOutfits

OutfitPages

Angehalten

Diese Funktion gibt die Outfit-Daten für den Players.LocalPlayer zurück. Dies würde mit Players:GetHumanoidDescriptionFromOutfitId() verwendet, um den Charakter der Spieler auf das Outfit zu aktualisieren. Zugriff auf dies würde auch von AvatarEditorService:PromptAllowInventoryReadAccess() abhängen, der vom Benutzer angenommen wird.

Die zurückgegebene Tabelle enthält die folgenden Felder:


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


<tbody>
  <tr>
    <td>identifizierte</td>
    <td>int</td>

    <td />
  </tr>

  <tr>
    <td>name</td>
    <td>string</td>

    <td />
  </tr>

  <tr>
    <td>istBearbeitbar</td>
    <td>boolean</td>

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

Name	eingeben	Beschreibung

Parameter

outfitSource: Enum.OutfitSource

Standardwert: "All"

outfitType: Enum.OutfitType

Standardwert: "All"

Rückgaben

OutfitPages

GetRecommendedAssets

Angehalten

Gibt eine Liste von empfohlenen Assets basierend auf einem angegebenen Enum.AssetType und der Asset-ID zurück. Verwenden Sie dies, um eine Liste ähnlicher Assets zu dem bereitgestellten Asset zu sammeln. Schauen Sie sich das Codebeispiel unten für weitere Informationen über mögliche Anwendungen für diese Funktion an.

Daten im Format:


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

Parameter

assetType: Enum.AvatarAssetType

Die Art der Asset-Empfehlungen, die für die Wiederherstellung von Empfehlungen verwendet werden. Betrifft nur die Antwort, wenn keine Asset-Empfehlungen für den angegebenen contextAssetId existieren.

contextAssetId: number

Die ID einer资产 mit einer Art, die der angegebene AssetType verwendet wird, um den Kontext beim Abrufen von Empfehlungen zu verwalten.

Standardwert: 0

Rückgaben

Eine Liste von Empfehlungen basierend auf dem gegebenen Enum.AssetType .

Code-Beispiele

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

Angehalten

Diese Funktion gibt eine Liste von empfohlenen Bündeln für eine bestimmte Bundle-ID zurück.

Daten im Format:


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

Parameter

bundleId: number

Eine Liste von empfohlenen Bundles.

Rückgaben

Die Bundle-ID, für die die empfohlenen Bündel zurückgegeben werden.

SearchCatalog

CatalogPages

Angehalten

Diese Funktion gibt ein CatalogPages Objekt zurück, das das Ergebnis der angegebenen suchenenthält.

Die zurückgegebenen Daten haben das 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
    }
]

Parameter

searchParameters: CatalogSearchParams

Ein Objekt, das die verwendeten suchenenthält.

Rückgaben

CatalogPages

Ereignisse

PromptAllowInventoryReadAccessCompleted

Dieses Ereignis wird ausgelöst, wenn der Class.AvatarEditorService:PromptAllowInventoryReadAccess() -Anfrage des Benutzers mit dem Status Erfolg oder Blockieren zurückgegeben wird. Es kann nur die Erfolg- oder Blockieren-Status Class.AvatarPromptResult|enum zurückgeben, da es keine Web-Anfragen ausführt, die fehlschlagen könnten.

Parameter

Das Ergebnis der Anfrage.

PromptCreateOutfitCompleted

Dieses Ereignis wird ausgelöst, wenn die Operation PromptSaveOutfit abgeschlossen ist. Es gibt einen Status enum , der anzeigt, ob die Anfrage erfolgreich, fehlgeschlagen oder nicht von dem Benutzer erteilt wurde.

Parameter

Das Ergebnis der Anfrage.

failureType: Variant

PromptDeleteOutfitCompleted

Feuert, wenn die Operation PromptDeleteOutfit abgeschlossen ist. Es gibt einen Status enum, der anzeigt, ob die Anfrage erfolgreich, fehlgeschlagen oder nicht von dem Benutzer gewährt wurde.

Parameter

Das Ergebnis der Anfrage.

PromptRenameOutfitCompleted

Feuert, wenn die Operation PromptRenameOutfit abgeschlossen ist. Es gibt einen Status enum, der anzeigt, ob der Anruf erfolgreich, fehlgeschlagen oder nicht von dem Benutzer gewährt wurde.

Parameter

Das Ergebnis der Anfrage.

PromptSaveAvatarCompleted

Dieses Ereignis wird ausgelöst, wenn die Class.AvatarEditorService:PromptSaveAvatar() -Operation abgeschlossen ist. Es gibt einen Status Ennum.AvatarPromptResult|enum , der anzeigt, ob die Anfrage erfolgreich, fehlgeschlagen oder nicht von dem Benutzer erlaubt wurde.

Parameter

Das Ergebnis der Anfrage.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Feuert, wenn die AvatarEditorService:PromptSetFavorite() Operation abgeschlossen ist. Es gibt einen Status enum, der anzeigt, ob der Anruf erfolgreich, fehlgeschlagen oder von dem Benutzer nicht autorisiert war.

Parameter

Das Ergebnis der Anfrage.

PromptUpdateOutfitCompleted

Feuert, wenn die AvatarEditorService:PromptUpdateOutfit() Operation abgeschlossen ist. Es gibt einen Status enum, der anzeigt, ob das Abfrageergebnis erfolgreich, fehlgeschlagen oder nicht von dem Benutzer gewährt wurde.

Parameter

Das Ergebnis der Anfrage.