AvatarEditorService

Yöntemler

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():void
Oyuncu envanterinde ve diğer avatar editörü ile ilgili bilgileri okumasına izin vermek için Players.LocalPlayer 'yu talimat eder.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Class.Players.LocalPlayer ın verilen HumanoidDescription kaydedilmesini bir kıyafet olarak kaydetmesini talimat eder.
PromptDeleteOutfit(outfitId : number):void
Class.Players.LocalPlayer ın verilen kıyafeti silmesini talep eder.
PromptRenameOutfit(outfitId : number):void
Class.Players.LocalPlayer adlı oyuncunun kıyafetini yeniden adlandırmanızı ister.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):void
R6 veya R15'in sağladığı HumanoidDescription ve Enum.RigType ile avatar'ını güncellemeyi talep eder.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : bool):void
Class.Players.LocalPlayer ın favorilerine veya setçıkmasını ister.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Class.Players.LocalPlayer ın verilen kıyafeti güncellemesini ister.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Bekletir
Gerekirse HumanoidDescription için varsayılan kıyafetleri uygulamak için kullanılır.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Bekletir
GetAvatarRules():Dictionary
Bekletir
Platformun Avatar kurallarını, ölçekleme, varsayılan gömlek ve pantolonlar, giysi olarak kullanılabilir varlıklar sayısı için döndürür.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Bekletir
Bir listedeki öğelerin ayrıntılarını alır.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):bool
Bekletir
Class.Players.LocalPlayer ile verilen paketi veya varlığı favorilerine kaydetmişse döndürür.
GetInventory(assetTypes : Array):InventoryPages
Bekletir
Verilen AvatarAssetTypes ile kullanıcıların envanterindeki sahip öğelerle ilgili bilgi içeren bir InventoryPages nesnemi içerir.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Bekletir
Verilen öğenin ayrıntılarını iade eder.
GetOutfitDetails(outfitId : number):Dictionary
Bekletir
Verilen kıyafetin ayrıntılarını iade eder.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Bekletir
Class.Players.LocalPlayer için kıyafet verilerini iade eder.
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Bekletir
Verilen bir Enum.AssetType ve varlık kimliğine dayanan tavsiye edilen kaynakların bir listesini içerir.
GetRecommendedBundles(bundleId : number):Array
Bekletir
Verilen bağlantı için tavsiye edilen paketlerin bir listesini iade eder.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Bekletir
Verilen aramanın sonucunu içeren bir CatalogPages nesnemi içerir.

Etkinlikler

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Kullanıcı tarafından AvatarEditorService:PromptAllowInventoryReadAccess() ile yanıtlanan şu anketi yanıtlayan kullanıcının yanıtladığınızı yanıtlayın.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
PromptSaveOutfit işleminin tamamlandığında ateşlenir.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
PromptDeleteOutfit işleminin tamamlandığında ateşlenir.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
PromptRenameOutfit işleminin tamamlandığında ateşlenir.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Class.AvatarEditorService:PromptSaveAvatar() operasyonu tamamlandığında ateşlenir.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Class.AvatarEditorService:PromptSetFavorite() operasyonu tamamlandığında ateşlenir.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Class.AvatarEditorService:PromptUpdateOutfit() operasyonu tamamlandığında ateşlenir.

Özellikler

Yöntemler

PromptAllowInventoryReadAccess

void

Oyunun kaynak kodlarını gösteren Players.LocalPlayer ile oyunun kaynak kodlarını gösteren AvatarEditorService:GetInventory() ile oyunun kaynak kodlarını gösteren AvatarEditorService:GetOutfits()

Dönüşler

void

PromptCreateOutfit

void

Class.Players.LocalPlayer ın HumanoidDescription ını bir kıyafet olarak kaydetmesini ister. Geri vermez. Sonuç, AvatarEditorService.PromptCreateOutfitCompleted etkinliğine dinleyerek alınabilir.

Parametreler

outfit: HumanoidDescription

Oyuncunun oluşturulması için talep edilecek Outfit .

rigType: Enum.HumanoidRigType

Oyuncu'nun isteğini onayladığında kullanılan Enum.RigType kıyafetin oluşturulacağı.

Dönüşler

void

PromptDeleteOutfit

void

Class.Players.LocalPlayer ın verilen kıyafeti silmesini isterir. Geri vermez. Sonuç, AvatarEditorService.PromptDeleteOutfitCompleted etkinliğini dinleyerek alınabilir.

Parametreler

outfitId: number

Silinecek kıyafetin kıyafetID'si.

Dönüşler

void

PromptRenameOutfit

void

Class.Players.LocalPlayer ın verilen kıyafetin adını değiştirmesini ister. Geriye dönüştürme yapmaz. Sonuç AvatarEditorService.PromptRenameOutfitCompleted etkinliğine bağlı olarak alınabilir.

