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 apoyar a los editores de avatar del desarrollador. Proporciona métodos para modificar el avatar del jugador, solicitar información del inventario del usuario y solicitar información del catálogo.
Para obtener más información sobre el Editor de Avatar, see Servicio de Editor de Avatar .
Acelerador
Los siguientes puntos de finalización en AvatarEditorService tienen un nivel de experiencia de limitación:
Para cada experiencia, esta aceleración te permite enviar hasta 100 solicitudes por segundo a estos puntos de interfono, independientemente del número de servidores o de usuarios. Exceder estos límites devuelve un error 429 Demasiadas solicitudes .
Si encuentra que su experiencia requiere un ajuste a este acelerador, puede enviar una solicitud de función aquí.
Resumen
Métodos
Indicaciones al Players.LocalPlayer para permitir al desarrollador leer qué artículos tiene el usuario en su inventario y otra información relacionada con el editor de avatares.
Solicita que el Players.LocalPlayer guarde 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 que el Players.LocalPlayer actualice su avatar según el dado HumanoidDescription y Enum.RigType de R6 o R15.
Solicita al Players.LocalPlayer favorito o desfavorito el recurso o paquete proporcionado.
- PromptUpdateOutfit(outfitId : number,updatedOutfit : HumanoidDescription,rigType : Enum.HumanoidRigType):void
Solicita al Players.LocalPlayer actualizar el atuendo dado.
Se usa para aplicar la ropa predeterminada a la HumanoidDescription si es necesario.
Regresa las reglas de la plataforma Avatar para cosas como escalar, camisas y pantalones por defecto, número de objetos de usabilidad.
Obtiene los detalles del artículo para una lista de artículos a la vez.
Regresa si el Players.LocalPlayer ha marcado como favorito el recursoo el activo proporcionado.
Regresa un objeto de Class.InventoryPages con información de los elementos obtenidos en el inventario de los usuarios con los tipos de atributos dados.
Regresa los detalles del artículo para el objetodado.
Devuelve los detalles del atuendo para el atuendo dado.
Devuelve el dato del atuendo para el Players.LocalPlayer .
Devuelve una lista de recomendados recursos en función de un Enum.AssetType y el ID de activo.
Regresa una lista de paquetes recomendados para un ID de paquete específico.
Regresa un objeto CatalogPages que contiene el resultado de la buscarproporcionado.
Eventos
Se activa cuando se responde el mensaje de solicitud de AvatarEditorService:PromptAllowInventoryReadAccess() por el usuario.
Se activa cuando se completa la operación de guardado de la solicitud.
Se activa cuando se completa la operación de eliminación de ropa.
Se activa cuando se completa la operación de renombrar el conjunto.
- PromptSaveAvatarCompleted(result : Enum.AvatarPromptResult,humanoidDescription : HumanoidDescription):RBXScriptSignal
Se activa cuando se completa la operación AvatarEditorService:PromptSaveAvatar() .
Se activa cuando se completa la operación AvatarEditorService:PromptSetFavorite() .
Se activa cuando se completa la operación AvatarEditorService:PromptUpdateOutfit() .
Propiedades
Métodos
GetAccessoryType
Parámetros
Devuelve
PromptAllowInventoryReadAccess
Solicita que el Players.LocalPlayer le permita al desarrollador leer qué artículos tiene el usuario en su inventario y otra información del editor de avatares relacionada. La solicitud debe ser confirmada por el usuario para que el desarrollador use AvatarEditorService:GetInventory(), Class.AvatarEditorService:GetOutfits
Devuelve
PromptCreateOutfit
Solicita al Players.LocalPlayer guardar el dado HumanoidDescription como un atuendo. No funciona. 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 se creará el atuendo si el jugador confirma el mensaje.
Devuelve
PromptDeleteOutfit
Solicita al Players.LocalPlayer que elimine el atuendo dado. No funciona. 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 funciona. El resultado se puede recuperar escuchando el evento AvatarEditorService.PromptRenameOutfitCompleted .
Parámetros
El outfitId de la ropa 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 produce resultados y se puede obtener el resultado escuchando el evento PromptSaveAvatarCompleted. Esto es similar a cómo funcionan otros prom示 2> PromptPurchase2> y similares
Parámetros
El HumanoidDescription dado se está solicitando para guardar.
El Enum.RigType que el avatar se guardará para si el jugador confirma el mensaje.
Devuelve
PromptSetFavorite
Esta función solicita al Players.LocalPlayer favorito o desfavorito el recurso o paquete dado.
Parámetros
El ItemId del artículo que se solicita para añadir a favoritoscomo favorito.
El tipo de artículo que se solicita para marcar como añadir a favoritos.
Devuelve
PromptUpdateOutfit
Indicaciones al Players.LocalPlayer para actualizar el atuendo dado con la descripción de humanoides.
Parámetros
El outfitId de la ropa para actualización.
Una descripción humanoide que representa los nuevos datos de la ropa.
El tipo de modelo de cuerda humanoide para actualizar el atuendo.
Devuelve
CheckApplyDefaultClothing
Regresa una nueva HumanoidDescription con las propiedades de la camisa y los pantalones actualizadas si es necesario. Regresa nulo si no se necesitó la ropa predeterminada.
La ropa predeterminada es necesaria si la descripción del humano no tiene actualmente camisa y pantalón equipado y los colores del cuerpo son demasiado similares.
Parámetros
La descripción de humanoid para ver si se requiere ropa predeterminada.
Devuelve
Devuelve una descripción de humanoide si se necesitaba ropa de defecto. De lo contrario, devuelve nulo.
ConformToAvatarRules
Parámetros
Devuelve
GetAvatarRules
Esta función devuelve las reglas de la plataforma Avatar para cosas como escalar, camisas y pantalones por defecto, número de objetos de usabilidad, 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 la plataforma Avatar para cosas como escalar, camisas y pantalones por defecto, número de activos de usabilidad, etc. Ver el ejemplo de regreso en la descripción principal arriba.
GetBatchItemDetails
Obtiene los detalles del artículo para una lista de artículos a la vez. Más eficiente que AvatarEditorService:GetItemDetails si necesitas obtener todos los detalles del artículo de una lista.
Parámetros
La lista de ID de artículo para obtener detalles.
El tipo de los ID de los elementos proporcionados.
Devuelve
Regresa un arreglo 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返回 si el Players.LocalPlayer ha marcado como favorito el recursoo el activo dado.
Parámetros
El ID de la especificación de activos o paquete.
El Enum.AvatarItemType del activo o el paquete especificado.
Devuelve
Si el LocalPlayer ha marcado como favorito el recursoo el activo dado.
GetInventory
Devuelve un objeto InventoryPages con información sobre los elementos obtenidos en el inventario de los usuarios con el AvatarAssetTypes dado.
La tabla devuelta incluye los siguientes campos:
[{"AssetId": 0,"AssetType" : "string","Created": "string","Name": "string",}]
Parámetros
El Enum.AvatarAssetType que se puede verificar 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 el 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 buscar por activos limitados o ilimitados, use los siguientes valores de itemRestrictions :
| itemRestrictions | Limitado o Ilimitado | | :--------------: | :-------------------: | | empty | Unlimited | | Collectible | UGC Limitado | | Limited | Roblox Limitado Unique |
Parámetros
El ID del artículo cuyos detalles se están recuperando.
Un valor de lista 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. Ver arriba para una tabla de ejemplo.
GetOutfitDetails
Esta función devuelve los detalles del outfit para el outfit dado. Acepta un parámetro: el ID del outfit.
Las respuestas de 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 de la ropa para la ropa recuperada. Vea arriba para obtener una tabla de ejemplo.
GetOutfits
Esta función返回服装数据 para el Players.LocalPlayer . Esto se usaría con Players:GetHumanoidDescriptionFromOutfitId() para actualizar el personaje del jugador a la ropa. El acceso a esto también dependería de AvatarEditorService:PromptAllowInventoryReadAccess() siendo aceptado por el usuario.
La tabla devuelta incluye los siguientes campos:
[{"Id": 0,"Name": "string","IsEditable": true}]
<tbody><tr><td>identificación</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 | introducir | Descripción |
---|
Parámetros
Devuelve
GetRecommendedAssets
Devuelve una lista de recomendados recursos según un conjunto de datos dado Enum.AssetType y el ID de activo. Usa esto para recopilar una lista de recursos similares a la que proporciona el recurso. Echa un vistazo al código de ejemplo a continuación para obtener más información sobre posibles usos para 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 tipo de activo para recuperar recomendaciones. Afecta solo a la respuesta cuando las recomendaciones basadas en el tipo no existen para el contextAssetId dado.
El ID de un activo con un tipo que coincida con el tipo proporcionado para contexto al recuperar recomendaciones.
Devuelve
Una lista de recomendaciones basadas en el Enum.AssetType dado.
Muestras de código
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返回 un listado de recomendados conjuntos de productos para un determinado ID de conjunto de productos.
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 de paquete que se devolverá para los paquetes recomendados.
SearchCatalog
Esta función devuelve un objeto CatalogPages que contiene el resultado de la buscarproporcionado.
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 usados para la buscar.
Devuelve
Eventos
PromptAllowInventoryReadAccessCompleted
Este evento se activa cuando se responde el AvatarEditorService:PromptAllowInventoryReadAccess() prom示 por el usuario. Solo puede返回成功或权限拒绝 enum estados como no realiza ninguna solicitud web que podría fallar.
Parámetros
El resultado de la solicitud.
PromptCreateOutfitCompleted
Este evento se activa cuando se completa la operación de guardado de avatar. Indica un estado enum que indica si el aviso de guardado tuvo éxito, falló o no se otorgó el permiso por el usuario.
Parámetros
El resultado de la solicitud.
PromptDeleteOutfitCompleted
Se activa cuando se completa la operación de eliminación de la solicitud. Indica un estado enum que indica si la solicitud tuvo éxito, falló o no se otorgó el permiso por el usuario.
Parámetros
El resultado de la solicitud.
PromptRenameOutfitCompleted
Se activa cuando se completa la operación de renombrar el conjunto. Indica un estado enum que indica si el conjunto solicitado tuvo éxito, falló o no se otorgó el permiso por el usuario.
Parámetros
El resultado de la solicitud.
PromptSaveAvatarCompleted
Este evento se activa cuando se completa la operación AvatarEditorService:PromptSaveAvatar(). Indica un estado enum que indica si el mensaje se ha completado, falló o no se ha concedido el permiso por el usuario.
Parámetros
El resultado de la solicitud.
PromptSetFavoriteCompleted
Se activa cuando se completa la operación AvatarEditorService:PromptSetFavorite(). Indica un estado enum que indica si el mensaje se ha ejecutado con éxito, falló o no se ha concedido el permiso por el usuario.
Parámetros
El resultado de la solicitud.
PromptUpdateOutfitCompleted
Se activa cuando se completa la operación AvatarEditorService:PromptUpdateOutfit(). Indica un estado enum que indica si el mensaje se ha ejecutado con éxito, falló o no se ha concedido el permiso por el usuario.
Parámetros
El resultado de la solicitud.