steamworks.requestLeaderboardInfo()

类型 函数
返回值 布尔值
修订 版本 2024.3703
关键词 steam, steamworks, 排行榜, requestLeaderboardInfo
另请参阅 steamworks.requestLeaderboardEntries()
steamworks.requestSetHighScore()
leaderboardInfo
steamworks.*

概述

异步获取单个排行榜的信息，例如其条目计数、显示/值类型、排序顺序等。

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

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

语法

steamworks.requestLeaderboardInfo( params )
params (必填)

表. 包含参数的表 — 有关详细信息，请参阅下一节。

参数参考

params 表可以包含以下内容

leaderboardName (必填)

字符串. 要从中获取信息的排行榜的唯一名称。在 Steamworks 网站上，这是在**名称**列下设置的排行榜字符串。

listener (必填)

函数. 将通过 leaderboardInfo 事件接收请求结果的函数。

示例

local steamworks = require( "plugin.steamworks" )

local function onReceivedLeaderboardInfo( event )
    if ( event.isError ) then
        -- The request has failed
        print( "Failed to fetch leaderboard info." )
    else
        -- Print the received leaderboard information to the log
        print( "Leaderboard Name: " .. event.leaderboardName )
        print( "Entry Count: " .. tostring(event.entryCount) )
        print( "Sort Method: " .. event.sortMethod )
        print( "Display Type: " .. event.displayType )
    end
end

-- Fetch information about one leaderboard
-- Requires an active Internet connection to succeed
-- Provides the requested result to the given "listener" function
local requestSettings =
{
    leaderboardName = "My Leaderboard Name",
    listener = onReceivedLeaderboardInfo
}
steamworks.requestLeaderboardInfo( requestSettings )