Parametreler

outfitId: number

Kıyafetin yeniden adlandırılacak kimliği.

Dönüşler

void

PromptSaveAvatar

void

Bu işlev, Players.LocalPlayernın sağlanan HumanoidDescription ve Enum.RigType (R6 veya R15) üzerine avatarını güncellemesini isterir. İçgörü SaveAvatarCompleted etkinliğini dinleyerek sonuç elde edilir. Bu, diğer prompts gibi PromptPurchase'ı

Parametreler

humanoidDescription: HumanoidDescription

Class.HumanoidDescription ile kaydedilmesi istenen verilen.

rigType: Enum.HumanoidRigType

Oyuncu, isteği onayladığında kaydedilecek Enum.RigType avatarı.

Dönüşler

void

PromptSetFavorite

void

Bu işlev, Players.LocalPlayer'ı favorilerine veya favorilerinden çıkarma konusunda favori veya favori olmayan setveya paketi tercih etme konusunda uyarır.

Parametreler

itemId: number

Önerilen öğenin favorilerine kaydedilen öğesi.

itemType: Enum.AvatarItemType

Favorilerine eklenen öğenin türü.

shouldFavorite: bool

Dönüşler

void

PromptUpdateOutfit

void

Class.Players.LocalPlayer ile verilen kıyafeti HumanoidDescription ile güncellemeyi talep eder.

Parametreler

outfitId: number

Güncellenecek kıyafetin kıyafetID'si.

updatedOutfit: HumanoidDescription

Yeni kıyafet verilerini temsil eden bir HumanoidDescription.

rigType: Enum.HumanoidRigType

Kıyafetin güncellenmesi için HumanoidRigType'i görüntüleyin.

Dönüşler

void

CheckApplyDefaultClothing

Bekletir

Gerekirse HumanoidDescription ile bir yeni şirt ve pantolon özelliği için güncellenmiş bir Class.HumanoidDescription döndürür. Standart kıyafet olmadığında, Class.HumanoidDescription döndürür.

HumanoidDescription'ın şu anda Gömlek ve Pantolon takmadığı ve vücut renkleri çok benzer olduğu durumda, varsayılan kıyafetler gereklidir.

Parametreler

humanoidDescription: HumanoidDescription

Varsayılan kıyafetin gerektiğini kontrol etmek için HumanoidDescription.

Dönüşler

Varsayılan kıyafet gerektiğinde bir HumanoidDescription döndürür. Aksi takdirde, nil döndürür.

ConformToAvatarRules

Bekletir

Parametreler

humanoidDescription: HumanoidDescription

Dönüşler

GetAvatarRules

Bekletir

Bu işlev, platform Avatar kurallarını gösterir, büyütme, varsayılan gömlek ve pantolonlar, giyilebilir varlıkların sayısı vb.

Döndürilen tabloda şu alanlar bulunur:


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

Platform Avatar kurallarını içeren bir sözlük, büyütme, varsayılan gömlek ve pantolonlar, giysilebilir varlıkların sayısı vb. gibi şeyler için. Aşağıdaki ana açıklamadaki örnek döndümüne bakın.

GetBatchItemDetails

Bekletir

Bir listedeki öğelerin ayrıntılarını alır. AvatarEditorService:GetItemDetails'den daha verimlidir: Listedeki tüm öğelerin ayrıntılarını almak için gerekirse.

Parametreler

itemIds: Array

Ayrıntıları almak için öğe kimliklerinin listesi.

itemType: Enum.AvatarItemType

Sunulan öğe kimliklerinin türü.

Dönüşler

Aşağıdaki alanlarla bir öğe ayrıntılarının bir matrisi 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

bool

Bekletir

Bu işlev, Players.LocalPlayer 'in verilen paketi veya varlığı favorilerine aldığında geri döndüğünü gösterir.

Parametreler

itemId: number

Belirli varlık veya paketin ID'si.

itemType: Enum.AvatarItemType

Belirli setveya paketin Enum.AvatarItemType

Dönüşler

bool

LocalPlayer 'in verilen paketi veya varlığı favorilerine alıp almadığı.

GetInventory

InventoryPages

Bekletir

Verilen InventoryPages nesneleri ile kullanıcıların envanterindeki alınan eşyalar hakkında bilgi içeren bir AvatarAssetTypes nesneleri döndürür.

Döndürilen tabloda şu alanlar bulunur:


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

Parametreler

assetTypes: Array

oyuncuenvanterinde kontrol edilecek Enum.AvatarAssetType

Dönüşler

InventoryPages

GetItemDetails

Bekletir

Bu işlev, verilen öğenin ayrıntılarını içerir. İki parametre kabul eder - ilk olarak alınan öğenin ID'sini gösteren ve ikinci olarak kullanılan öğenin Enum.ItemType .

Verilerin biçimde iade edildi:


