概要
方法
活動
AvatarAssetModerationCompleted(assetId: number,moderationStatus: Enum.ModerationStatus):RBXScriptSignal |
AvatarModerationCompleted(outfitId: number,moderationStatus: Enum.ModerationStatus):RBXScriptSignal |
API 參考
方法
AutoSetupAvatarAsync
AvatarCreationService:AutoSetupAvatarAsync(
參數
返回
範例程式碼
自動設置角色異步
local AvatarCreationService = game:GetService("AvatarCreationService")
local ReplicatedStorage = game:GetService("ReplicatedStorage")
local LoadAvatarEvent = ReplicatedStorage.LoadAvatarEvent
local generatedAvatars = {}
-- 必須在伺服器上調用
local function setupAvatar(player: Player, avatarModel: Model, layeredShirtModel : Model)
local arguments = {
Body = avatarModel,
Accessories = {}
}
local accessoryArgument = {
AccessoryType = Enum.AccessoryType.Shirt,
IsLayered = true,
Instance = layeredShirtModel,
}
table.insert(arguments.Accessories, accessoryArgument)
local pcallSuccess, result = pcall(function()
local generationId = AvatarCreationService:AutoSetupAvatarAsync(
player,
arguments,
function(progressInfo)
print(`自動設置進度: {progressInfo.Progress * 100}%`)
end
)
-- 在伺服器上加載並存儲以便與 PromptCreateAvatarAsync 一起使用
local humanoidDescription = AvatarCreationService:LoadGeneratedAvatarAsync(generationId)
generatedAvatars[generationId] = humanoidDescription
-- 向客戶端發送信號,以便它可以加載角色以進行本地預覽
LoadAvatarEvent:FireClient(player, generationId)
end)
if not pcallSuccess then
warn("角色設置失敗:", result)
end
endGenerateAvatar2DPreviewAsync
AvatarCreationService:GenerateAvatar2DPreviewAsync(
參數
返回
範例程式碼
生成 Avatar2 D 預覽非同步
local AvatarCreationService = game:GetService("AvatarCreationService")
function generateAvatar2DPreview(sessionId, fileId, textPrompt)
local pcallSuccess, result = pcall(function()
local args = {}
args.SessionId = sessionId
args.FileId = fileId
args.TextPrompt = textPrompt
return AvatarCreationService:GenerateAvatar2DPreviewAsync(args)
end)
if not pcallSuccess then
warn("生成 2D 預覽失敗: ", result)
end
return result
endGenerateAvatarAsync
AvatarCreationService:GenerateAvatarAsync(
參數
返回
範例程式碼
生成虛擬角色異步
local AvatarCreationService = game:GetService("AvatarCreationService")
function generateAvatar(sessionId, previewId)
local pcallSuccess, result = pcall(function()
local args = {}
args.SessionId = sessionId
args.PreviewId = previewId
return AvatarCreationService:GenerateAvatarAsync(args)
end)
if not pcallSuccess then
warn("生成虛擬角色失敗: ", result)
end
return result
endGetBatchTokenDetailsAsync
LoadAvatar2DPreviewAsync
參數
範例程式碼
載入 Avatar2 D 預覽異步
local AvatarCreationService = game:GetService("AvatarCreationService")
function loadAvatar2DPreview(previewId)
local pcallSuccess, result = pcall(function()
return AvatarCreationService:LoadAvatar2DPreviewAsync(previewId)
end)
if not pcallSuccess then
warn("無法載入預覽: ", result)
end
return result
endLoadGeneratedAvatarAsync
參數
範例程式碼
載入生成的虛擬角色
local AvatarCreationService = game:GetService("AvatarCreationService")
local Players = game:GetService("Players")
-- 可以在伺服器或客戶端上調用
local function loadAvatar(generationId: string): Model?
local pcallSuccess, result = pcall(function()
local humanoidDescription = AvatarCreationService:LoadGeneratedAvatarAsync(generationId)
local model = Players:CreateHumanoidModelFromDescriptionAsync(humanoidDescription, Enum.HumanoidRigType.R15)
return model
end)
if pcallSuccess then
return result
else
print("虛擬角色載入失敗:", result)
return nil
end
endPrepareAvatarForPreviewAsync
PromptCreateAvatarAssetAsync
AvatarCreationService:PromptCreateAvatarAssetAsync(
參數
返回
範例程式碼
提示創建角色資產異步
local AvatarCreationService = game:GetService("AvatarCreationService")
local function publishAvatarAsset(tokenId: string, player: Player, assetInstance: Accessory, assetType: Enum.AvatarAssetType)
local pcallSuccess, result, resultMessage = pcall(function()
return AvatarCreationService:PromptCreateAvatarAssetAsync(tokenId, player, assetInstance, assetType)
end)
if pcallSuccess then
if result == Enum.PromptCreateAssetResult.Success then
print("成功上傳,資產ID: ", resultMessage)
else
print("上傳失敗,錯誤信息:", resultMessage)
end
else
print("角色資產創建失敗。")
end
endPromptCreateAvatarAsync
AvatarCreationService:PromptCreateAvatarAsync(
參數
返回
範例程式碼
PromptCreateAvatarAsync
local AvatarCreationService = game:GetService("AvatarCreationService")
export type BodyPartInfo = {
bodyPart: Enum.BodyPart,
instance: Instance, --包含創建的 MeshParts 的資料夾
}
export type BodyPartList = { BodyPartInfo }
local function publishAvatar(bodyPartInstances: BodyPartList, player: Player, tokenId: string)
local humanoidDescription = Instance.new("HumanoidDescription")
for _, bodyPartInfo in bodyPartInstances do
local bodyPartDescription = Instance.new("BodyPartDescription")
bodyPartDescription.Instance = bodyPartInfo.instance
bodyPartDescription.BodyPart = bodyPartInfo.bodyPart
bodyPartDescription.Parent = humanoidDescription
end
local pcallSuccess, result, resultMessage = pcall(function()
return AvatarCreationService:PromptCreateAvatarAsync(tokenId, player, humanoidDescription)
end)
if pcallSuccess then
if result == Enum.PromptCreateAvatarResult.Success then
print("成功上傳,BundleId: ", resultMessage)
else
print("上傳失敗,錯誤信息:", resultMessage)
end
else
print("虛擬形象創建失敗。")
end
endPromptSelectAvatarGenerationImageAsync
RequestAvatarGenerationSessionAsync
返回
範例程式碼
請求角色生成會話非同步
local AvatarCreationService = game:GetService("AvatarCreationService")
local playerSessions = {}
local playerSessionRequests = {}
function requestAvatarGenerationSession(player)
local pcallSuccess, conn, waitTime = pcall(function()
return AvatarCreationService:RequestAvatarGenerationSessionAsync(player, function(sessionInfo)
playerSessions[player.UserID] = sessionInfo
playerSessionRequests[player.UserID] = nil
end)
end)
if not pcallSuccess then
warn("請求角色生成會話失敗: ", conn)
end
playerSessionRequests[player.UserID] = conn
print("會話等待時間: ", tostring(waitTime))
end
function cancelAvatarGenerationSessionRequest(player)
if playerSessionRequests[player.UserID] ~= nil then
playerSessionRequests[player.UserID]:Disconnect()
end
endValidateUGCAccessoryAsync
AvatarCreationService:ValidateUGCAccessoryAsync(
參數
返回
ValidateUGCBodyPartAsync
AvatarCreationService:ValidateUGCBodyPartAsync(
參數
返回
ValidateUGCFullBodyAsync
AvatarCreationService:ValidateUGCFullBodyAsync(
參數
返回
活動
AvatarAssetModerationCompleted
AvatarCreationService.AvatarAssetModerationCompleted(
參數
範例程式碼
虛擬形象資產審核完成
local AvatarCreationService = game:GetService("AvatarCreationService")
local conn = AvatarCreationService.AvatarAssetModerationCompleted:Connect(function(assetId, moderationStatus)
print("資產, " .. assetId .. ", 已準備好,審核狀態: " .. moderationStatus)
end)AvatarModerationCompleted
AvatarCreationService.AvatarModerationCompleted(
參數