AvatarEditorService
*Este contenido se traduce usando la IA (Beta) y puede contener errores. Para ver esta página en inglés, haz clic en aquí.
AvatarEditorService es un servicio para soportar editores de avatares de desarrolladores.Proporciona métodos para modificar el avatar de plataforma del jugador, solicitar información sobre el inventario de un usuario y solicitar información sobre el catálogo.
Para obtener más información sobre el Editor de Avatar, vea Servicio de Editor de Avatar.
Aceleración
Los siguientes puntos finales en AvatarEditorService tienen limitación de experiencia:
Para cada experiencia, esta limitación te permite enviar hasta 100 solicitudes por segundo a estos AvatarEditorService puntos finales, independientemente del número de servidores o del número de usuarios.Exceder estos límites devuelve un error 429 Too Many Requests .
Si encuentra que su experiencia requiere un ajuste a este aceleramiento, puede enviar una solicitud de función.
Resumen
Métodos
Solicita al Players.LocalPlayer que permita al desarrollador leer qué artículos tiene el usuario en su inventario y otra información relacionada con el editor de avatares.
Solicita al Players.LocalPlayer guardar el dado HumanoidDescription como un atuendo.
Solicita al Players.LocalPlayer que elimine el atuendo dado.
Solicita al Players.LocalPlayer que renombre el atuendo dado.
Solicita al Players.LocalPlayer actualizar su avatar según el HumanoidDescription y Enum.RigType de R6 o R15 dado.
Solicita al Players.LocalPlayer favorito o desfavorito del recurso o paquete dado.
- PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):()
Solicita al Players.LocalPlayer actualizar el atuendo dado.
Se usa para aplicar la ropa predeterminada al HumanoidDescription si es necesario.
Devuelve las reglas de avatares de la plataforma para cosas como la escalada, las camisas y los pantalones predeterminados, el número de activos que se pueden usar.
Obtiene los detalles del artículo para una lista de artículos a la vez.
Devuelve si el Players.LocalPlayer ha favorecido el recursoo activo dado.
Devuelve un objeto InventoryPages con información sobre los artículos en propiedad en el inventario de los usuarios con los tipos de avatar dados.
Regresa los detalles del artículo para el objetodado.
Devuelve los detalles del traje para el traje dado.
Devuelve datos de atuendo para el Players.LocalPlayer .
Devuelve una lista de activos recomendados basados en un determinado Enum.AssetType y ID de activo.
Devuelve una lista de paquetes recomendados para un ID de paquete dado.
Devuelve un objeto CatalogPages que contiene el resultado de la buscardada.
Eventos
Se enciende cuando el AvatarEditorService:PromptAllowInventoryReadAccess() prompt es respondido por el usuario.
Se activa cuando se completa la operación Guardar atuendo rápido.
Se activa cuando se completa la operación de Eliminar atuendo rápido.
Se enciende cuando se completa la operación de Renombrar el atuendo.
- PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Se enciende cuando la operación AvatarEditorService:PromptSaveAvatar() se completa.
Se enciende cuando la operación AvatarEditorService:PromptSetFavorite() se completa.
Se enciende cuando la operación AvatarEditorService:PromptUpdateOutfit() se completa.
Propiedades
Métodos
GetAccessoryType
Parámetros
Devuelve
PromptAllowInventoryReadAccess
Solicita al Players.LocalPlayer que permita al desarrollador leer qué artículos tiene el usuario en su inventario y otra información relacionada con el editor de avatares.El mensaje debe ser confirmado por el usuario para que el desarrollador use AvatarEditorService:GetInventory() , AvatarEditorService:GetOutfits() y AvatarEditorService:GetFavorite() .El permiso no persiste entre sesiones.
Devuelve
PromptCreateOutfit
Solicita al Players.LocalPlayer guardar el dado HumanoidDescription como un atuendo. No se rinde. El resultado se puede recuperar escuchando el evento AvatarEditorService.PromptCreateOutfitCompleted.
Parámetros
El Outfit que el jugador se le solicitará para crear.
El Enum.RigType que el atuendo se creará para si el jugador confirma la solicitud.
Devuelve
PromptDeleteOutfit
Solicita al Players.LocalPlayer que elimine el atuendo dado. No se rinde. El resultado se puede recuperar escuchando el evento AvatarEditorService.PromptDeleteOutfitCompleted.
Parámetros
El outfitId del atuendo para eliminar.
Devuelve
PromptRenameOutfit
Solicita al Players.LocalPlayer que renombre el atuendo dado. No se rinde. El resultado se puede recuperar escuchando el evento AvatarEditorService.PromptRenameOutfitCompleted.
Parámetros
El outfitId del atuendo para renombrar.
Devuelve
PromptSaveAvatar
Esta función solicita al Players.LocalPlayer actualizar su avatar según el dado HumanoidDescription y Enum.RigType (R6 o R15).No se rinde y puede obtener el resultado escuchando el evento PromptSaveAvatarCompleted.Esto es similar a cómo funcionan otras solicitudes como PromptPurchase.
Parámetros
El dado HumanoidDescription se le solicita que guarde.
El Enum.RigType que el avatar se guardará para si el jugador confirma la solicitud.
Devuelve
PromptSetFavorite
Esta función solicita al Players.LocalPlayer favoritar o desfavoritar el activo o paquete dado.
Parámetros
El ID del artículo que se le solicita para añadir a favoritos.
El tipo de artículo que se le solicita para añadir a favoritos.
Devuelve
PromptUpdateOutfit
Solicita al Players.LocalPlayer actualizar el atuendo dado con la descripción humanoide dada.
Parámetros
El outfitId del atuendo para actualización.
Una descripción humanoide que representa los datos del nuevo atuendo.
El tipo de modelo humanoide para actualizar el atuendo.
Devuelve
CheckApplyDefaultClothing
Devuelve un nuevo HumanoidDescription con las propiedades Camisa y Pantalones actualizadas si es necesario. Devuelve nil si la ropa predeterminada no era necesaria.
La ropa predeterminada es necesaria si la descripción humanoide no tiene actualmente equipada camisa y pantalones y los colores del cuerpo son demasiado similares.
Parámetros
La descripción humanoide para comprobar si se requiere la ropa predeterminada.
Devuelve
Devuelve una descripción humanoide si la ropa predeterminada era necesaria. De lo contrario, devuelve nil .
ConformToAvatarRules
Parámetros
Devuelve
GetAvatarRules
Esta función devuelve las reglas de avatares de plataforma para cosas como escalado, camisas y pantalones predeterminados, número de activos que se pueden usar, etc.
La tabla devuelta incluye los siguientes campos:
{"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}
Devuelve
Un diccionario que contiene las reglas de avatares de plataforma para cosas como escalado, camisas y pantalones predeterminados, número de activos que se pueden usar, etc.Vea el ejemplo de devolución en la descripción principal anterior.
GetBatchItemDetails
Obtiene los detalles del artículo para una lista de artículos a la vez.Más eficiente que AvatarEditorService:GetItemDetails si necesita obtener todos los detalles del artículo de una lista.
Parámetros
La lista de ID de artículos para obtener detalles.
El tipo de los ID de artículo proporcionados.
Devuelve
Devuelve un array de detalles de artículo con los siguientes campos:
{"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
Esta función devuelve si el Players.LocalPlayer ha favorecido al paquete o recurso dado.
Parámetros
El ID del activo o paquete especificado.
El Enum.AvatarItemType de la actividad o paquete especificado.
Devuelve
Si el LocalPlayer ha favorecido al paquete o recurso dado.
GetInventory
Devuelve un objeto InventoryPages con información sobre los artículos en propiedad en el inventario de los usuarios con el dado AvatarAssetTypes.
La tabla devuelta incluye los siguientes campos:
[{"AssetId": 0,"AssetType" : "string","Created": "string","Name": "string",}]
Parámetros
El Enum.AvatarAssetType que puede ser verificado en el inventario del jugador.
Devuelve
GetItemDetails
Esta función devuelve los detalles del artículo para el objetodado.Acepta dos parámetros - el primero que indica el ID del artículo que se está recuperando y el segundo que indica su Enum.ItemType .
Datos devueltos en formato:
{"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}
Para consultar recursos limitados o ilimitados, use los siguientes valores itemRestrictions :
| itemRestrictions | Limitado o ilimitado | | :--------------: | :-------------------: | | empty | Ilimitado | | Collectible | UGC limitado | | Limited | Roblox limitado único | | LimitedUnique | Roblox limitado único |
Parámetros
El ID del artículo cuyos detalles se están recuperando.
Un valor de enum que indica el tipo de artículo cuyos detalles se están recuperando.
Devuelve
Una tabla que contiene la información del artículo para el objetorecuperado. Vea arriba una tabla de muestra.
GetOutfitDetails
Esta función devuelve los detalles del atuendo para el atuendo dado. Acepta un parámetro: el ID del atuendo.
Los datos se devuelven en el siguiente formato:
{"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},}
Parámetros
El ID del atuendo cuyos detalles se están recuperando.
Devuelve
Una tabla que contiene la información del atuendo para el atuendo recuperado. Vea arriba una tabla de muestra.
GetOutfits
Esta función devuelve datos de atuendo para el Players.LocalPlayer.Se usaría con Players:GetHumanoidDescriptionFromOutfitId() para actualizar el personaje de los jugadores al atuendo.El acceso a esto también dependería de que AvatarEditorService:PromptAllowInventoryReadAccess() se acepte por el usuario.
La tabla devuelta incluye los siguientes campos:
[{"Id": 0,"Name": "string","IsEditable": true}]
<th>introducir</th><th>Descripción</th></tr></thead><tbody><tr><td>id</td><td>int</td><td /></tr><tr><td>nombre</td><td>cadena</td><td /></tr><tr><td>esEditable</td><td>booleano</td><td /></tr></tbody>
Nombre |
---|
Parámetros
Devuelve
GetRecommendedAssets
Devuelve una lista de activos recomendados basados en un determinado Enum.AssetType y ID de activo.Usa esto para recopilar una lista de activos similares al activo proporcionado.Echa un vistazo al ejemplo de código a continuación para obtener más información sobre los posibles usos de esta función.
Los datos están en el formato:
[{"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}}]
Parámetros
El tipo de recomendaciones de activos para recuperar recomendaciones.Solo afecta la respuesta cuando las recomendaciones basadas en artículos no existen para el dado contextAssetId.
El ID de un activo con un tipo que coincida con el tipo de activo proporcionado utilizado para el contexto al recuperar recomendaciones.
Devuelve
Una lista de recomendaciones basadas en el dado Enum.AssetType .
Muestras de código
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
Esta función devuelve una lista de paquetes recomendados para un ID de paquete dado.
Los datos están en el formato:
[{"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}}}]
Parámetros
Una lista de paquetes recomendados.
Devuelve
El ID del paquete al que se devolverán los paquetes recomendados.
SearchCatalog
Esta función devuelve un objeto CatalogPages que contiene el resultado de la buscardada.
Los datos devueltos tienen el formato:
[{"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}]
Parámetros
Un objeto que contiene los parámetros utilizados para la buscar.
Devuelve
Eventos
PromptAllowInventoryReadAccessCompleted
Este evento se activa cuando el AvatarEditorService:PromptAllowInventoryReadAccess() prompt es respondido por el usuario.Solo puede devolver los estados de éxito o denegación de permiso enum ya que no realiza ninguna solicitud web que pueda fallar.
Parámetros
El resultado de la solicitud.
PromptCreateOutfitCompleted
Este evento se activa cuando se completa la operación de Guardar atuendo rápido.Da un estado enum indicando si el mensaje de confirmación tuvo éxito, falló o el permiso no fue otorgado por el usuario.
Parámetros
El resultado de la solicitud.
PromptDeleteOutfitCompleted
Se activa cuando se completa la operación de Eliminar atuendo rápido.Da un estado enum indicando si el mensaje de confirmación tuvo éxito, falló o el permiso no fue otorgado por el usuario.
Parámetros
El resultado de la solicitud.
PromptRenameOutfitCompleted
Se enciende cuando se completa la operación de Renombrar el atuendo.Da un estado enum indicando si el mensaje de confirmación tuvo éxito, falló o el permiso no fue otorgado por el usuario.
Parámetros
El resultado de la solicitud.
PromptSaveAvatarCompleted
Este evento se activa cuando se completa la operación AvatarEditorService:PromptSaveAvatar().Da un estado enum indicando si el mensaje de confirmación tuvo éxito, falló o el permiso no fue otorgado por el usuario.
Parámetros
El resultado de la solicitud.
PromptSetFavoriteCompleted
Se enciende cuando la operación AvatarEditorService:PromptSetFavorite() se completa.Da un estado enum indicando si el mensaje de confirmación tuvo éxito, falló o el permiso no fue otorgado por el usuario.
Parámetros
El resultado de la solicitud.
PromptUpdateOutfitCompleted
Se enciende cuando la operación AvatarEditorService:PromptUpdateOutfit() se completa.Da un estado enum indicando si el mensaje de confirmación tuvo éxito, falló o el permiso no fue otorgado por el usuario.
Parámetros
El resultado de la solicitud.