AvatarEditorService

사용되지 않는 항목 표시

*이 콘텐츠는 AI(베타)를 사용해 번역되었으며, 오류가 있을 수 있습니다. 이 페이지를 영어로 보려면 여기를 클릭하세요.

만들 수 없음
서비스
복제되지 않음

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 이벤트를 수신하여 검색할 수 있습니다.

매개 변수

플레이어가 생성하도록 요청받는 Outfit 입니다.

기본값: ""

플레이어가 프롬프트를 확인하면 생성될 의상의 Enum.RigType

기본값: ""

반환

()

PromptDeleteOutfit

()

Players.LocalPlayer에 지정된 의상을 삭제하도록 프롬프트합니다. 결과는 AvatarEditorService.PromptDeleteOutfitCompleted 이벤트를 수신하여 검색할 수 있습니다.

매개 변수

outfitId: number

삭제할 의상의 아이디.

기본값: ""

반환

()

PromptRenameOutfit

()

Players.LocalPlayer에 지정된 의상의 이름을 바꾸라는 메시지를 표시합니다. 결과는 수신하는 AvatarEditorService.PromptRenameOutfitCompleted 이벤트를 통해 검색할 수 있습니다.

매개 변수

outfitId: number

이름을 바꿀 의상의 아이디.

기본값: ""

반환

()

PromptSaveAvatar

()

이 함수는 주어진 Players.LocalPlayerHumanoidDescription (R6 또는 R15)에 따라 아바타를 업데이트하도록 Enum.RigType 를 요청합니다.생성하지 않고 PromptSaveAvatarCompleted 이벤트를 수신하여 결과를 얻을 수 있습니다.이는 PromptPurchase와 같은 다른 프롬프트의 작동 방식과 유사합니다.

매개 변수

humanoidDescription: HumanoidDescription

저장할 지정된 HumanoidDescription가 요청됩니다.

기본값: ""

플레이어가 프롬프트를 확인하면 저장될 아바타의 Enum.RigType입니다.

기본값: ""

반환

()

PromptSetFavorite

()

이 함수는 Players.LocalPlayer 에게 지정된 자산이나 번들즐겨찾기 또는 즐겨찾기 해제하도록 요청합니다.

매개 변수

itemId: number

즐겨찾기로 지정할 아이템의 ItemId.

기본값: ""

즐겨찾기로 지정할 아이템의 유형.

기본값: ""
shouldFavorite: boolean
기본값: ""

반환

()

PromptUpdateOutfit

()

Players.LocalPlayer에 지정된 의상을 업데이트하여 지정된 HumanoidDescription으로 업데이트하도록 요청합니다.

매개 변수

outfitId: number

업데이트할 의상의 아이디.

기본값: ""
updatedOutfit: HumanoidDescription

새로운 의상 데이터를 나타내는 휴머노이드 설명.

기본값: ""

업데이트할 의상의 HumanoidRigType.

기본값: ""

반환

()

CheckApplyDefaultClothing

생성

필요한 경우 셔츠 및 바지 속성이 업데이트된 새로운 HumanoidDescription를 반환합니다. 기본 의류가 필요하지 않은 경우 nil를 반환합니다.

HumanoidDescription에 현재 셔츠와 바지가 장착되어 있지 않고 신체 색상이 너무 비슷하면 기본 의류가 필요합니다.

매개 변수

humanoidDescription: HumanoidDescription

기본 의류가 필요한지 확인하기 위한 HumanoidDescription.

기본값: ""

반환

기본 의류가 필요한 경우 HumanoidDescription을 반환하고, 그렇지 않으면 nil를 반환합니다.

ConformToAvatarRules

생성

매개 변수

humanoidDescription: HumanoidDescription
기본값: ""

반환

GetAvatarRules

생성

이 함수는 스케일링, 기본 셔츠와 바지, 착용 가능한 자산 수 등의 플랫폼 아바타 규칙을 반환합니다.

반환된 테이블에는 다음 필드가 포함됩니다:


