AvatarEditorService

Yöntemler

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():()
Geliştiricinin envanterindeki ve diğer avatar editörüyle ilgili bilgilerde neler olduğunu okumasına izin veren Players.LocalPlayer uyarır.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Verilen 'i bir kıyafet olarak kaydetmesini ister.
PromptDeleteOutfit(outfitId : number):()
Verilen kıyafeti silmek için Players.LocalPlayer 'yi sorar.
PromptRenameOutfit(outfitId : number):()
Verdiği kıyafeti yeniden adlandırması için Players.LocalPlayer 'yi sorar.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Verilen Players.LocalPlayer ve HumanoidDescription ve Enum.RigType R6 veya R15'in üzerine dayanarak avatarını güncellemeyi ister .
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : boolean):()
Verilen setveya paketi favori veya favori olmayan olarak işaretlemenizi ister Players.LocalPlayer.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Verilen kıyafeti güncellemek için Players.LocalPlayer 'yi sorar.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Bekletir
Gerekirse varsayılan kıyafetleri HumanoidDescription uygulamak için kullanılır.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Bekletir
GetAvatarRules():Dictionary
Bekletir
Ölçeklendirme, varsayılan gömlekler ve pantolonlar, giyilebilir varlıkların sayısı gibi şeyler için platform Avatar kurallarını döndürür.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Bekletir
Bir kez bir öğe listesi için öğe ayrıntılarını alır.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):boolean
Bekletir
Players.LocalPlayer verilen paketi veya varlığı favorilemişse döndürür.
GetInventory(assetTypes : Array):InventoryPages
Bekletir
Verilen AvatarAssetTypes ile kullanıcıların envanterindeki sahip oldukları eşyalarla ilgili bilgileri içeren bir InventoryPages nesne döndürür.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Bekletir
Verilen öğe için öğe detaylarını döndürür.
GetOutfitDetails(outfitId : number):Dictionary
Bekletir
Verilen kıyafet için kıyafet detaylarını döndürür.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Bekletir
Players.LocalPlayer için kıyafet verilerini döndürür.
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Bekletir
Verilen Enum.AssetType ve varlık kimliğine dayalı olarak önerilen varlıkların bir listesini döndürür.
GetRecommendedBundles(bundleId : number):Array
Bekletir
Verilen bir paket kimliği için önerilen paketlerin bir listesini döndürür.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Bekletir
Verilen aramanın sonucunu içeren bir CatalogPages nesne döndürür.

Etkinlikler

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
AvatarEditorService:PromptAllowInventoryReadAccess() uyarısı kullanıcı tarafından yanıtlandığında ateş eder.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
PromptSaveOutfit işlemi tamamlandığında ateş eder.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
PromptDeleteOutfit işlemi tamamlandığında ateş eder.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
PromptRenameOutfit işlemi tamamlandığında ateş eder.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
AvatarEditorService:PromptSaveAvatar() operasyonu tamamlandığında ateş eder.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
AvatarEditorService:PromptSetFavorite() operasyonu tamamlandığında ateş eder.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
AvatarEditorService:PromptUpdateOutfit() operasyonu tamamlandığında ateş eder.

Özellikler

Yöntemler

GetAccessoryType

Enum.AccessoryType

Parametreler

avatarAssetType: Enum.AvatarAssetType

Varsayılan değer: ""

Dönüşler

Enum.AccessoryType

PromptAllowInventoryReadAccess

()

Geliştiricinin envanterindeki ve diğer avatar editörüyle ilgili bilgilerde neler olduğunu okumasına izin veren Players.LocalPlayer uyarır.Geliştirici AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() ve AvatarEditorService:GetFavorite() kullanmak için kullanıcı tarafından onaylanması gereken uyarıdır.İzin oturumlar arasında kalıcı değildir.

Dönüşler

()

PromptCreateOutfit

()

Verilen HumanoidDescription 'i bir kıyafet olarak kaydetmesini ister Players.LocalPlayer. Geri vermez. Sonuç, AvatarEditorService.PromptCreateOutfitCompleted etkinliğini dinleyerek alınabilir.