{
  "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 kaynaklar için şu değerleri kullanın: itemRestrictions

Parametreler

itemId: number

Ayrıntıları alınan öğenin ID'si.

itemType: Enum.AvatarItemType

Geri alınanların türünü gösteren bir열 değeri.

Dönüşler

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

GetOutfitDetails

Bekletir

Bu işlev, verilen kıyafetin ayrıntılarını döndürür. Bir parametre kabul eder: kıyafetin ID'si.

Veriler aşağıdaki biçimde iade edilir:


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

Ayrıntıları alınan kıyafetin ID'si.

Dönüşler

Alınan kıyafetin kıyafet bilgilerini içeren bir tablo. Üstte bir örnek tablo bulun.

GetOutfits

OutfitPages

Bekletir

Bu işlev Players.LocalPlayer için kıyafet verileri içerir. Bu, Players:GetHumanoidDescriptionFromOutfitId() ile kullanıcının karakterini kıyafete güncellemeyi kullanır. Bu işlevin kullanımı AvatarEditorService:PromptAllowInventoryReadAccess() ile kabul edilir

Döndürilen tabloda şu alanlar bulunur:


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


<tbody>
  <tr>
    <td>kimlik</td>
    <td>sayı</td>

    <td />
  </tr>

  <tr>
    <td>i̇sim</td>
    <td>dizi</td>

    <td />
  </tr>

  <tr>
    <td>Düzenlenebilir</td>
    <td>boo</td>

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

İsim	yazı	Açıklama

Parametreler

outfitSource: Enum.OutfitSource

Varsayılan değer: "All"

outfitType: Enum.OutfitType

Varsayılan değer: "All"

Dönüşler

OutfitPages

GetRecommendedAssets

Bekletir

Belirli bir Enum.AssetType ve varlık kimliğine dayanan tavsiye edilen kaynakların bir listesini içerir. Bunu kullanın paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşütsüz paraşü

Veriler formatında:


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

Türüne göre öneriler alınır. Yalnızca verilen contextAssetId için öneriler için yanıt etkilerini etkiler.

contextAssetId: number

Önerileri alırken kullanılan sağlayıcı özellik türüne eşdeğer olan bir varlığın kimliği.

Varsayılan değer: 0

Dönüşler

Verilen Enum.AssetType ile temel alınan önerilerin bir 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 bağlantı için tavsiye edilen paketlerin bir listesini döndürür.

Veriler formatında:


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

Dönüşler

Önerilen paketlerin içindeki kayıtlanmış kimlik.

SearchCatalog

CatalogPages

Bekletir

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

Döndürülen verilerin biçimi:


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

Arama için kullanılan parametreleri içeren bir nesne.

Dönüşler

CatalogPages

Etkinlikler

PromptAllowInventoryReadAccessCompleted

Bu etkinlik, AvatarEditorService:PromptAllowInventoryReadAccess() iletisi içeriğine kullanıcı tarafından yanıtlanınca başarıyla başlar. Sadece başarı veya İzin Yok enum durumlarını döndürebilir.

Parametreler

İstemin sonucu.

PromptCreateOutfitCompleted

Bu etkinlik, PromptSaveOutfit işleminin tamamlanmasından sonra başlar. Arayan bir durum kodu enum verir, böylece isteğin başarılı olup olmadığını gösterir.

Parametreler

İstemin sonucu.

failureType: Variant

PromptDeleteOutfitCompleted

PromptDeleteOutfit işleminin tamamlandığında ateşlenir. Arayüz başarılı olduğunu gösteren bir durum kaydı enum ile birlikte.

Parametreler

İstemin sonucu.

PromptRenameOutfitCompleted

PromptRenameOutfit işleminin tamamlandığında ateşlenir. Arayanın başarılı olup olmadığını gösteren bir durum kodu enum sağlar.

Parametreler

İstemin sonucu.

PromptSaveAvatarCompleted

Bu etkinlik, Class.AvatarEditorService:PromptSaveAvatar() operasyonu tamamlandığında başlar. Bir durum verir Enum.AvatarPromptResult|enuム şunu gösteriyor: istem başarılı, başarısız veya izin verilmemişse.

Parametreler

İstemin sonucu.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Class.AvatarEditorService:PromptSetFavorite() operasyonu tamamlandığında ateş eder. Arayüz Enum.AvatarPromptResult|enuム başarılı olduğunu gösteren bir durum gösterir.

Parametreler

İstemin sonucu.

PromptUpdateOutfitCompleted

Class.AvatarEditorService:PromptUpdateOutfit() operasyonu tamamlandığında ateşlenir. Arayüz Enum.AvatarPromptResult|enu içinde durumu gösterir, istem başarılı olduğunu gösteren bir durum veya izin verilmeyen bir durum olup olmadığını gösterir.

Parametreler

İstemin sonucu.