AvatarEditorService

Metode

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():()
Meminta Players.LocalPlayer untuk mengizinkan pengembang membaca item apa yang dimiliki pengguna di inventaris dan informasi terkait editor avatar lainnya.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Meminta Players.LocalPlayer untuk menyimpan yang diberikan HumanoidDescription sebagai pakaian.
PromptDeleteOutfit(outfitId : number):()
Meminta Players.LocalPlayer untuk menghapus pakaian yang diberikan.
PromptRenameOutfit(outfitId : number):()
Meminta Players.LocalPlayer untuk mengganti nama pakaian yang diberikan.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Meminta Players.LocalPlayer untuk memperbarui avatar mereka berdasarkan yang diberikan HumanoidDescription dan Enum.RigType dari R6 atau R15.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : boolean):()
Meminta Players.LocalPlayer untuk menyukai atau tidak menyukai aset atau bundel yang diberikan.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Meminta Players.LocalPlayer untuk memperbarui pakaian yang diberikan.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Hasil
Digunakan untuk menerapkan pakaian default ke HumanoidDescription jika diperlukan.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Hasil
GetAvatarRules():Dictionary
Hasil
Kembalikan aturan Avatar platform untuk hal-hal seperti skala, kemeja dan celana default, jumlah aset yang dapat dipakai.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Hasil
Mendapatkan detail item untuk daftar item sekaligus.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):boolean
Hasil
Kembalikan jika Players.LocalPlayer memiliki favoritkan bundel atau aset yang diberikan.
GetInventory(assetTypes : Array):InventoryPages
Hasil
Kembalikan objek InventoryPages dengan informasi tentang item yang dimiliki di inventaris pengguna dengan AvatarAssetTypes yang diberikan.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Hasil
Kembalikan detail item untuk item yang diberikan.
GetOutfitDetails(outfitId : number):Dictionary
Hasil
Kembalikan detail pakaian untuk pakaian yang diberikan.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Hasil
Kembalikan data pakaian untuk Players.LocalPlayer.
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Hasil
Kembalikan daftar aset yang direkomendasikan berdasarkan Enum.AssetType.
GetRecommendedBundles(bundleId : number):Array
Hasil
Kembalikan daftar bundel yang direkomendasikan untuk ID bundel tertentu.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Hasil
Kembalikan objek CatalogPages yang berisi hasil pencarian yang diberikan.

Acara

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Melepaskan api saat perintah AvatarEditorService:PromptAllowInventoryReadAccess() dijawab oleh pengguna.
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
Melepaskan ketika operasi PromptSaveOutfit selesai.
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Melepaskan api saat operasi PromptDeleteOutfit selesai.
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Melepaskan api saat operasi PromptRenameOutfit selesai.
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Melepaskan api saat operasi AvatarEditorService:PromptSaveAvatar() selesai.
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Melepaskan api saat operasi AvatarEditorService:PromptSetFavorite() selesai.
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
Melepaskan api saat operasi AvatarEditorService:PromptUpdateOutfit() selesai.

Properti

Metode

GetAccessoryType

Enum.AccessoryType

Parameter

avatarAssetType: Enum.AvatarAssetType

Nilai Default: ""

Memberikan nilai

Enum.AccessoryType

PromptAllowInventoryReadAccess

()

Meminta Players.LocalPlayer untuk mengizinkan pengembang membaca item apa yang dimiliki pengguna di inventaris dan informasi terkait editor avatar lainnya.Prompt perlu dikonfirmasi oleh pengguna agar pengembang dapat menggunakan AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() dan AvatarEditorService:GetFavorite() .Izin tidak bertahan di antara sesi.

Memberikan nilai

()

PromptCreateOutfit

()

Meminta Players.LocalPlayer untuk menyimpan yang diberikan HumanoidDescription sebagai pakaian. Tidak menghasilkan. Hasilnya dapat diambil dengan mendengarkan acara AvatarEditorService.PromptCreateOutfitCompleted .

Parameter

outfit: HumanoidDescription

The Outfit yang akan diminta pemain untuk dibuat.

Nilai Default: ""

rigType: Enum.HumanoidRigType

The Enum.RigType yang pakaian akan dibuat untuk jika pemain mengkonfirmasi perintah.

Nilai Default: ""

Memberikan nilai

()

PromptDeleteOutfit

()

Meminta Players.LocalPlayer untuk menghapus pakaian yang diberikan. Tidak menghasilkan. Hasilnya dapat diambil dengan mendengarkan acara AvatarEditorService.PromptDeleteOutfitCompleted .

Parameter

outfitId: number

The outfitId dari pakaian yang akan dihapus.

Nilai Default: ""

Memberikan nilai

()

PromptRenameOutfit

()

Meminta Players.LocalPlayer untuk mengganti nama pakaian yang diberikan. Tidak menghasilkan. Hasilnya dapat diambil dengan mendengarkan acara AvatarEditorService.PromptRenameOutfitCompleted .

Parameter

outfitId: number

