AvatarEditorService

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

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

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

AvatarEditorService เป็นบริการที่สนับสนุนนักพัฒนา Avatar Editor ให้มีสมรู้ระเบียบอก วิธีการเปลี่ยนแปลง อวาตาร์ของผู้เล่น คลังไอเท็มและรายละเอียดเกี่ยวกับแคตตาล็อก

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ เครื่องมือแก้ไขอวาตาร์โปรดดู บริการ Avatar Editor

คันเร่ง

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

สำหรับแต่ละประสบการณ์, การปรับความเร็วนี้จะช่วยให้คุณสามารถส่งได้มากถึง 100 คำขอต่อวินาทีไปยัง AvatarEditorService ตรงกับวิธีการจัดการของเรา หากเกินขีดจำกัดเหล่านี

หากคุณพบว่าประสบการณ์ของคุณต้องการการปรับแต่งนี้คุณสามารถส่งคำขอคุณสมบัติ คุณสมบัติ

สรุป

วิธีการ

อีเวนต์

คุณสมบัติ

วิธีการ

GetAccessoryType

พารามิเตอร์

avatarAssetType: Enum.AvatarAssetType

ส่งค่ากลับ

PromptAllowInventoryReadAccess

void

เรียกร้องให้ Players.LocalPlayer เพื่อให้ผู้พัฒนาสามารถอ่านไอเท็มที่ผู้ใช้มีในคลังของพวกเขาและข้อมูลอื่น ��


ส่งค่ากลับ

void

PromptCreateOutfit

void

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

พารามิเตอร์

ชุด Outfit

ENSEMBLE.RIGTYPE ที่จะสร้างชุดเมื่อผู้เล่นยืนยันการแจ้งเตือน


ส่งค่ากลับ

void

PromptDeleteOutfit

void

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

พารามิเตอร์

outfitId: number

รหัสชุดที่จะลบ


ส่งค่ากลับ

void

PromptRenameOutfit

void

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

พารามิเตอร์

outfitId: number

รหัสชุดที่จะเปลี่ยนชื่อ


ส่งค่ากลับ

void

PromptSaveAvatar

void

ระบบนี้เรียกให้ Players.LocalPlayer ปรับปรุง avatar ของพวกเขาตามที่ได้รับ HumanoidDescription และ Enum.RigType (R6 หรือ R15) ไม่ได้ผลลัพธ์และสา

พารามิเตอร์

humanoidDescription: HumanoidDescription

กำลังเรียกให้ HumanoidDescription ที่ให้ไว้เก็บไว้

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


ส่งค่ากลับ

void

PromptSetFavorite

void

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

พารามิเตอร์

itemId: number

รหัสรายการที่ได้รับการโปรดปราน

ประเภทของรายการที่ได้รับการโปรดปราน

shouldFavorite: bool

ส่งค่ากลับ

void

PromptUpdateOutfit

void

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

พารามิเตอร์

outfitId: number

อัปเดต

updatedOutfit: HumanoidDescription

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

The HumanoidRigType เพื่อปรับแต่งชุด


ส่งค่ากลับ

void

CheckApplyDefaultClothing

ผลตอบแทน

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

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

พารามิเตอร์

humanoidDescription: HumanoidDescription

คำอธิบายของมนุษย์เพื่อตรวจสอบว่ามีความจำเป็นต้องใส่เสื้อผ้าปกติหรือไม่


ส่งค่ากลับ

กลับค่า HumanoidDescription ถ้าเป็นเครื่องแต่งกายปกติ แต่ถ้าไม่ใช่ ก็จะกลับค่า 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
}

ส่งค่ากลับ

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

GetBatchItemDetails

ผลตอบแทน

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

พารามิเตอร์

itemIds: Array

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

รุ่นของรหัสไอเท็มที่ให้


ส่งค่ากลับ

กลับรายละเอียดรายการด้วยรายละเอียดของไอเท็มต่อไปนี้:


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

ชุดรวม

Menu.AvatarItemType ชุดรวม


ส่งค่ากลับ

ว่า LocalPlayer ได้โปรดปรานพักผ่อนให้กับชุดหรือสินค้าคงคลังที่ได้รับ

GetInventory

ผลตอบแทน

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

ตารางที่กลับมารวมถึงข้อมูลต่อไปนี้:


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

พารามิเตอร์

assetTypes: Array

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

| itemRestrictions | จำกัดหรือไม่จำกัด | | :--------------: | :-------------------: | | empty | ไม่จำกัด | Collectible | จำกัด Roblox ได้ | | Limited | UGC จำกัด |

พารามิเตอร์

itemId: number

รหัสของรายการที่รายละเอียดของมันกำลังถูกดึงออก

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


ส่งค่ากลับ

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

GetOutfitDetails

ผลตอบแทน

ระบบนี้กลับรายละเอียดชุดสำหรับชุดที่ให้ไว้ มันยอมรับปารามิเตอร์หนึ่ง: รหัสของชุด

ผลลัพธ์ข้อมูลในรูปแบบต่อไปนี้:


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

รหัสของชุดที่รายละเอียดกำลังถูกดึงออก


ส่งค่ากลับ

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

GetOutfits

ผลตอบแทน

ระบบนี้จะส่งข้อมูลชุดสําหรับ Players.LocalPlayer นี้ ข้อมูลนี้จะใช้กับ Players:GetHumanoidDescriptionFromOutfitId() เพื่ออัปเดตตัวละครผู้เล่นให้เป็นชุด การเข้

ตารางที่กลับมารวมถึงข้อมูลต่อไปนี้:


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

<tbody>
<tr>
<td>รหัส</td>
<td>ตัว</td>
<td />
</tr>
<tr>
<td>ชื่อ</td>
<td>สตริง</td>
<td />
</tr>
<tr>
<td>เป็นได้แก้ไข</td>
<td>บูลีน</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

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

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

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

พารามิเตอร์

ผลของคำถาม

failureType: Variant

PromptDeleteOutfitCompleted

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

พารามิเตอร์

ผลของคำถาม


PromptRenameOutfitCompleted

เปิดให้บริการเมื่อการดำเนินการ PromptRenameOutfit เสร็จสิ้น มันให้สถานะ enum ที่ระบุว่าว่าบรรยากาศสำเร็จหรือไม่สำเร็จหรือไม่ได้รับอนุญาตโดยผู้ใช้

พารามิเตอร์

ผลของคำถาม


PromptSaveAvatarCompleted

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

พารามิเตอร์

ผลของคำถาม

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

เปิดให้บริการเมื่อการดำเนินการ AvatarEditorService:PromptSetFavorite() สำเร็จ ให้สถานะ enum ที่แสดงผลว่าว่าประกาศนี้ประสบความสำเร็จหรือไม่สำเร็จ หรือไม่ได้รับการอนุญาตโดยผู

พารามิเตอร์

ผลของคำถาม


PromptUpdateOutfitCompleted

เปิดให้บริการเมื่อการดำเนินการ AvatarEditorService:PromptUpdateOutfit() สำเร็จ ให้สถานะ enum ที่แสดงผลว่าว่าประกาศนี้ประสบความสำเร็จหรือไม่สำเร็จ หรือไม่ได้รับการอนุญาตโดยผู

พารามิเตอร์

ผลของคำถาม