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 prendre en charge les éditeurs d'avatar des développeurs. Il fournit des méthodes pour modifier l'avatar 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érateur
Les points suivants sur AvatarEditorService ont un niveau d'expérience de ralentissement :
Pour chaque expérience, ce ralentissement vous permet d'envoyer jusqu'à 100 demandes par seconde à ces AvatarEditorService endpoints, quelle que soit le nombre de serveurs ou le nombre d'utilisateurs. Excéder ces limites renvoie une erreur 429 Too Many Requests.
Si vous trouvez que votre expérience nécessite une ajustement à cette accélération, vous pouvez soumettre une Demande de fonctionnalité.
Résumé
Méthodes
Invite le Players.LocalPlayer à permettre au développeur de lire quels articles l'utilisateur a dans son inventaire et d'autres informations sur l'éditeur d'avatar liées.
Invite le Players.LocalPlayer à enregistrer le HumanoidDescription donné comme une tenue.
Invite le Players.LocalPlayer à supprimer la tenue donnée.
Invite le Players.LocalPlayer à renommer la tenue donnée.
Invite le Players.LocalPlayer à mettre à jour son avatar en fonction de la valeur donnée HumanoidDescription et Enum.RigType de R6 ou R15.
Invite le Players.LocalPlayer à mettre le joueur ou le lotfavoris ou non.
- PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Invite le Players.LocalPlayer à mettre à jour la tenue donnée.
Utilisé pour appliquer les vêtements par défaut à la HumanoidDescription si nécessaire.
Renvoie les règles de la plate-forme Avatar pour des choses telles que l'échelle, les chemises et les pantalons par défaut, le nombre de ressources portables.
Obtient les détails de l'élément pour une liste d'éléments à la fois.
Renvoie si le Players.LocalPlayer a favorisé le pack donné ou la contenu.
Retourne un objet InventoryPages avec des informations sur les articles possédés dans l'inventaire des utilisateurs avec les données fournies par AvatarAssetTypes.
Renvoie les détails de l'itempour l'élément donné.
Renvoie les détails de l'habilité pour la tenue donnée.
Renvoie les données de l'habilité pour le Players.LocalPlayer .
Renvoie une liste de ressources recommandées en fonction d'un Enum.AssetType et d'un id de ressource donné.
Renvoie une liste de packs recommandés pour un identifiant de pack donné.
Renvoie un objet CatalogPages contenant le résultat de la chercherdonnée.
Évènements
Feuille quand le AvatarEditorService:PromptAllowInventoryReadAccess() message est répondu par l'utilisateur.
Se déclenche lorsque l'opération PromptSaveOutfit est terminée.
Se déclenche lorsque l'opération PromptDeleteOutfit est terminée.
Se déclenche lorsque l'opération de réinitialisation du nom du prom示tRenameOutfit est terminée.
- PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Se déclenche lorsque l'opération AvatarEditorService:PromptSaveAvatar() est terminée.
Se déclenche lorsque l'opération AvatarEditorService:PromptSetFavorite() est terminée.
Se déclenche lorsque l'opération AvatarEditorService:PromptUpdateOutfit() est terminée.
Propriétés
Méthodes
GetAccessoryType
Paramètres
Retours
PromptAllowInventoryReadAccess
Invite le Players.LocalPlayer à permettre au développeur de lire quels articles l'utilisateur a dans son inventaire et d'autres informations sur l'éditeur d'avatar liées. La demande doit être confirmée par l'utilisateur pour que le développeur puisse utiliser AvatarEditorService:GetInventory() ,
Retours
PromptCreateOutfit
Invite le Players.LocalPlayer à enregistrer le HumanoidDescription donné comme une tenue. Ne génère pas. Le résultat peut être récupéré en écoutant l'événement AvatarEditorService.PromptCreateOutfitCompleted.
Paramètres
La Outfit que le joueur sera invité à créer.
Le Enum.RigType que la tenue sera créée pour si le joueur confirme la demande.
Retours
PromptDeleteOutfit
Invite le Players.LocalPlayer à supprimer la tenue donnée. Ne se produit pas. Le résultat peut être récupéré en écoutant l'événement AvatarEditorService.PromptDeleteOutfitCompleted.
Paramètres
L'identifiant de la tenue à supprimer.
Retours
PromptRenameOutfit
Invite le Players.LocalPlayer à renommer la tenue donnée. Ne se produit pas. Le résultat peut être récupéré en écoutant l'événement AvatarEditorService.PromptRenameOutfitCompleted.
Paramètres
L'identifiant de l'habit à renommer.
Retours
PromptSaveAvatar
Cette fonction demande au Players.LocalPlayer de mettre à jour son avatar en fonction de la valeur donnée HumanoidDescription et Enum.RigType (R6 ou R15). Ne génère pas et peut obtenir le résultat en écoutant l'événement PromptSaveAvatarCompleted. Ceci est similaire à la façon dont d'autres invitations telles que PromptPurchase fonction
Paramètres
La HumanoidDescription donnée être demandée pour être sauvegardée.
Le Enum.RigType que l'avatar sera sauvegardé pour si le joueur confirme la demande.
Retours
PromptSetFavorite
Cette fonction demande au Players.LocalPlayer de favoriser ou d'annuler le favorisage de la ressource ou du lotdonné.
Paramètres
L'ItemId de l'élément favori.
Le type d'objet demandé à la ajouter aux favoris.
Retours
PromptUpdateOutfit
Invite le Players.LocalPlayer à mettre à jour la tenue donnée avec la description d'homme donnée.
Paramètres
L'outfitId de la tenue à mettre à mise à jour.
Une description humanoïde qui représente les nouvelles données d'outfit.
Le type RigHumanoïde pour mettre à jour la tenue.
Retours
CheckApplyDefaultClothing
Retourne un nouveau HumanoidDescription avec les propriétés Shirt et Pants mises à jour si nécessaire. Retourne zéro si les vêtements par défaut ne sont pas nécessaires.
Les vêtements par défaut sont nécessaires si la description du humanoid ne dispose pas actuellement de chemises et de pantalons équipés et que les couleurs du corps sont trop similaires.
Paramètres
La description humanoïde pour vérifier si les vêtements par défaut sont requis.
Retours
Retourne une description d'humanoïde si la tenue par défaut était nécessaire. Sinon, retourne zéro.
ConformToAvatarRules
Paramètres
Retours
GetAvatarRules
Cette fonction renvoie les règles de la plate-forme Avatar pour des choses comme l'échelle, les chemises et les pantalons, 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 de la plate-forme Avatar pour des choses comme l'échelle, les chemises et les pantalons, le nombre d'actifs 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 avez besoin de tous les détails de l'article d'une liste.
Paramètres
La liste des identifiants d'objet pour obtenir des détails.
Le type des ID d'objet fournis.
Retours
Renvoie une tableau de détails de l'article 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 pack donné ou la contenu.
Paramètres
L'identifiant de la ressource spécifiée ou du lot.
Le Enum.AvatarItemType de la ressource spécifiée ou du lot.
Retours
Whether the LocalPlayer a favorisé le pack donné ou la contenu.
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 second indiquant son Enum.ItemType .
Données renvoyées au 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 rechercher des ressources limitées ou illimitées, utilisez les valeurs suivantes : itemRestrictions
| itemRestrictions | Limité ou Illimité | | :--------------: | :-------------------: | | empty | Unlimited | | Collectible | UGC Limited | | Limited | Roblox Limited Unique |
Paramètres
L'ID de l'élément dont les détails sont récupérés.
Une valeur d' enum indiquant le type d'élément dont les détails sont récupérés.
Retours
Une table contenant les informations de l'élément pour l'itemrécupéré. Voir ci-dessus pour un tableau d'exemple.
GetOutfitDetails
Cette fonction renvoie les détails de l'habillement pour la tenue donnée. Elle accepte un seul argument : l'ID de la tenue.
Les données sont restitué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 en cours de récupération.
Retours
Une table contenant les informations de l'habillement pour la tenue récupérée. Voir ci-dessus pour un tableau d'exemple.
GetOutfits
Cette fonction renvoie les données de l'outfit pour le Players.LocalPlayer . Ce serait utilisé avec Players:GetHumanoidDescriptionFromOutfitId() pour mettre à jour le personnage des joueurs dans l'outfit. L'accès à ceci dépend également de AvatarEditorService:PromptAllowInventoryReadAccess() accepté par l'utilisateur.
La table renvoyée inclut les champs suivants :
[{"Id": 0,"Name": "string","IsEditable": true}]
<tbody><tr><td>identifiant</td><td>int</td><td /></tr><tr><td>nom</td><td>chaîne</td><td /></tr><tr><td>est modifiable</td><td>boîtier</td><td /></tr></tbody>
Nom | taper | Description |
---|
Paramètres
Retours
GetRecommendedAssets
Renvoie une liste de ressources recommandées en fonction d'un Enum.AssetType et d'un ID de ressource donné. Utilisez ceci pour recueillir une liste de ressources similaires à la ressource fournie. Jetez un œil au code de Enum.AssetType pour plus d'informations sur les usages possibles pour 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 de ressources pour récupérer les recommandations. Aucun effet sur la réponse lorsque les recommandations basées sur des éléments n'existent pas pour le contextAssetId donné.
L'ID d'une ressource avec un type correspondant à la ressource fournie pour le contexte lors de la récupération des recommandations.
Retours
Une liste de recommandations basées sur le Enum.AssetType donné.
Échantillons de code
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 packs recommandés pour un identifiant de pack 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 packs recommandés.
Retours
L'ID de pack que les packs 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 la AvatarEditorService:PromptAllowInventoryReadAccess() demande est répondu par l'utilisateur. Il ne peut retourner que les statuts de réussite ou de permission refusée enum comme il ne s'exécute pas de demandes Web qui pourraient échouer.
Paramètres
Résultat de la saisie.
PromptCreateOutfitCompleted
Cet événement se déclenche lorsque l'opération de sauvegarde de la liste de commandes est terminée. Il indique un statut enum indiquant si la demande a réussi, échoué ou l'autorisation n'a pas été accordée par l'utilisateur.
Paramètres
Résultat de la saisie.
PromptDeleteOutfitCompleted
Se déclenche lorsque l'opération Supprimer la tenue est terminée. Il indique un statut enum indiquant si la demande a réussi, échoué ou si la permission n'a pas été accordée par l'utilisateur.
Paramètres
Résultat de la saisie.
PromptRenameOutfitCompleted
Se déclenche lorsque l'opération de réinitialisation du nom du feu est terminée. Il indique un statut enum indiquant si la demande de réinitialisation du nom du feu a réussi, échoué ou l'autorisation n'a pas été accordée par l'utilisateur.
Paramètres
Résultat de la saisie.
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 l'autorisation n'a pas été accordée par l'utilisateur.
Paramètres
Résultat de la saisie.
PromptSetFavoriteCompleted
Se déclenche lorsque l'opération AvatarEditorService:PromptSetFavorite() est terminée. Il donne un statut enum indiquant si l'invite a réussi, échoué ou l'autorisation n'a pas été accordée par l'utilisateur.
Paramètres
Résultat de la saisie.
PromptUpdateOutfitCompleted
Se déclenche lorsque l'opération AvatarEditorService:PromptUpdateOutfit() est terminée. Il affiche un statut enum indiquant si l'invite a réussi, échoué ou l'autorisation n'a pas été accordée par l'utilisateur.
Paramètres
Résultat de la saisie.