The outfitId dari pakaian untuk diberi nama ulang.

Nilai Default: ""

Memberikan nilai

()

PromptSaveAvatar

()

Fungsi ini meminta Players.LocalPlayer untuk memperbarui avatar mereka berdasarkan yang diberikan HumanoidDescription dan Enum.RigType (R6 atau R15).Tidak menghasilkan dan dapat mendapatkan hasil dengan mendengarkan acara PromptSaveAvatarCompleted.Ini mirip dengan cara prompt lain seperti PromptPurchase bekerja.

Parameter

humanoidDescription: HumanoidDescription

Yang diberikan HumanoidDescription disuruh untuk disimpan.

Nilai Default: ""

rigType: Enum.HumanoidRigType

The Enum.RigType yang avatar akan disimpan jika pemain mengkonfirmasi perintah.

Nilai Default: ""

Memberikan nilai

()

PromptSetFavorite

()

Fungsi ini meminta Players.LocalPlayer untuk menyukai atau tidak menyukai aset atau bundel yang diberikan.

Parameter

itemId: number

ItemId dari item yang diminta untuk favoritkan.

Nilai Default: ""

itemType: Enum.AvatarItemType

Jenis item yang diminta untuk favoritkan.

Nilai Default: ""

shouldFavorite: boolean

Nilai Default: ""

Memberikan nilai

()

PromptUpdateOutfit

()

Meminta Players.LocalPlayer untuk memperbarui pakaian yang diberikan dengan Deskripsi Humanoid yang diberikan.

Parameter

outfitId: number

The outfitId dari pakaian untuk update.

Nilai Default: ""

updatedOutfit: HumanoidDescription

Deskripsi Humanoid yang mewakili data pakaian baru.

Nilai Default: ""

rigType: Enum.HumanoidRigType

Tipe HumanoidRig untuk memperbarui pakaian ke.

Nilai Default: ""

Memberikan nilai

()

CheckApplyDefaultClothing

Hasil

Kembalikan baru HumanoidDescription dengan properti Shirt dan Pants yang diperbarui jika diperlukan. Kembalikan nil jika pakaian default tidak diperlukan.

Pakaian default diperlukan jika Deskripsi Humanoid tidak saat ini memiliki Kaus dan Celana dilengkapi dan warna tubuh terlalu mirip.

Parameter

humanoidDescription: HumanoidDescription

Deskripsi Humanoid untuk memeriksa apakah pakaian default diperlukan.

Nilai Default: ""

Memberikan nilai

Kembalikan Deskripsi Humanoid jika pakaian default diperlukan. Jika tidak, kembalikan nil .

ConformToAvatarRules

Hasil

Parameter

humanoidDescription: HumanoidDescription

Nilai Default: ""

Memberikan nilai

GetAvatarRules

Hasil

Fungsi ini mengembalikan aturan Avatar platform untuk hal-hal seperti skala, kaus dan celana default, jumlah aset yang dapat dipakai, dll.

Tabel yang dikembalikan termasuk bidang berikut:


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

Memberikan nilai

Kamus yang berisi aturan Avatar platform untuk hal-hal seperti skala, kemeja dan celana default, jumlah aset yang dapat dipakai, dll.Lihat contoh pengembalian di deskripsi utama di atas.

GetBatchItemDetails

Hasil

Mendapatkan detail item untuk daftar item sekaligus.Lebih efisien dari AvatarEditorService:GetItemDetails jika Anda perlu mendapatkan semua rincian item dari daftar.

Parameter

itemIds: Array

Daftar ID item untuk mendapatkan rincian.

Nilai Default: ""

itemType: Enum.AvatarItemType

Jenis ID item yang disediakan.

Nilai Default: ""

Memberikan nilai

Kembalikan array rincian item dengan bidang berikut:


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

Hasil

Fungsi ini kembali jika Players.LocalPlayer memiliki favoritkan bundel atau aset yang diberikan.

Parameter

itemId: number

ID dari aset atau bundel yang ditentukan.

Nilai Default: ""

itemType: Enum.AvatarItemType

The Enum.AvatarItemType dari aset atau bundel yang ditentukan.

Nilai Default: ""

Memberikan nilai

boolean

Apakah LocalPlayer memiliki favorit bundel atau aset yang diberikan.

GetInventory

InventoryPages

Hasil

Kembalikan objek InventoryPages dengan informasi tentang item yang dimiliki di inventaris pengguna dengan AvatarAssetTypes yang diberikan.

Tabel yang dikembalikan termasuk bidang berikut:


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

Parameter

assetTypes: Array

The Enum.AvatarAssetType yang dapat akan diperiksa di inventaris pemain.

Nilai Default: ""

Memberikan nilai

InventoryPages

GetItemDetails

Hasil

Fungsi ini mengembalikan detail item untuk item yang diberikan.Ini menerima dua parameter - yang pertama menunjukkan ID item yang diambil dan yang kedua menunjukkan Enum.ItemType .

Data dikembalikan dalam format:


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