Parametreler

outfit: HumanoidDescription

Oyuncunun oluşturması gereken Outfit .

Varsayılan değer: ""

rigType: Enum.HumanoidRigType

Kıyafetin oluşturulacağı Enum.RigType eğer oyuncu talimatı onaylarsa.

Varsayılan değer: ""

Dönüşler

()

PromptDeleteOutfit

()

Verilen kıyafeti silmesini ister Players.LocalPlayer. Geri vermez. Sonuç, AvatarEditorService.PromptDeleteOutfitCompleted etkinliğini dinleyerek alınabilir.

Parametreler

outfitId: number

Silinecek kıyafetin kıyafetId'si.

Varsayılan değer: ""

Dönüşler

()

PromptRenameOutfit

()

Verilen kıyafetin adını değiştirmesini ister Players.LocalPlayer. Geri vermez. Sonuç, AvatarEditorService.PromptRenameOutfitCompleted etkinliğini dinleyerek alınabilir.

Parametreler

outfitId: number

Yeniden adlandırılacak kıyafetin kıyafetId'si.

Varsayılan değer: ""

Dönüşler

()

PromptSaveAvatar

()

Bu işlev, verilen Players.LocalPlayer ve Enum.RigType (R6 veya R15) üzerine dayanarak avatarını güncellemesini ister HumanoidDescription.Sonuç vermez ve PromptSaveAvatarCompleted etkinliğini dinleyerek sonucu alabilir.Bu, PromptPurchase gibi diğer uyarıların çalışma şekline benzer.

Parametreler

humanoidDescription: HumanoidDescription

Verilen HumanoidDescription kaydetmeye teşvik ediliyor.

Varsayılan değer: ""

rigType: Enum.HumanoidRigType

Oyuncu talimatı onaylarsa avatarın kaydedileceği Enum.RigType .

Varsayılan değer: ""

Dönüşler

()

PromptSetFavorite

()

Bu işlev, verilen setveya paketi favori veya favori olmayan olarak işaretlemenizi ister Players.LocalPlayer.

Parametreler

itemId: number

Favorilere eklenmesi istenen öğenin ItemId'si.

Varsayılan değer: ""

itemType: Enum.AvatarItemType

Favoriye eklenmesi istenen öğenin türü.

Varsayılan değer: ""

shouldFavorite: boolean

Varsayılan değer: ""

Dönüşler

()

PromptUpdateOutfit

()

Verilen kıyafeti Players.LocalPlayer ile güncellemeyi ister, verilen HumanoidDescription ile.

Parametreler

outfitId: number

Güncellenecek kıyafetin kıyafet güncelle.

Varsayılan değer: ""

updatedOutfit: HumanoidDescription

Yeni kıyafet verilerini temsil eden bir InsanoidDescription.

Varsayılan değer: ""

rigType: Enum.HumanoidRigType

Kıyafeti güncellemek için HumanoidRigType.

Varsayılan değer: ""

Dönüşler

()

CheckApplyDefaultClothing

Bekletir

Gerekliyse güncellenmiş Gömlek ve Pantolon özellikleriyle yeni bir HumanoidDescription döndürür.Varsayılan kıyafet gerekli değilse nil döndürür.

HumanoidDescription'un şu anda tişört ve pantolon takılı olmadığı ve vücut renklerinin çok benzer olduğu durumlarda varsayılan kıyafet gereklidir.

Parametreler

humanoidDescription: HumanoidDescription

Varsayılan kıyafetlerin gerekli olup olmadığını kontrol etmek için HumanoidDescription.

Varsayılan değer: ""

Dönüşler

Varsayılan kıyafet gerekliyse bir HumanoidDescription döndürür. Aksi takdirde nil döndürür.

ConformToAvatarRules

Bekletir

Parametreler

humanoidDescription: HumanoidDescription

Varsayılan değer: ""

Dönüşler

GetAvatarRules

Bekletir

Bu işlev, ölçeklendirme, varsayılan gömlekler ve pantolonlar, giyilebilir varlıkların sayısı gibi şeyler için platform Avatar kurallarını döndürür.

