AvatarEditorService

แสดงที่เลิกใช้งานแล้ว

*เนื้อหานี้แปลโดยใช้ AI (เวอร์ชัน Beta) และอาจมีข้อผิดพลาด หากต้องการดูหน้านี้เป็นภาษาอังกฤษ ให้คลิกที่นี่

ไม่สามารถสร้าง
บริการ
ไม่ซ้ำ

บริการ AvatarEditorService คลังไอเท็ม, ขอข้อมูลเกี่ยวกับสินค้าคงคลังของผู้ใช้, และขอข้อมูลเกี่ยวกับแคตตาล็อก

เครื่องมือแก้ไขอวาตาร์ดูที่ บริการตัวแก้ไขอวตาร

การลดความเร็ว

จุดสิ้นสุดต่อไปนี้บน AvatarEditorService มีการจำกัดระดับประสบการณ์:

สำหรับประสบการณ์แต่ละครั้ง การจำกัดการส่งนี้ช่วยให้คุณสามารถส่งคำขอได้ถึง 100 คำขอต่อวินาทีไปยังจุดสิ้นสุด AvatarEditorService เหล่านี้ ไม่ว่าจะเป็นจำนวนเซิร์ฟเวอร์หรือจํานวนผู้ใช้เกินขีดจํากัดเหล่านี้จะส่งคืนข้อผิดพลาด 429 Too Many Requests

หากคุณพบว่าประสบการณ์ของคุณต้องการการปรับเปลี่ยนเพื่อลดความเร็วนี้คุณสามารถส่งคำขอคุณสมบัติ ได้

สรุป

วิธีการ

อีเวนต์

คุณสมบัติ

วิธีการ

GetAccessoryType

พารามิเตอร์

avatarAssetType: Enum.AvatarAssetType
ค่าเริ่มต้น: ""

ส่งค่ากลับ

PromptAllowInventoryReadAccess

()

ขอให้ Players.LocalPlayer เพื่ออนุญาตให้นักพัฒนาอ่านรายการที่ผู้ใช้มีในสินค้าคงคลังและข้อมูลที่เกี่ยวข้องกับเครื่องมือตัดต่ออวตารอื่นๆต้องมีการยืนยันคำขอโดยผู้ใช้เพื่อให้นักพัฒนาสามารถใช้ AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() และ AvatarEditorService:GetFavorite() ได้สิทธิ์ไม่คงอยู่ระหว่างเซสชัน


ส่งค่ากลับ

()

PromptCreateOutfit

()

ส่งคำเตือนให้ Players.LocalPlayer บันทึก HumanoidDescription ที่กำหนดเป็นชุด ไม่ยอมแพ้ ผลลัพธ์สามารถดึงได้โดยฟังอีเวนต์ AvatarEditorService.PromptCreateOutfitCompleted

พารามิเตอร์

The Outfit ที่ผู้เล่นจะถูกขอให้สร้าง

ค่าเริ่มต้น: ""

The Enum.RigType ที่ชุดจะถูกสร้างขึ้นหากผู้เล่นยืนยันคำเตือน

ค่าเริ่มต้น: ""

ส่งค่ากลับ

()

PromptDeleteOutfit

()

เรียกให้ Players.LocalPlayer ลบชุดที่กำหนด ไม่ส่งคืน ผลลัพธ์สามารถดึงได้โดยฟังเหตุการณ์ AvatarEditorService.PromptDeleteOutfitCompleted

พารามิเตอร์

outfitId: number

outfitId ของชุดที่จะลบ

ค่าเริ่มต้น: ""

ส่งค่ากลับ

()

PromptRenameOutfit

()

ส่งคำเตือนให้ Players.LocalPlayer เปลี่ยนชื่อชุดที่กำหนด ไม่ส่งผล ผลลัพธ์สามารถดึงได้โดยฟังอีเวนต์ AvatarEditorService.PromptRenameOutfitCompleted

พารามิเตอร์

outfitId: number

outfitId ของชุดที่จะเปลี่ยนชื่อ

ค่าเริ่มต้น: ""

ส่งค่ากลับ

()

PromptSaveAvatar

()

ฟังก์ชันนี้จะขอให้ Players.LocalPlayer อัปเดตอวตารของพวกเขาตามที่ให้ไว้ HumanoidDescription และ Enum.RigType (R6 หรือ R15)ไม่ส่งและสามารถรับผลลัพธ์ได้โดยฟังอีเวนต์ PromptSaveAvatarCompletedนี่คล้ายกับวิธีที่คําถามอื่นๆ เช่น PromptPurchase ทํางาน

