AvatarEditorService

Metode

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():void
Mengizinkan Players.LocalPlayer untuk membaca item yang dimiliki pengguna di inventaris mereka dan informasi editor avatar lainnya.
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Mendesak Class.Players.LocalPlayer untuk menyimpan Class.HumanoidDescription yang diberikan sebagai pakaian.
PromptDeleteOutfit(outfitId : number):void
Mendesak Class.Players.LocalPlayer untuk menghapus pakaian yang diberikan.
PromptRenameOutfit(outfitId : number):void
Mendesak Class.Players.LocalPlayer untuk mengubah nama pakaian yang diberikan.
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Mendesak Players.LocalPlayer untuk meningkatkan avatar mereka berdasarkan HumanoidDescription dan Enum.RigType R6 atau R15.
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : bool):void
Mengundang Class.Players.LocalPlayer untuk menyukai atau menyukai item yang diberikan.
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Mendesak Class.Players.LocalPlayer untuk menyetujui pembaruan pakaian yang diberikan.
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
Hasil
Digunakan untuk menerapkan pakaian default ke HumanoidDescription jika perlu.
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
Hasil
GetAvatarRules():Dictionary
Hasil
Mengembalikan aturan Avatar platform untuk hal-hal seperti menyesuaikan, pakaian dan celana default, dan jumlah aset yang dapat dikenakan.
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
Hasil
Mendapatkan rincian item untuk daftar item sekaligus.
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):bool
Hasil
Mengembalikan jika Players.LocalPlayer telah menyukai bundel atau aset yang diberikan.
GetInventory(assetTypes : Array):InventoryPages
Hasil
Mengembalikan objek InventoryPages dengan informasi tentang item yang dimiliki di inventaris pengguna dengan AvatarAssetTypes yang diberikan.
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
Hasil
Mengembalikan detail item untuk item yang diberikan.
GetOutfitDetails(outfitId : number):Dictionary
Hasil
Mengembalikan rincian pakaian untuk pakaian yang diberikan.
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
Hasil
Mengembalikan data pakaian untuk Players.LocalPlayer .
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
Hasil
Mengembalikan daftar sumber daya yang direkomendasikan berdasarkan Enum.AssetType dan id sumber daya.
GetRecommendedBundles(bundleId : number):Array
Hasil
Mengembalikan daftar bundel yang direkomendasikan untuk id bundel tertentu.
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
Hasil
Mengembalikan objek CatalogPages yang berisi hasil pencarian yang diberikan.

Acara

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

Properti

Metode

PromptAllowInventoryReadAccess

void

Mengizinkan Players.LocalPlayer untuk membaca item yang dimiliki pengguna di inventaris mereka dan informasi avatar editor lainnya. Prompt harus dikonfirmasi oleh pengguna untuk memungkinkan pengembang untuk menggunakan Class.AvatarEditorService:GetInventory()

Memberikan nilai

void

PromptCreateOutfit

void

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

Parameter

outfit: HumanoidDescription

Outfit yang akan diminta oleh pemain untuk dibuat.

rigType: Enum.HumanoidRigType

ENSEMBLE.RIGTYPE yang akan dibuat kostum jika pemain mengkonfirmasi permintaan.

Memberikan nilai

void

PromptDeleteOutfit

void

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

Parameter

outfitId: number

Id pakaian yang akan dihapus.

Memberikan nilai

void

PromptRenameOutfit

void

Mendesak Players.LocalPlayer untuk mengubah nama pakaian yang diberikan. Tidak menghasilkan. Hasil dapat diambil dengan mendengarkan acara AvatarEditorService.PromptRenameOutfitCompleted .

Parameter

outfitId: number

Id pakaian yang akan diubah.

Memberikan nilai

void

PromptSaveAvatar

void

Fungsi ini meminta Players.LocalPlayer untuk menyelesaikan avatar mereka berdasarkan HumanoidDescription dan Enum.RigType (R6 atau R15). Tidak menghasilkan dan dapat mengumpulkan hasil dengan mendengarkan acara PromptSaveAvatarCompleted. Ini mirip dengan cara lain sepert

Parameter

humanoidDescription: HumanoidDescription

Class.HumanoidDescription yang diberitahu untuk disimpan.

rigType: Enum.HumanoidRigType

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

Memberikan nilai

void

PromptSetFavorite

void

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

Parameter

itemId: number

ItemId item yang diminta untuk favoritkan.

itemType: Enum.AvatarItemType

Jenis item yang diminta untuk favoritkan.

shouldFavorite: bool

Memberikan nilai

void

PromptUpdateOutfit

void

Mendesak Class.Players.LocalPlayer untuk menyelesaikan pakaian yang diberikan dengan HumanoidDescription yang diberikan.

Parameter

outfitId: number

Id pakaian untuk update.

updatedOutfit: HumanoidDescription

Deskripsi Manusia yang mewakili data pakaian baru.

rigType: Enum.HumanoidRigType

The HumanoidRigType untuk menyetel pakaian ke.

Memberikan nilai

void

CheckApplyDefaultClothing

Hasil

Mengembalikan HumanoidDescription baru dengan kepemiluan Shirt dan Pants jika perlu. Mengembalikan nol jika pakaian default tidak diperlukan.

Pakaian default diperlukan jika HumanoidDescription saat ini tidak memiliki Shirt dan Pants yang dilengkapi dan warna tubuh terlalu mirip.