{
"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 목록.

기본값: ""

제공된 아이템 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

지정된 자산 또는 번들ID.

기본값: ""

지정된 자산 또는 번들Enum.AvatarItemType입니다.

기본값: ""

반환

LocalPlayer 가 지정된 패키지나 자산을 즐겨찾았는지 여부.

GetInventory

생성

사용자 인벤토리에 있는 소유 항목에 대한 정보가 있는 InventoryPages 개체를 반환하여 지정된 AvatarAssetTypes에 사용자가 액세스할 수 있습니다.

반환된 테이블에는 다음 필드가 포함됩니다:


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

매개 변수

assetTypes: Array

플레이어의 인벤토리에서 확인할 수 있는 Enum.AvatarAssetType 가 될 수 있습니다.

기본값: ""

반환

GetItemDetails

생성

이 함수는 지정된 항목에 대한 아이템 세부 정보를 반환합니다.첫 번째는 검색되는 항목의 ID를 나타내고 두 번째는 그것의 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 | UGC 제한 | | Limited | Roblox 한정 | | LimitedUnique | Roblox 한정 고유 |

매개 변수

itemId: number

세부 정보가 검색되는 아이템의 ID.

기본값: ""

검색되는 항목의 유형을 나타내는 열거형 값입니다. An enum value indicating the type of item whose details are being retrieved.

기본값: ""

반환

검색된 아이템대한 항목 정보가 포함된 테이블. 위에서 샘플 테이블을 참조하십시오.

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>int</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 및 자산 ID에 따라 권장되는 자산 목록을 반환합니다.이를 사용하여 제공된 자산과 유사한 자산 목록을 수집합니다.아래 코드 샘플을 살펴보여 이 함수의 가능한 사용에 대한 자세한 정보를 얻으세요.

데이터 형식:


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

권장 사항을 검색할 때 제공된 자산 유형과 일치하는 자산의 ID. The id of an asset with a type matching the provided assetType used for context when retrieving recommendations.

기본값: 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에 대한 권장 패키지 목록을 반환합니다.

데이터 형식:


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

권장되는 패키지 목록.

기본값: ""

반환

권장되는 패키지에 반환될 패키지 ID.

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() 프롬프트에 응답할 때 발생합니다.실패할 수 있는 웹 요청을 수행하지 않기 때문에 Success 또는 PermissionDenied enum 상태만 반환할 수 있습니다.

매개 변수

프롬프트의 결과.


PromptCreateOutfitCompleted

이 이벤트는 PromptSaveOutfit 작업이 완료될 때 발생합니다.프롬프트가 성공했는지, 실패했는지, 사용자에 의해 권한이 부여되지 않았는지를 나타내는 상태 enum를 제공합니다.

매개 변수

프롬프트의 결과.

failureType: Variant

PromptDeleteOutfitCompleted

PromptDeleteOutfit 작업이 완료되면 발생합니다.프롬프트가 성공했는지, 실패했는지, 사용자에 의해 권한이 부여되지 않았는지를 나타내는 상태 enum를 제공합니다.

매개 변수

프롬프트의 결과.


PromptRenameOutfitCompleted

PromptRenameOutfit 작업이 완료되면 발생합니다.프롬프트가 성공했는지, 실패했는지, 사용자에 의해 권한이 부여되지 않았는지를 나타내는 상태 enum를 제공합니다.

매개 변수

프롬프트의 결과.


PromptSaveAvatarCompleted

이 이벤트는 AvatarEditorService:PromptSaveAvatar() 작업이 완료될 때 발생합니다.프롬프트가 성공했는지, 실패했는지, 사용자에 의해 권한이 부여되지 않았는지를 나타내는 상태 enum를 제공합니다.

매개 변수

프롬프트의 결과.

humanoidDescription: HumanoidDescription

PromptSetFavoriteCompleted

AvatarEditorService:PromptSetFavorite() 작업이 완료되면 발생합니다.프롬프트가 성공했는지, 실패했는지, 사용자에 의해 권한이 부여되지 않았는지를 나타내는 상태 enum를 제공합니다.

매개 변수

프롬프트의 결과.


PromptUpdateOutfitCompleted

AvatarEditorService:PromptUpdateOutfit() 작업이 완료되면 발생합니다.프롬프트가 성공했는지, 실패했는지, 사용자에 의해 권한이 부여되지 않았는지를 나타내는 상태 enum를 제공합니다.

매개 변수

프롬프트의 결과.