AvatarEditorService
*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.
AvatarEditorService est un service pour soutenir les éditeurs d'avatar des développeurs.Il fournit des méthodes pour modifier l'avatar de plate-forme du joueur, demander des informations sur l'inventaire d'un utilisateur et demander des informations sur le catalogue.
Pour plus d'informations sur l'éditeur d'avatar, voir service d'éditeur d'avatar.
Accélération
Les points suivants sur AvatarEditorService ont un étranglement au niveau de l'expérience :
Pour chaque expérience, cette limitation vous permet d'envoyer jusqu'à 100 demandes par seconde à ces points de fin AvatarEditorService, indépendamment du nombre de serveurs ou du nombre d'utilisateurs.Dépasser ces limites renvoie une erreur 429 Too Many Requests d'erreur.
Si vous trouvez que votre expérience nécessite un ajustement à cette limitation, vous pouvez soumettre une demande de fonctionnalité .
Résumé
Méthodes
Demande au Players.LocalPlayer de permettre au développeur de lire quels articles l'utilisateur a dans son inventaire et d'autres informations liées à l'éditeur d'avatar.
Demande au Players.LocalPlayer de sauvegarder le HumanoidDescription donné comme tenue.
Demande au Players.LocalPlayer de supprimer la tenue donnée.
Demande au Players.LocalPlayer de renommer la tenue donnée.
Demande au Players.LocalPlayer de mettre à jour leur avatar en fonction du HumanoidDescription et du Enum.RigType de R6 ou R15 donné.
Demande au Players.LocalPlayer de favoriser ou de désavantager l'actif ou le lotdonné.
- PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Demande à la Players.LocalPlayer de mettre à jour la tenue donnée.
Utilisé pour appliquer la tenue par défaut au HumanoidDescription si nécessaire.
Renvoie les règles d'avatar de la plate-forme pour des choses telles que l'ajustement, les chemises et pantalons par défaut, le nombre de ressources portables.
Obtient les détails de l'article pour une liste d'articles à la fois.
Retourne si le Players.LocalPlayer a favorisé le paquet ou la contenudonnée.
Renvoie un objet InventoryPages avec des informations sur les articles possédés dans l'inventaire des utilisateurs avec les types d'actifs d'avatar donnés.
Renvoie les détails de l'article pour l'itemdonné.
Renvoie les détails de la tenue pour la tenue donnée.
Renvoie les données de l'habillement pour le Players.LocalPlayer.
Renvoie une liste de ressources recommandées en fonction d'un ID de ressource donné Enum.AssetType et d'un ID d'actif.
Renvoie une liste de packages recommandés pour un ID de package donné.
Renvoie un objet CatalogPages contenant le résultat de la chercherdonnée.
Évènements
S'enflamme lorsque l'invite AvatarEditorService:PromptAllowInventoryReadAccess() est répondu par l'utilisateur.
S'enflamme lorsque l'opération PromptSaveOutfit est terminée.
Se déclenche lorsque l'opération Supprimer tenue rapide est terminée.
Se déclenche lorsque l'opération Renommer l'habit rapide est terminée.
- PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
S'enflamme lorsque l'opération AvatarEditorService:PromptSaveAvatar() est terminée.
S'enflamme lorsque l'opération AvatarEditorService:PromptSetFavorite() est terminée.
S'enflamme lorsque l'opération AvatarEditorService:PromptUpdateOutfit() est terminée.
Propriétés
Méthodes
GetAccessoryType
Paramètres
Retours
PromptAllowInventoryReadAccess
Demande au Players.LocalPlayer de permettre au développeur de lire quels articles l'utilisateur a dans son inventaire et d'autres informations liées à l'éditeur d'avatar.L'invite doit être confirmée par l'utilisateur pour que le développeur utilise AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() et AvatarEditorService:GetFavorite() .La permission ne persiste pas entre les sessions.
Retours
PromptCreateOutfit
Demande au Players.LocalPlayer de sauvegarder le HumanoidDescription donné en tant que tenue. Ne se produit pas. Le résultat peut être récupéré en écoutant l'événement AvatarEditorService.PromptCreateOutfitCompleted.
Paramètres
Le Outfit que le joueur sera invité à créer.
Le Enum.RigType pour lequel la tenue sera créée si le joueur confirme l'invite.
Retours
PromptDeleteOutfit
Demande au Players.LocalPlayer de supprimer la tenue donnée. Ne donne pas de résultat. Le résultat peut être récupéré en écoutant l'événement AvatarEditorService.PromptDeleteOutfitCompleted.
Paramètres
L'outfitId de la tenue à supprimer.
Retours
PromptRenameOutfit
Demande au Players.LocalPlayer de renommer la tenue donnée. Ne donne pas de résultat. Le résultat peut être récupéré en écoutant l'événement AvatarEditorService.PromptRenameOutfitCompleted.
Paramètres
L'outfitId de la tenue à renommer.
Retours
PromptSaveAvatar
Cette fonction demande au Players.LocalPlayer de mettre à jour leur avatar en fonction du HumanoidDescription et du Enum.RigType (R6 ou R15).Ne se soumet pas et peut obtenir le résultat en écoutant l'événement PromptSaveAvatarCompleted.C'est similaire à la façon dont fonctionnent d'autres invites telles que PromptPurchase.
Paramètres
Le HumanoidDescription donné demandant d'être sauvegardé.
Le Enum.RigType que l'avatar sera sauvegardé pour si le joueur confirme l'invite.
Retours
PromptSetFavorite
Cette fonction demande au Players.LocalPlayer de favoriser ou de désavantager l'actif ou le lotdonné.
Paramètres
L'ID de l'élément de l'élément qui est invité à être ajouter aux favoris.
Le type d'élément demandé en ajouter aux favoris.
Retours
PromptUpdateOutfit
Demande à la Players.LocalPlayer de mettre à jour la tenue donnée avec la description humanoïde donnée.
Paramètres
L'outfitId de la tenue à mettre à mise à jour.
Une description humanoïde qui représente les données de la nouvelle tenue.
The HumanoidRigType pour mettre à jour la tenue.
Retours
CheckApplyDefaultClothing
Renvoie une nouvelle HumanoidDescription avec les propriétés chemise et pantalon mises à jour si nécessaire. Renvoie nil si les vêtements par défaut n'étaient pas nécessaires.
Les vêtements par défaut sont nécessaires si la description humanoïde n'a pas actuellement de chemise et de pantalon équipés et que les couleurs du corps sont trop similaires.
Paramètres
La description humanoïde pour vérifier si des vêtements par défaut sont requis.
Retours
Renvoie une description humanoïde si le vêtement par défaut était nécessaire. Sinon, renvoie nil .
ConformToAvatarRules
Paramètres
Retours
GetAvatarRules
Cette fonction renvoie les règles d'Avatar de la plate-forme pour des choses comme la mise à l'échelle, les chemises et pantalons par défaut, le nombre de ressources portables, etc.
La table renvoyée inclut les champs suivants :
{"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}
Retours
Un dictionnaire contenant les règles d'avatar de plate-forme pour des choses comme la mise à l'échelle, les chemises et pantalons par défaut, le nombre de ressources portables, etc.Voir l'exemple de retour dans la description principale ci-dessus.
GetBatchItemDetails
Obtient les détails de l'article pour une liste d'articles à la fois.Plus efficace que AvatarEditorService:GetItemDetails si vous devez obtenir tous les détails de l'article d'une liste.
Paramètres
La liste des ID d'objets pour obtenir des détails.
Le type des ID d'objet fournis.
Retours
Renvoie une série de détails d'objets avec les champs suivants :
{"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
Cette fonction renvoie si le Players.LocalPlayer a favorisé le paquet ou la contenudonnée.
Paramètres
L'ID de la ressource ou du lotspécifié.
Le Enum.AvatarItemType de la ressource ou du lotspécifié.
Retours
Si le LocalPlayer a favorisé le paquet ou la contenudonnée.
GetInventory
Retourne un objet InventoryPages avec des informations sur les articles possédés dans l'inventaire des utilisateurs avec le AvatarAssetTypes donné.
La table renvoyée inclut les champs suivants :
[{"AssetId": 0,"AssetType" : "string","Created": "string","Name": "string",}]
Paramètres
Le Enum.AvatarAssetType qui peut être vérifié dans l'inventaire du joueur.
Retours
GetItemDetails
Cette fonction renvoie les détails de l'itempour l'élément donné.Il accepte deux paramètres - le premier indiquant l'ID de l'élément récupéré et le deuxième indiquant son Enum.ItemType.
Données retournées dans le 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}
Pour demander des ressources limitées ou illimitées, utilisez les valeurs suivantes itemRestrictions :
| itemRestrictions | Limité ou illimité | | :--------------: | :-------------------: | | empty | Illimité | | Collectible | UGC limité | | Limited | Roblox limité unique | | LimitedUnique | Roblox limité Unique |
Paramètres
L'ID de l'élément dont les détails sont récupérés.
Une valeur enum indiquant le type d'élément dont les détails sont récupérés.
Retours
Une table contenant les informations de l'itempour l'élément récupéré. Voir ci-dessus pour un échantillon de table.
GetOutfitDetails
Cette fonction renvoie les détails de la tenue pour la tenue donnée. Elle accepte un paramètre : l'ID de la tenue.
Les données sont retournées dans le format suivant :
{"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},}
Paramètres
L'ID de la tenue dont les détails sont récupérés.
Retours
Une table contenant les informations sur la tenue pour la tenue récupérée. Voir ci-dessus pour une table d'échantillon.
GetOutfits
Cette fonction renvoie les données de tenue pour le Players.LocalPlayer.Cela serait utilisé avec Players:GetHumanoidDescriptionFromOutfitId() pour mettre à jour le personnage des joueurs à la tenue.L'accès à cela dépendrait également du fait que AvatarEditorService:PromptAllowInventoryReadAccess() soit accepté par l'utilisateur.
La table renvoyée inclut les champs suivants :
[{"Id": 0,"Name": "string","IsEditable": true}]
<th>taper</th><th>Avertissement</th></tr></thead><tbody><tr><td>id</td><td>int</td><td /></tr><tr><td>nom</td><td>chaîne</td><td /></tr><tr><td>est modifiable</td><td>booléen</td><td /></tr></tbody>
Nom |
---|
Paramètres
Retours
GetRecommendedAssets
Renvoie une liste de ressources recommandées en fonction d'un ID de ressource donné Enum.AssetType et d'un ID d'actif.Utilisez ceci pour recueillir une liste de ressources similaires à la ressource fournie.Jetez un coup d'œil au code d'exemple ci-dessous pour plus d'informations sur les utilisations possibles de cette fonction.
Les données sont au 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}}]
Paramètres
Le type de recommandations d'actifs à récupérer pour récupérer des recommandations.Ne touche que la réponse lorsque les recommandations basées sur des articles n'existent pas pour le contextAssetId donné.
L'ID d'une ressource avec un type correspondant au type fourni utilisé pour le contexte lors de la récupération de recommandations.
Retours
Une liste de recommandations basées sur le Enum.AssetType.
Échantillons de code
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.
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
Cette fonction renvoie une liste de packages recommandés pour un ID de package donné.
Les données sont au 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}}}]
Paramètres
Une liste de packages recommandés.
Retours
L'ID de paquet que les paquets recommandés seront renvoyés pour.
SearchCatalog
Cette fonction renvoie un objet CatalogPages contenant le résultat de la chercherdonnée.
Les données renvoyées ont le 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}]
Paramètres
Un objet contenant les paramètres utilisés pour la chercher.
Retours
Évènements
PromptAllowInventoryReadAccessCompleted
Cet événement se déclenche lorsque l'invite AvatarEditorService:PromptAllowInventoryReadAccess() est répondu par l'utilisateur.Il ne peut retourner que les états Succès ou Refus de permission enum car il ne réalise aucune demande Web qui pourrait échouer.
Paramètres
Le résultat de l'invite.
PromptCreateOutfitCompleted
Cet événement se déclenche lorsque l'opération PromptSaveOutfit est terminée.Il donne un statut enum indiquant si l'invite a réussi, échoué ou si l'accès n'a pas été accordé par l'utilisateur.
Paramètres
Le résultat de l'invite.
PromptDeleteOutfitCompleted
Se déclenche lorsque l'opération Supprimer tenue rapide est terminée.Il donne un statut enum indiquant si l'invite a réussi, échoué ou si l'accès n'a pas été accordé par l'utilisateur.
Paramètres
Le résultat de l'invite.
PromptRenameOutfitCompleted
Se déclenche lorsque l'opération Renommer l'habit rapide est terminée.Il donne un statut enum indiquant si l'invite a réussi, échoué ou si l'accès n'a pas été accordé par l'utilisateur.
Paramètres
Le résultat de l'invite.
PromptSaveAvatarCompleted
Cet événement se déclenche lorsque l'opération AvatarEditorService:PromptSaveAvatar() est terminée.Il donne un statut enum indiquant si l'invite a réussi, échoué ou si l'accès n'a pas été accordé par l'utilisateur.
Paramètres
Le résultat de l'invite.
PromptSetFavoriteCompleted
S'enflamme lorsque l'opération AvatarEditorService:PromptSetFavorite() est terminée.Il donne un statut enum indiquant si l'invite a réussi, échoué ou si l'accès n'a pas été accordé par l'utilisateur.
Paramètres
Le résultat de l'invite.
PromptUpdateOutfitCompleted
S'enflamme lorsque l'opération AvatarEditorService:PromptUpdateOutfit() est terminée.Il donne un statut enum indiquant si l'invite a réussi, échoué ou si l'accès n'a pas été accordé par l'utilisateur.
Paramètres
Le résultat de l'invite.