steamworks.setAchievementProgress()

类型 函数
返回值 布尔值
修订版 2024.3703 版
关键词 steam、steamworks、成就、setAchievementProgress
另请参阅 steamworks.setAchievementUnlocked()
achievementInfoUpdate
steamworks.*

概述

为当前用户设置一项成就取得的进展量。这样做主要是为了显示目的。调用此函数会触发在 Steam 客户端启用覆盖层时向用户显示的 Steam 通知弹出窗口,通知其当前进展。如果给定进度value参数大于或等于给定的maxValue参数,则会自动解锁成就。

如果成就进度成功更新,则返回true

如果给定无效参数或 steamworks.isLoggedOn 属性为false,则返回false

注意

你可以使用 steamworks.setNotificationPosition() 函数控制 Steam 的通知弹出窗口在应用中显示的位置。

注意事项

Steam 不会保存对成就取得的进展量。Steam 只保存成就的锁定/解锁状态。这意味着应用开发者负责追踪并在 Steam 外部存储该量(例如存储到文件中),直到成就解锁。

语法

steamworks.setAchievementProgress( achievementName, value, maxValue )
achievementName (必需的)

字符串. 在 Steamworks 网站上,这是成就的唯一名称,设置为API 名称 Progress Stat列。

value (必需的)

数字. 指示取得的当前成就进度,范围从0maxValue 参数。

maxValue (必需的)

数字. 定义在成就解锁之前取得的最大进度值。

示例

local steamworks = require( "plugin.steamworks" )

-- Set the achievement progress to "50/100"
steamworks.setAchievementProgress( "My Achievement Name", 50, 100 )