พารามิเตอร์

humanoidDescription: HumanoidDescription

ที่ให้ HumanoidDescription ถูกขอให้บันทึก

ค่าเริ่มต้น: ""

The Enum.RigType ที่อวตารจะถูกบันทึกไว้หากผู้เล่นยืนยันคำเตือน

ค่าเริ่มต้น: ""

ส่งค่ากลับ

()

PromptSetFavorite

()

ฟังก์ชันนี้จะขอให้ Players.LocalPlayer ชุดรวม

พารามิเตอร์

itemId: number

ItemId ของรายการที่ถูกขอให้เป็นรายการโปรด

ค่าเริ่มต้น: ""

ประเภทของรายการที่ถูกขอให้เป็นรายการโปรด

ค่าเริ่มต้น: ""
shouldFavorite: boolean
ค่าเริ่มต้น: ""

ส่งค่ากลับ

()

PromptUpdateOutfit

()

ส่งคำขอให้ Players.LocalPlayer อัปเดตชุดที่กำหนดด้วยคําอธิบายมนุษย์ที่กำหนดไว้

พารามิเตอร์

outfitId: number

outfitId ของชุดที่จะอัปเดต

ค่าเริ่มต้น: ""
updatedOutfit: HumanoidDescription

คําอธิบายมนุษย์ที่แทนที่ข้อมูลชุดใหม่

ค่าเริ่มต้น: ""

HumanoidRigType เพื่ออัปเดตชุด

ค่าเริ่มต้น: ""

ส่งค่ากลับ

()

CheckApplyDefaultClothing

ผลตอบแทน

คืนค่าใหม่ HumanoidDescription ด้วยคุณสมบัติเสื้อและกางเกงที่อัปเดตหากจำเป็น คืน nil หากเสื้อผ้าเริ่มต้นไม่จำเป็น

เสื้อผ้าเริ่มต้นจำเป็นหาก HumanoidDescription ไม่มีเสื้อและกางเกงติดตั้งและสีผิวของร่างกายมีความคล้ายคลึงกันเกินไป

พารามิเตอร์

humanoidDescription: HumanoidDescription

คําอธิบาย Humanoid เพื่อตรวจสอบว่าจำเป็นต้องสวมใส่เสื้อผ้าเริ่มต้นหรือไม่

ค่าเริ่มต้น: ""

ส่งค่ากลับ

คืนคำอธิบายมนุษย์หากเสื้อผ้าเริ่มต้นจำเป็น มิฉะนั้นจะคืน nil

ConformToAvatarRules

ผลตอบแทน

พารามิเตอร์

humanoidDescription: HumanoidDescription
ค่าเริ่มต้น: ""

ส่งค่ากลับ

GetAvatarRules

ผลตอบแทน

ฟังก์ชันนี้ส่งกลับกฎ Avatar ของแพลตฟอร์มสำหรับสิ่งต่างๆ เช่น การปรับขนาด เสื้อและกางเกงเริ่มต้น จํานวนสินทรัพย์ที่สามารถสวมใส่ได้ เป็นต้น

ตารางที่ส่งคืนรวมถึงฟิลด์ต่อไปนี้:


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

ส่งค่ากลับ

สารานุกรมที่มีกฎของอวาตาร์แพลตฟอร์มสำหรับสิ่งต่างๆ เช่น การปรับขนาด เสื้อและกางเกงเริ่มต้น จํานวนสินทรัพย์ที่สามารถสวมใส่ได้ เป็นต้นดูตัวอย่างการคืนในคำอธิบายหลักด้านบน

GetBatchItemDetails

ผลตอบแทน

รับรายละเอียดของรายการสำหรับรายการทั้งหมดในครั้งเดียวมีประสิทธิภาพมากกว่า AvatarEditorService:GetItemDetails หากคุณต้องการรับรายละเอียดทั้งหมดของรายการ

พารามิเตอร์

itemIds: Array

รายการรหัสไอเทมที่จะได้รายละเอียด

ค่าเริ่มต้น: ""

ประเภทของ ID รายการที่ให้

ค่าเริ่มต้น: ""

ส่งค่ากลับ

คืนรายละเอียดของรายการด้วยฟิลด์ต่อไปนี้:


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

ผลตอบแทน

ฟังก์ชันนี้จะ返回หาก Players.LocalPlayer ได้รับความชื่นชอบจากแพคเกจหรือสินทรัพย์ที่กำหนด

พารามิเตอร์

itemId: number

ชุดรวม

ค่าเริ่มต้น: ""

