AvatarEditorService

方法

GetAccessoryType(avatarAssetType : Enum.AvatarAssetType):Enum.AccessoryType
PromptAllowInventoryReadAccess():()
Players.LocalPlayer にユーザーがインベントリや他のアバターエディター関連情報に持っているアイテムを読むことを許可するように促す
PromptCreateOutfit(outfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Players.LocalPlayer に、指定された HumanoidDescription を衣服として保存するように求めます。
PromptDeleteOutfit(outfitId : number):()
Players.LocalPlayer に指示して、指定された衣装を削除します。
PromptRenameOutfit(outfitId : number):()
Players.LocalPlayer に、指定された衣装の名前を変更するように促します。
PromptSaveAvatar(humanoidDescription : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Players.LocalPlayer に、指定された HumanoidDescription と Enum.RigType の R6 または R15 に基づいてアバターを更新するように促します。
PromptSetFavorite(itemId : number,itemType : Enum.AvatarItemType,shouldFavorite : boolean):()
Players.LocalPlayer に、指定のアセットまたはバンドルをお気に入りまたはお気に入り解除するように求めます。
PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Players.LocalPlayer に指示して、指定された衣装を更新します。
CheckApplyDefaultClothing(humanoidDescription : HumanoidDescription):HumanoidDescription
イールド
必要に応じてデフォルトの服装を適用するために使用されます HumanoidDescription 。
ConformToAvatarRules(humanoidDescription : HumanoidDescription):HumanoidDescription
イールド
GetAvatarRules():Dictionary
イールド
スケーリング、デフォルトのシャツとパンツ、着用可能なアセットの数などの平台アバタールールを返します。
GetBatchItemDetails(itemIds : Array,itemType : Enum.AvatarItemType):Array
イールド
一度にアイテムのリストの詳細を取得します。
GetFavorite(itemId : number,itemType : Enum.AvatarItemType):boolean
イールド
Players.LocalPlayer が指定されたバンドルまたはアセットをお気に入りにしたかどうかを返します。
GetInventory(assetTypes : Array):InventoryPages
イールド
ユーザーのインベントリにある所有済みアイテムに関する情報を含むオブジェクトを返し、指定されたアバターアセットタイプです。
GetItemDetails(itemId : number,itemType : Enum.AvatarItemType):Dictionary
イールド
指定されたアイテムのアイテム詳細を返す。
GetOutfitDetails(outfitId : number):Dictionary
イールド
指定された衣装の服装詳細を返します。
GetOutfits(outfitSource : Enum.OutfitSource,outfitType : Enum.OutfitType):OutfitPages
イールド
Players.LocalPlayer の衣装データを返します。
GetRecommendedAssets(assetType : Enum.AvatarAssetType,contextAssetId : number):Array
イールド
指定された Enum.AssetType とアセットIDに基づいて、推奨されるアセットのリストを返します。
GetRecommendedBundles(bundleId : number):Array
イールド
指定されたバンドルIDのための推奨バンドルのリストを返します。
SearchCatalog(searchParameters : CatalogSearchParams):CatalogPages
イールド
返す CatalogPages オブジェクトには、指定された検サーチの結果が含まれています。

イベント

PromptAllowInventoryReadAccessCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
ユーザーが AvatarEditorService:PromptAllowInventoryReadAccess() プロンプトに応答すると、炎が発生します。
PromptCreateOutfitCompleted(result : Enum.AvatarPromptResult,failureType : Variant):RBXScriptSignal
プロンプト保存オペレーションが完了すると発火します。
PromptDeleteOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
プロンプト削除オペレーションが完了すると発火します。
PromptRenameOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
PromptRenameOutfit 操作が完了すると発火します。
PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
AvatarEditorService:PromptSaveAvatar() 操作が完了すると発火します。
PromptSetFavoriteCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
AvatarEditorService:PromptSetFavorite() 操作が完了すると発火します。
PromptUpdateOutfitCompleted(result : Enum.AvatarPromptResult):RBXScriptSignal
AvatarEditorService:PromptUpdateOutfit() 操作が完了すると発火します。

プロパティ

方法

GetAccessoryType

Enum.AccessoryType

パラメータ

avatarAssetType: Enum.AvatarAssetType

既定値: ""

戻り値

Enum.AccessoryType

PromptAllowInventoryReadAccess

()

Players.LocalPlayer にユーザーがインベントリや他のアバターエディター関連情報に持っているアイテムを読むことを許可するように促すプロンプトは、開発者が AvatarEditorService:GetInventory()、AvatarEditorService:GetOutfits()、および AvatarEditorService:GetFavorite() を使用するために、ユーザーによって確認する必要があります。セッション間で権限は持続しません。

戻り値

()

PromptCreateOutfit

()

Players.LocalPlayer に、指定された HumanoidDescription を衣服として保存するよう求めます。結果は、AvatarEditorService.PromptCreateOutfitCompleted イベントを聴いて回収できます。

パラメータ

outfit: HumanoidDescription

プレイヤーが作成するように求められる Outfit 。

既定値: ""

rigType: Enum.HumanoidRigType

プレイヤーがプロンプトを確認すると、衣装が作成される 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 が保存するように求められています。

既定値: ""

rigType: Enum.HumanoidRigType

プレイヤーがプロンプトを確認すると、アバターが保存される Enum.RigType

既定値: ""

戻り値

()

PromptSetFavorite

()

この機能は、Players.LocalPlayer に指示して、指定のアセットまたはバンドルをお気に入りまたはお気に入り解除します。

パラメータ

itemId: number

お気に入りに登録するアイテムの ItemId。

既定値: ""

itemType: Enum.AvatarItemType

お気に入りに求められるアイテムの種類。

既定値: ""

shouldFavorite: boolean

既定値: ""

戻り値

()

PromptUpdateOutfit

()

Players.LocalPlayer に、指定された服装を指定されたヒューマノイド説明で更新するように促します。

パラメータ

outfitId: number

更アップデートする衣装の outfitId。

既定値: ""

updatedOutfit: HumanoidDescription

新しい衣装データを表現するヒューマノイド説明。

既定値: ""

rigType: Enum.HumanoidRigType

アップデートする衣装の HumanoidRigType。

既定値: ""

戻り値

()

CheckApplyDefaultClothing

イールド

必要に応じてシャツとパンツのプロパティが更新された新しい HumanoidDescription を返します。デフォルトの服装が必要でなかった場合は、nil を返します。

ヒューマノイドの説明に現在シャツとパンツが装備されておらず、体の色が似すぎる場合は、デフォルトの服装が必要です。

パラメータ

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のリスト。

既定値: ""

itemType: Enum.AvatarItemType

提供されたアイテム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

boolean

イールド

この機能は、Players.LocalPlayer が指定されたバンドルまたはアセットをお気に入りにしたかどうかを返します。

パラメータ

itemId: number

指定されたアセットまたはバンドルの ID。

既定値: ""

itemType: Enum.AvatarItemType

指定されたアセットまたはバンドルの Enum.AvatarItemType 。

既定値: ""

戻り値

boolean

LocalPlayer が指定されたバンドルまたはアセットをお気に入りにしたかどうか。

GetInventory

InventoryPages

イールド

指定された InventoryPages にユーザーのインベントリにある所有アイテムに関する情報を持つ AvatarAssetTypes オブジェクトを返します。

返されたテーブルには次のフィールドが含まれています:


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

パラメータ

assetTypes: Array

プレイヤーのインベントリでチェックできる Enum.AvatarAssetType が指定されます。

既定値: ""

戻り値

InventoryPages

GetItemDetails

イールド

この機能は、指定されたアイテムのアイテム詳細を返します。2つのパラメータを受け入れます - 最初は、回収されるアイテムのIDを示し、2番目はその 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 値を使用してください：

パラメータ

itemId: number

詳細が取得されているアイテムの ID。

既定値: ""

itemType: Enum.AvatarItemType

リトリーブされているアイテムの詳細の種類を示す枚数値。

既定値: ""

戻り値

回収されたアイテムのアイテム情報を含むテーブル。上のサンプルテーブルを参照してください。

GetOutfitDetails

イールド

この機能は、指定された衣装の衣装詳細を返します。1つのパラメータを受け入れます：衣装の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

OutfitPages

イールド

この機能は、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"

戻り値

OutfitPages

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
      }
    }
]

パラメータ

assetType: Enum.AvatarAssetType

回収する推奨事項のタイプ。アイテムベースの推奨事項が存在しない場合のレスポンスにのみ影響します。item based recommendations don't exist for the given contextAssetId .

既定値: ""

contextAssetId: number

提供されたアセットタイプに一致するタイプのアセットのIDは、レコメンドを取得するときのコンテキストに使用されます。

既定値: 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

イールド

この関数は、指定された検サーチの結果を含む 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

検サーチに使用されるパラメータを含むオブジェクト。

既定値: ""

戻り値

CatalogPages

イベント

PromptAllowInventoryReadAccessCompleted

このイベントは、ユーザーが AvatarEditorService:PromptAllowInventoryReadAccess() プロンプに応答すると発動します。Web リクエストが失敗する可能性があるため、Success または PermissionDenied 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 を返し、プロンプトが成功したか、失敗したか、またはユーザーによって許可が与えられなかったかを示します。

パラメータ

プロンプトの結果。