Parameter

humanoidDescription: HumanoidDescription

Deskripsi Humanoid untuk memeriksa apakah pakaian default diperlukan.

Memberikan nilai

Mengembalikan Deskripsi Manusia jika pakaian default diperlukan. Jika tidak, mengembalikan nol.

ConformToAvatarRules

Hasil

Parameter

humanoidDescription: HumanoidDescription

Memberikan nilai

GetAvatarRules

Hasil

Fungsi ini mengembalikan aturan platform Avatar untuk hal-hal seperti menyesuaikan, mengenakan pakaian dan celana, jumlah aset yang dapat dikenakan, dll.

Tabel yang dikembalikan mencakup beberapa 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

Sebuah kamus mengandung aturan platform Avatar untuk hal-hal seperti menyesuaikan, mengenakan pakaian dan celana, jumlah aset yang dapat dikenakan, dll. Lihat contoh kembali di deskripsi utama di atas.

GetBatchItemDetails

Hasil

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

Parameter

itemIds: Array

Daftar item id untuk mendapatkan rincian.

itemType: Enum.AvatarItemType

Jenis item ID yang diberikan.

Memberikan nilai

Mengembalikan array rincian item dengan item 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

bool

Hasil

Fungsi ini kembali jika Players.LocalPlayer telah menyukai bundle atau aset yang diberikan.

Parameter

itemId: number

Id dari aset atau bundel yang ditentukan.

itemType: Enum.AvatarItemType

ENSEARCH_AVATAR_ITEMS dari aset atau bundel yang ditentukan.

Memberikan nilai

bool

Apakah LocalPlayer telah menyukai bundel atau aset yang diberikan.

GetInventory

InventoryPages

Hasil

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

Tabel yang dikembalikan mencakup beberapa bidang berikut:


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

Parameter

assetTypes: Array

ENSEMBLE.AVATARASHIELD yang dapat diperiksa di inventaris pemain.

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 mencari aset terbatas atau tak terbatas, gunakan nilai itemRestrictions berikut:

Parameter

itemId: number

ID item yang diambil dari rincian.

itemType: Enum.AvatarItemType

Nilai枚 yang menunjukkan jenis item cuplikan yang diambil.

Memberikan nilai

Tabel yang berisi informasi item untuk item yang diambil. Lihat di atas untuk tabel sampel.

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 dari pakaian yang whose rincian diambil.

Memberikan nilai

Tabel yang berisi informasi pakaian untuk pakaian yang diambil. Lihat di atas untuk tabel sampel.

GetOutfits

OutfitPages

Hasil

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

Tabel yang dikembalikan mencakup beberapa bidang berikut:


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


<tbody>
  <tr>
    <td>pengenal</td>
    <td>int</td>

    <td />
  </tr>

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

    <td />
  </tr>

  <tr>
    <td>Bisa Disedit</td>
    <td>boolean</td>

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

Nama	ketik	Deskripsi

Parameter

outfitSource: Enum.OutfitSource

Nilai Default: "All"

outfitType: Enum.OutfitType

Nilai Default: "All"

Memberikan nilai

OutfitPages

GetRecommendedAssets

Hasil

Mengembalikan daftar aset yang direkomendasikan berdasarkan Enum.AssetType dan id aset. Gunakan ini untuk mengumpulkan daftar aset serupa untuk aset yang disediakan. Lihat contoh kode di bawah ini untuk lebih banyak informasi tentang kemungkinan penggunaan untuk fungsi ini.

Data 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 mengubah respons saat rekomendasi berdasar item tidak ada untuk contextAssetId yang diberikan.

contextAssetId: number

Id dari aset dengan jenis yang cocok dengan aset yang disediakan untuk konteks saat mengambil rekomendasi.

Nilai Default: 0

Memberikan nilai

Daftar rekomendasi berdasarkan yang diberikan Enum.AssetType .

Contoh Kode

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 mengembalikan daftar bundel yang direkomendasikan untuk id bundel tertentu.

Data 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.

Memberikan nilai

ID bundel yang direkomendasikan akan dikembalikan untuk.

SearchCatalog

CatalogPages

Hasil

Fungsi ini mengembalikan 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 mengandung parameter yang digunakan untuk pencarian.

Memberikan nilai

CatalogPages

Acara

PromptAllowInventoryReadAccessCompleted

Acara ini diaktifkan ketika AvatarEditorService:PromptAllowInventoryReadAccess() diketuk oleh pengguna. Ini hanya dapat mengembalikan status enum sebagai ia tidak mengeksekkan isi web mana pun yang mungkin gagal.

Parameter

Hasil dari prompt.

PromptCreateOutfitCompleted

Acara ini diaktifkan ketika operasi PromptSaveOutfit selesai. Ini menunjukkan status enum yang menunjukkan apakah prompt berhasil, gagal atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

failureType: Variant

PromptDeleteOutfitCompleted

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

Parameter

Hasil dari prompt.

PromptRenameOutfitCompleted

Diaktifkan saat operasi PromptRenameOutfit selesai. Memberikan status enum yang menunjukkan apakah prompt berhasil, gagal atau izin tidak diberikan oleh pengguna.

Parameter

Hasil dari prompt.

PromptSaveAvatarCompleted

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

Parameter

Hasil dari prompt.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

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

Parameter

Hasil dari prompt.

PromptUpdateOutfitCompleted

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

Parameter

Hasil dari prompt.