Döndürülen tablo aşağıdaki alanları içerir:


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

Dönüşler

Ölçeklendirme, varsayılan gömlekler ve pantolonlar, giyilebilir varlıkların sayısı vb. platform Avatar kurallarını içeren bir sözlük.Yukarıdaki ana açıklamada örnek dönüşü görün.

GetBatchItemDetails

Bekletir

Bir kez bir öğe listesi için öğe ayrıntılarını alır.Bir listedeki tüm öğe detaylarını almanız gerekiyorsa, AvatarEditorService:GetItemDetails'ten daha verimli.

Parametreler

itemIds: Array

Detayları almak için öğe kimliklerinin listesi.

Varsayılan değer: ""

itemType: Enum.AvatarItemType

Verilen öğe kimliklerinin türü.

Varsayılan değer: ""

Dönüşler

Aşağıdaki alanlarla bir dizi eşya detayı döndürür:


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

boolean

Bekletir

Bu işlev, Players.LocalPlayer verilen paketi veya varlığı favoriler listesine eklediyse geri döner.

Parametreler

itemId: number

Belirtilen setveya paketin kimliği.

Varsayılan değer: ""

itemType: Enum.AvatarItemType

Belirtilen setveya paketin Enum.AvatarItemType 'si.

Varsayılan değer: ""

Dönüşler

boolean

LocalPlayer 'nin verilen paketi veya varlığı favorileştirdiği.

GetInventory

InventoryPages

Bekletir

Verilen InventoryPages ile kullanıcıların envanterindeki sahip oldukları eşyalarla ilgili bilgileri içeren bir AvatarAssetTypes nesnesi döndürür.

Döndürülen tablo aşağıdaki alanları içerir:


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

Parametreler

assetTypes: Array

oyuncuenvanterinde kontrol edilebilecek Enum.AvatarAssetType .

Varsayılan değer: ""

Dönüşler

InventoryPages

GetItemDetails

Bekletir

Bu işlev, verilen öğe için öğe ayrıntılarını döndürür.İki değer kabul eder - ilki alınan öğenin ID'sini gösterir ve ikincisi değerin Enum.ItemType olduğunu gösterir.

Format içinde döndürülen veriler:


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

Sınırlı veya sınırsız varlıklar için sorgulamak için, aşağıdaki itemRestrictions değerlerini kullanın:

Parametreler

itemId: number

Detayları alınan öğenin ID'si.

Varsayılan değer: ""

itemType: Enum.AvatarItemType

Detayları alınan eşyanın türünü gösteren bir dizi değeri.

Varsayılan değer: ""

Dönüşler

Alınan öğe bilgilerini içeren bir tablo. Örnek tablo için yukarıya bakın.

GetOutfitDetails

Bekletir

Bu işlev, verilen kıyafet için kıyafet detaylarını döndürür. Bir parametre kabul eder: kıyafetin ID'si.

Veriler aşağıdaki biçimde geri döner:


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

Parametreler

outfitId: number

Detayları alınan kıyafetin ID'si.

Varsayılan değer: ""

Dönüşler

Alınan kıyafet bilgilerini içeren bir tablo. Örnek tablo için yukarıya bakın.

GetOutfits

OutfitPages

Bekletir

Bu işlev, Players.LocalPlayer için kıyafet verilerini döndürür.Bu, oyuncunun karakterini kıyafete güncelletmek için Players:GetHumanoidDescriptionFromOutfitId() ile kullanılacaktır.Buna erişim, kullanıcı tarafından kabul edilmesine de bağlı olacaktır AvatarEditorService:PromptAllowInventoryReadAccess().

Döndürülen tablo aşağıdaki alanları içerir:


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


<th>yaz</th>

    <th>Açıklama</th>
  </tr>
</thead>

<tbody>
  <tr>
    <td>kimlik</td><td>int</td>

    <td />
  </tr>

  <tr>
    <td>adı</td><td>dize</td>

    <td />
  </tr>

  <tr>
    <td>düzenlenebilir</td><td>boolean</td>

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

Adı

Parametreler

outfitSource: Enum.OutfitSource

Varsayılan değer: "All"

