AvatarEditorService

Parameter

Rückgaben

Fordert das Players.LocalPlayer an, den Entwickler zu ermöglichen, zu lesen, welche Artikel der Benutzer in seinem Inventar und andere mit dem Avatar-Editor verwandte Informationen hat.Die Aufforderung muss vom Benutzer bestätigt werden, damit der Entwickler AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() und AvatarEditorService:GetFavorite() verwenden kann.Die Berechtigung bleibt zwischen Sitzungen nicht bestehen.

Rückgaben

Fordert den Players.LocalPlayer auf, das angegebene HumanoidDescription als Outfit zu speichern. Gibt nicht nach. Das Ergebnis kann durch das Anhören des AvatarEditorService.PromptCreateOutfitCompleted-Events abgerufen werden.

Parameter

Rückgaben

Fordert den Players.LocalPlayer auf, das angegebene Outfit zu löschen. Gibt nicht nach. Das Ergebnis kann durch das Anhören des AvatarEditorService.PromptDeleteOutfitCompleted Ereignisses abgerufen werden.

Parameter

Rückgaben

Fordert den Players.LocalPlayer auf, das gegebene Outfit umzubenennen. Gibt nicht nach. Das Ergebnis kann durch das Zuhören des AvatarEditorService.PromptRenameOutfitCompleted Ereignisses abgerufen werden.

Parameter

Rückgaben

Diese Funktion fordert den Players.LocalPlayer auf, ihren Avatar basierend auf dem angegebenen HumanoidDescription und Enum.RigType (R6 oder R15) zu aktualisieren.Gibt nicht nach und kann das Ergebnis erhalten, indem es auf das Ereignis PromptSaveAvatarCompleted hört.Das ist ähnlich, wie andere Eingabeaufforderungen wie PromptPurchase funktionieren.

Parameter

Rückgaben

Diese Funktion fordert die Players.LocalPlayer auf, das angegebene Asset oder Bündel zu favorisieren oder unbeliebt zu machen.

Parameter

Rückgaben

Fordert den Players.LocalPlayer auf, das angegebene Outfit mit der angegebenen HumanoidDescription zu aktualisieren.

Parameter

Rückgaben

Gibt eine neue HumanoidDescription mit den Shirt- und Hosen-Eigenschaften zurück, die aktualisiert wurden, wenn nötig. Gibt nil zurück, wenn keine Standardkleidung benötigt wurde.

Standardkleidung ist erforderlich, wenn die HumanoidDescription derzeit kein Hemd und keine Hose ausgerüstet hat und die Körperfarben zu ähnlich sind.

Parameter

Rückgaben

Parameter

Rückgaben

Diese Funktion gibt die Plattform-Avatar-Regeln für Dinge wie Skalierung, Standardhemden 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

Holen Sie sich die Artikeldetails für eine Liste von Artikeln auf einmal.Effizienter als AvatarEditorService:GetItemDetails, wenn Sie alle Detailinformationen einer Liste erhalten müssen.

Parameter

Rückgaben

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

Diese Funktion gibt zurück, ob die Players.LocalPlayer das gegebene Bündel oder Objektfavorisiert hat.

Parameter

Rückgaben

Gibt ein InventoryPages Objekt mit Informationen über im Besitz befindliche Artikel im Inventar der Benutzer mit der angegebenen AvatarAssetTypes zurück.

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

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

Parameter

Rückgaben

Diese Funktion gibt die Artikeldetails für das angegebene Element zurück.Es akzeptiert zwei Parameter - der erste zeigt die ID des zu extrahierenden Elements an und der zweite zeigt seine Enum.ItemType an.

Daten werden 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 nach begrenzten oder unbegrenzten Assets zu fragen, verwende die folgenden itemRestrictions Werte:

| itemRestrictions | Begrenzt oder unbegrenzt | | :--------------: | :-------------------: | | empty | Unbegrenzt | | Collectible | UGC begrenzt | | Limited | Roblox Limited Unique | | LimitedUnique | Roblox Limited Unique |

Parameter

Rückgaben

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

Daten werden im folgenden Format 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

Rückgaben

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

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

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

<th>eingeben</th>

    <th>Beschreibung</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>id</td><td>int</td>

    <td />
  </tr>

  <tr>
    <td>name</td><td>zeichen</td>

    <td />
  </tr>

  <tr>
    <td>ist bearbeitbar</td><td>boolesisch</td>

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

Parameter

Rückgaben

Gibt eine Liste empfohlener Assets auf der Grundlage einer bestimmten Enum.AssetType und Asset-ID zurück.Verwende dies, um eine Liste ähnlicher Assets zu sammeln, die dem bereitgestellten Asset entsprechen.Sieh dir das Codebeispiel unten für weitere Informationen über mögliche Verwendungen dieser Funktion an.

Die Daten sind 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

Rückgaben

local AvatarEditorService = game:GetService("AvatarEditorService")

local assets = AvatarEditorService:GetRecommendedAssets(Enum.AvatarAssetType.Hat, 9255093)

for _, asset in ipairs(assets) do
	print(asset.Item.Name)
end

Diese Funktion gibt eine Liste empfohlener Pakete für eine bestimmte Paket-ID zurück.

Die Daten sind 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

Rückgaben

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

Rückgaben

Dieses Ereignis wird ausgelöst, wenn die AvatarEditorService:PromptAllowInventoryReadAccess() Aufforderung vom Benutzer geantwortet wird.Es kann nur die Status "Erfolg" oder "Zugriff verweigert" enum zurückgeben, da es keine Web-Anfragen ausführt, die fehlschlagen könnten.

Parameter

Dieses Ereignis wird ausgelöst, wenn die Operation PromptSaveOutfit abgeschlossen ist.Es gibt einen Status enum, der anzeigt, ob die Aufforderung erfolgreich, fehlgeschlagen oder die Berechtigung vom Benutzer nicht gewährt wurde.

Parameter

Feuert ab, wenn die Operation PromptDeleteOutfit abgeschlossen ist.Es gibt einen Status enum, der anzeigt, ob die Aufforderung erfolgreich, fehlgeschlagen oder die Berechtigung vom Benutzer nicht gewährt wurde.

Parameter

Feuert ab, wenn die Operation PromptRenameOutfit abgeschlossen ist.Es gibt einen Status enum, der anzeigt, ob die Aufforderung erfolgreich, fehlgeschlagen oder die Berechtigung vom Benutzer nicht gewährt wurde.

Parameter

Dieses Ereignis wird ausgelöst, wenn die AvatarEditorService:PromptSaveAvatar() Operation abgeschlossen ist.Es gibt einen Status enum, der anzeigt, ob die Aufforderung erfolgreich, fehlgeschlagen oder die Berechtigung vom Benutzer nicht gewährt wurde.

Parameter

Feuert, wenn die AvatarEditorService:PromptSetFavorite() Operation abgeschlossen ist.Es gibt einen Status enum, der anzeigt, ob die Aufforderung erfolgreich, fehlgeschlagen oder die Berechtigung vom Benutzer nicht gewährt wurde.

Parameter

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

Parameter