The Enum.AvatarItemType ชุดรวม

ค่าเริ่มต้น: ""

ส่งค่ากลับ

ว่า LocalPlayer ได้โปรดแพคเกจหรือสินทรัพย์ที่กำหนดหรือไม่

GetInventory

ผลตอบแทน

ส่งคืนวัตถุ InventoryPages ที่มีข้อมูลเกี่ยวกับไอเทมที่มีอยู่ในสินค้าคงคลังของผู้ใช้ด้วย AvatarAssetTypes ที่กำหนด

ตารางที่ส่งคืนรวมถึงฟิลด์ต่อไปนี้:


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

พารามิเตอร์

assetTypes: Array

The Enum.AvatarAssetType คลังไอเท็ม

ค่าเริ่มต้น: ""

ส่งค่ากลับ

GetItemDetails

ผลตอบแทน

ฟังก์ชันนี้คืนรายละเอียดของไอเทมสำหรับไอเทมที่กำหนดไว้มันรับปารามิเตอร์สองตัว - อันแรกบ่งบอกถึงรหัสของรายการที่กำลังดึงและอันที่สองบ่งบอกถึง Enum.ItemType ของมัน

ข้อมูลที่ส่งคืนในรูปแบบ:


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

เพื่อค้นหาสินทรัพย์ที่จํากัดหรือไม่จํากัด ให้ใช้ค่าต่อไปนี้ itemRestrictions ค่า:

| ข้อจํากัดของรายการ | จํากัดหรือไม่จํากัด | | :--------------: | :-------------------: | | empty | ไม่จํากัด | | Collectible | UGC จํากัด | | Limited | Roblox Limited Unique | | LimitedUnique | Roblox Limited Unique |

พารามิเตอร์

itemId: number

ID ของรายการที่รายละเอียดถูกดึงมา

ค่าเริ่มต้น: ""

ค่า enum ที่บ่งบอกถึงประเภทของรายการที่รายละเอียดถูกดึงมา

ค่าเริ่มต้น: ""

ส่งค่ากลับ

ไอเท็มดูตัวอย่างตารางด้านบน

GetOutfitDetails

ผลตอบแทน

ฟังก์ชันนี้ส่งรายละเอียดเครื่องแต่งกายสำหรับเครื่องแต่งกายที่กำหนด มันรับพารามิเตอร์หนึ่งอย่างคือ ID ของเครื่องแต่งกาย

การคืนข้อมูลในรูปแบบต่อไปนี้:


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

พารามิเตอร์

outfitId: number

ID ของชุดที่รายละเอียดถูกดึงมา

ค่าเริ่มต้น: ""

ส่งค่ากลับ

ตารางที่มีข้อมูลเกี่ยวกับชุดสำหรับชุดที่ดึงมา ดูตัวอย่างตารางด้านบน

GetOutfits

ผลตอบแทน

ฟังก์ชันนี้ส่งคืนข้อมูลเครื่องแต่งกายสำหรับ Players.LocalPlayerนี้จะถูกใช้กับ Players:GetHumanoidDescriptionFromOutfitId() เพื่ออัปเดตตัวละครผู้เล่นไปยังชุดการเข้าถึงนี้ยังขึ้นอยู่กับ AvatarEditorService:PromptAllowInventoryReadAccess() ที่ได้รับการยอมรับจากผู้ใช้

ตารางที่ส่งคืนรวมถึงฟิลด์ต่อไปนี้:


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

<th>พิมพ์</th>
<th>คําอธิบาย</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td><td>คิด</td>
<td />
</tr>
<tr>
<td>ชื่อ</td><td>สตริง</td>
<td />
</tr>
<tr>
<td>สามารถแก้ไขได้</td><td>boolean</td>
<td />
</tr>
</tbody>
ชื่อ

พารามิเตอร์

outfitSource: Enum.OutfitSource
ค่าเริ่มต้น: "All"
outfitType: Enum.OutfitType
ค่าเริ่มต้น: "All"

ส่งค่ากลับ

GetRecommendedAssets

ผลตอบแทน

ส่งคืนรายการของสินทรัพย์ที่แนะนำตาม Enum.AssetType และรหัสสินทรัพย์ที่กำหนดใช้สิ่งนี้เพื่อรวบรวมรายการของสินทรัพย์ที่คล้ายกับสินทรัพย์ที่ให้ไว้ดูตัวอย่างโค้ดด้านล่างสำหรับข้อมูลเพิ่มเติมเกี่ยวกับการใช้งานที่เป็นไปได้สำหรับฟังก์ชันนี้