outfitType: Enum.OutfitType

Varsayılan değer: "All"

Dönüşler

OutfitPages

GetRecommendedAssets

Bekletir

Verilen Enum.AssetType ve varlık kimliğine dayalı olarak önerilen varlıkların bir listesini döndürür.Verilen varlığa benzer bir varlık listesi toplamak için bunu kullanın.Bu işlev için olası kullanımlar hakkında daha fazla bilgi için aşağıdaki kod örneğine bir göz atın.

Veriler şekilde bulunur:


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

Parametreler

assetType: Enum.AvatarAssetType

Tavsiye almak için alınacak varlık türü önerileri.Sadece öneri tabanlı öneriler verilmiş contextAssetId için mevcut olmadığında yanıtı etkiler.

Varsayılan değer: ""

contextAssetId: number

Tavsiyelerin alınması sırasında kullanılan konteks için kullanılan bir varlığın türüne uyan bir varlığın ID'si. The id of an asset with a type matching the provided assetType used for context when retrieving recommendations.

Varsayılan değer: 0

Dönüşler

Verdiğiniz Enum.AssetType 'ye dayalı bir öneri listesi.

Kod Örnekleri

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

Bekletir

Bu işlev, belirli bir paket kimliği için önerilen paketlerin bir listesini döndürür.

Veriler şekilde bulunur:


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

Parametreler

bundleId: number

Önerilen paketlerin bir listesi.

Varsayılan değer: ""

Dönüşler

Önerilen paketler için döndürülecek paket ID'si.

SearchCatalog

CatalogPages

Bekletir

Bu işlev, verilen aramanın sonucunu içeren bir CatalogPages nesne döndürür.

Geri döndürülen verilerin formatı şöyledir:


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

Parametreler

searchParameters: CatalogSearchParams

Aramada kullanılan parametleri içeren bir nesne.

Varsayılan değer: ""

Dönüşler

CatalogPages

Etkinlikler

PromptAllowInventoryReadAccessCompleted

Bu olay, kullanıcı tarafından AvatarEditorService:PromptAllowInventoryReadAccess() uyarısına yanıt verildiğinde ateşlenir.Yalnızca Başarılı veya İzinReddedildi enum durumlarını geri döndürebilir, çünkü herhangi bir web isteği yerine getirilmez ve başarısız olabilir.

Parametreler

Prompt'un sonucu.

PromptCreateOutfitCompleted

Bu olay, PromptSaveOutfit işlemi tamamlandığında ateşlenir.Uyarının başarılı, başarısız veya kullanıcı tarafından izin verilmediğini belirten bir durum enum verir.

Parametreler

Prompt'un sonucu.

failureType: Variant

PromptDeleteOutfitCompleted

PromptDeleteOutfit işlemi tamamlandığında ateş eder.Uyarının başarılı, başarısız veya kullanıcı tarafından izin verilmediğini belirten bir durum enum verir.

Parametreler

Prompt'un sonucu.

PromptRenameOutfitCompleted

PromptRenameOutfit işlemi tamamlandığında ateş eder.Uyarının başarılı, başarısız veya kullanıcı tarafından izin verilmediğini belirten bir durum enum verir.

Parametreler

Prompt'un sonucu.

PromptSaveAvatarCompleted

Bu olay, AvatarEditorService:PromptSaveAvatar() işlemi tamamlandığında ateşlenir.Uyarının başarılı, başarısız veya kullanıcı tarafından izin verilmediğini belirten bir durum enum verir.

Parametreler

Prompt'un sonucu.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

AvatarEditorService:PromptSetFavorite() operasyonu tamamlandığında ateş eder.Uyarının başarılı, başarısız veya kullanıcı tarafından izin verilmediğini belirten bir durum enum verir.

Parametreler

Prompt'un sonucu.

PromptUpdateOutfitCompleted

AvatarEditorService:PromptUpdateOutfit() operasyonu tamamlandığında ateş eder.Uyarının başarılı, başarısız veya kullanıcı tarafından izin verilmediğini belirten bir durum enum verir.

Parametreler

Prompt'un sonucu.