Untuk menanyakan aset terbatas atau tidak terbatas, gunakan nilai berikut itemRestrictions:

Parameter

itemId: number

ID item yang detailnya diambil.

Nilai Default: ""

itemType: Enum.AvatarItemType

Nilai enum yang menunjukkan jenis item yang detailnya diambil.

Nilai Default: ""

Memberikan nilai

Sebuah tabel yang berisi informasi item untuk item yang diambil. Lihat di atas untuk tabel contoh.

GetOutfitDetails

Hasil

Fungsi ini mengembalikan rincian pakaian untuk pakaian yang diberikan. Ini menerima satu parameter: ID pakaian.

Data dikembalikan dalam format berikut:


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

ID pakaian yang detailnya sedang diambil.

Nilai Default: ""

Memberikan nilai

Meja yang berisi informasi pakaian untuk pakaian yang diambil. Lihat di atas untuk tabel contoh.

GetOutfits

OutfitPages

Hasil

Fungsi ini mengembalikan data pakaian untuk Players.LocalPlayer.Ini akan digunakan dengan Players:GetHumanoidDescriptionFromOutfitId() untuk memperbarui karakter pemain ke pakaian.Akses ke ini juga akan tergantung pada AvatarEditorService:PromptAllowInventoryReadAccess() diterima oleh pengguna.

Tabel yang dikembalikan termasuk bidang berikut:


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


<th>ketik</th>

    <th>Deskripsi</th>
  </tr>
</thead>

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

    <td />
  </tr>

  <tr>
    <td>nama</td><td>string</td>

    <td />
  </tr>

  <tr>
    <td>dapat diedit</td><td>boolean</td>

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

Nama

Parameter

outfitSource: Enum.OutfitSource

Nilai Default: "All"

outfitType: Enum.OutfitType

Nilai Default: "All"

Memberikan nilai

OutfitPages

GetRecommendedAssets

Hasil

Kembalikan daftar aset yang direkomendasikan berdasarkan Enum.AssetType.Gunakan ini untuk mengumpulkan daftar aset serupa ke aset yang disediakan.Lihat contoh kode di bawah ini untuk informasi lebih lanjut tentang penggunaan yang mungkin untuk fungsi ini.

Data berada dalam 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

Jenis rekomendasi aset untuk mengambil rekomendasi.Hanya mempengaruhi respons ketika rekomendasi berdasarkan item tidak ada untuk contextAssetId yang diberikan.

Nilai Default: ""

contextAssetId: number

ID aset dengan jenis yang cocok dengan jenis aset yang disediakan yang digunakan untuk konteks saat mengambil rekomendasi.

Nilai Default: 0

Memberikan nilai

Daftar rekomendasi berdasarkan yang diberikan Enum.AssetType .

Contoh Kode

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

Hasil

Fungsi ini men返ikan daftar bundel yang direkomendasikan untuk ID bundel tertentu.

Data berada dalam 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

Daftar bundel yang direkomendasikan.

Nilai Default: ""

Memberikan nilai

ID bundel yang akan dikembalikan untuk bundel yang disarankan.

SearchCatalog

CatalogPages

Hasil

Fungsi ini men返ikan objek CatalogPages yang berisi hasil pencarian yang diberikan.

Data yang dikembalikan memiliki 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

Sebuah objek yang berisi parameter yang digunakan untuk pencarian.

Nilai Default: ""

Memberikan nilai

CatalogPages

Acara

PromptAllowInventoryReadAccessCompleted

Peristiwa ini terjadi ketika perintah AvatarEditorService:PromptAllowInventoryReadAccess() dijawab oleh pengguna.Ini hanya dapat mengembalikan status Kesuksesan atau Izin Ditolak enum karena tidak melakukan permintaan web apa pun yang bisa gagal.

Parameter

Hasil dari prompt.

PromptCreateOutfitCompleted

Acara ini terjadi saat operasi PromptSaveOutfit selesai.Ini memberikan status enum menunjukkan apakah prompt berhasil, gagal, atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

failureType: Variant

PromptDeleteOutfitCompleted

Melepaskan api saat operasi PromptDeleteOutfit selesai.Ini memberikan status enum menunjukkan apakah prompt berhasil, gagal, atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

PromptRenameOutfitCompleted

Melepaskan api saat operasi PromptRenameOutfit selesai.Ini memberikan status enum menunjukkan apakah prompt berhasil, gagal, atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

PromptSaveAvatarCompleted

Peristiwa ini terjadi ketika operasi AvatarEditorService:PromptSaveAvatar() selesai.Ini memberikan status enum menunjukkan apakah prompt berhasil, gagal, atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

Melepaskan api saat operasi AvatarEditorService:PromptSetFavorite() selesai.Ini memberikan status enum menunjukkan apakah prompt berhasil, gagal, atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

PromptUpdateOutfitCompleted

Melepaskan api saat operasi AvatarEditorService:PromptUpdateOutfit() selesai.Ini memberikan status enum menunjukkan apakah prompt berhasil, gagal, atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.