ข้อมูลอยู่ในรูปแบบ:


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

พารามิเตอร์

ประเภทของคำแนะนำสำหรับการดึงคำแนะนำสำหรับส่งผลเฉพาะตอนที่คำแนะนำขึ้นอยู่กับรายการไม่มีอยู่สำหรับ contextAssetId ที่กำหนด

ค่าเริ่มต้น: ""
contextAssetId: number

รหัสของสินทรัพย์ที่มีประเภทตรงกับประเภทที่ให้ไว้ใช้สำหรับบริบทเมื่อดึงคำแนะนำ

ค่าเริ่มต้น: 0

ส่งค่ากลับ

รายการของคำแนะนำที่ขึ้นอยู่กับ Enum.AssetType ที่กำหนด

ตัวอย่างโค้ด

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

ผลตอบแทน

ฟังก์ชันนี้จะคืนรายการของแพคเกจที่แนะนำสำหรับรหัสแพคเกจที่กำหนดไว้

ข้อมูลอยู่ในรูปแบบ:


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

พารามิเตอร์

bundleId: number

รายการชุดที่แนะนำ

ค่าเริ่มต้น: ""

ส่งค่ากลับ

รหัสแพคเกจที่แพคเกจที่แนะนำจะถูกส่งคืน

SearchCatalog

ผลตอบแทน

ฟังก์ชันนี้จะคืนวัตถุ CatalogPages ที่มีผลลัพธ์ของการค้นหาที่กำหนด

ข้อมูลที่ส่งคืนมีรูปแบบ:


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

พารามิเตอร์

searchParameters: CatalogSearchParams

วัตถุที่มีพารามิเตอร์ที่ใช้สำหรับการค้นหา

ค่าเริ่มต้น: ""

ส่งค่ากลับ

อีเวนต์

PromptAllowInventoryReadAccessCompleted

อีเวนต์นี้จะเกิดขึ้นเมื่อคําแนะนํา AvatarEditorService:PromptAllowInventoryReadAccess() ได้รับการตอบโดยผู้ใช้มันสามารถคืนสถานะความสําเร็จหรือการปฏิเสธสิทธิ์ได้เท่านั้น enum เนื่องจากไม่ได้ดําเนินการตามคําขอเว็บใดๆ ที่อาจล้มเหลว

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน


PromptCreateOutfitCompleted

อีเวนต์นี้จะเกิดขึ้นเมื่อการดำเนินการบันทึกชุดแบบรวดเร็วสําเร็จมันให้สถานะ enum บ่งบอกว่าแจ้งเตือนสําเร็จ ล้มเหลว หรือไม่ได้รับอนุญาตจากผู้ใช้

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน

failureType: Variant

PromptDeleteOutfitCompleted

เกิดไฟไหม้เมื่อการดำเนินการ PromptDeleteOutfit สําเร็จมันให้สถานะ enum บ่งบอกว่าแจ้งเตือนสําเร็จ ล้มเหลว หรือไม่ได้รับอนุญาตจากผู้ใช้

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน


PromptRenameOutfitCompleted

เกิดไฟไหม้เมื่อการดำเนินการเปลี่ยนชื่อเครื่องแต่งกายส่วนบุคคลสําเร็จมันให้สถานะ enum บ่งบอกว่าแจ้งเตือนสําเร็จ ล้มเหลว หรือไม่ได้รับอนุญาตจากผู้ใช้

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน


PromptSaveAvatarCompleted

อีเวนต์นี้จะเกิดขึ้นเมื่อการดำเนินการ AvatarEditorService:PromptSaveAvatar() สําเร็จมันให้สถานะ enum บ่งบอกว่าแจ้งเตือนสําเร็จ ล้มเหลว หรือไม่ได้รับอนุญาตจากผู้ใช้

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

จะเกิดไฟไหม้เมื่อการดำเนินการ AvatarEditorService:PromptSetFavorite() สําเร็จมันให้สถานะ enum บ่งบอกว่าแจ้งเตือนสําเร็จ ล้มเหลว หรือไม่ได้รับอนุญาตจากผู้ใช้

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน


PromptUpdateOutfitCompleted

จะเกิดไฟไหม้เมื่อการดำเนินการ AvatarEditorService:PromptUpdateOutfit() สําเร็จมันให้สถานะ enum บ่งบอกว่าแจ้งเตือนสําเร็จ ล้มเหลว หรือไม่ได้รับอนุญาตจากผู้ใช้

พารามิเตอร์

ผลลัพธ์ของการแจ้งเตือน