steamworks.requestSetHighScore()

概述

异步将给定的分数发送到指定的排行榜。只有当给定分数高于用户先前分数时，排行榜才会接受该分数。

如果请求已成功发送到 Steam，则返回 true。请注意，这并不一定意味着请求的操作将会成功。例如，如果没有互联网连接，此函数将返回 true。因此，监听器必须检查接收到的 event.isError 属性，以确定请求的操作是否成功。

如果给出无效参数或 steamworks.isLoggedOn 属性为 false，则返回 false。

注意事项

需要访问互联网才能在排行榜上设置高分。与成就和统计数据不同，Steam 不会在离线时缓存高分更新，并在互联网访问再次可用时将更改与 Steam 服务器重新同步。

语法

steamworks.requestSetHighScore( params )

参数参考

params 表可以包含以下内容

示例

local steamworks = require( "plugin.steamworks" )

local function onReceivedSetHighScoreResult( event )
    if ( event.isError ) then
        -- The request has failed
        -- Note that an error will not occur if the given score is less than the highest
        print( "Failed to access the leaderboard." )
    else
        -- Print the result of this request to the log
        print( "Leaderboard Name: " .. event.leaderboardName )
        print( "Was Score Changed: " .. tostring(event.scoreChanged) )
        if ( event.scoreChanged ) then
            print( "Current Rank: " .. tostring(event.currentGlobalRank) )
            print( "Previous Rank: " .. tostring(event.previousGlobalRank) )
        end
    end
end

-- Attempt to set a new high score for the current user
-- Requires an active Internet connection to succeed
-- Provides the requested result to the given "listener" function
local requestSettings =
{
    leaderboardName = "My Leaderboard Name",
    value = 9000,
    listener = onReceivedSetHighScoreResult,
}
steamworks.requestSetHighScore( requestSettings )