MGL リーダーボード [詳解]

#include <mgl/leaderboard/mgl_leaderboard_server.h>

関数
template<class DelegateClass , class... Args>
bool	MGL::Leaderboard::CreateServer (Args... args) noexcept
	リーダーボードサーバの生成

bool	MGL::Leaderboard::IsAvailableServer () noexcept
	サーバの有効状態を取得

bool	MGL::Leaderboard::ReportScore (Identifier identifier, uint64_t score, const OptionDataArray &options=OptionDataArray()) noexcept
	スコアの送信

bool	MGL::Leaderboard::FetchEntryData (Identifier identifier, uint32_t startRank, uint32_t requestSize, PlayerScope playerScope) noexcept
	エントリデータを取得

bool	MGL::Leaderboard::FetchEntryDataAroundUser (Identifier identifier, uint32_t requestSize, PlayerScope playerScope) noexcept
	プレイヤーの順位を中心にエントリデータを取得

bool	MGL::Leaderboard::UploadClipData (Identifier identifier, const ClipData &clipData) noexcept
	クリップデータの送信

bool	MGL::Leaderboard::DownloadClipData (uint64_t clipID) noexcept
	クリップデータのダウンロード

const FetchResults &	MGL::Leaderboard::GetFetchedData () noexcept
	エントリ取得結果を取得

const ReportResults &	MGL::Leaderboard::GetReportResults () noexcept
	送信結果を取得

const ClipData &	MGL::Leaderboard::GetClipData () noexcept
	ダウンロードしたクリップデータを取得

ClipData::ErrorType	MGL::Leaderboard::GetClipDataUploadResults () noexcept
	クリップデータのアップロード結果を取得

bool	MGL::Leaderboard::IsProcessing () noexcept
	サーバが処理中かどうかを取得

bool	MGL::Leaderboard::IsReady () noexcept
	サーバが処理可能な状態かを取得

Server::State	MGL::Leaderboard::GetServerState () noexcept
	現在のサーバのステートを取得

詳解

MGL リーダーボード

日付: Since: September 8, 2021. 2:56:31 JST.

著者: Acerola

関数詳解

◆ CreateServer()

template<class DelegateClass , class... Args>

bool MGL::Leaderboard::CreateServer ( Args... args )

inlinenoexcept

リーダーボードサーバの生成

戻り値

true	成功
false	失敗

◆ DownloadClipData()

bool MGL::Leaderboard::DownloadClipData ( uint64_t clipID )

inlinenoexcept

クリップデータのダウンロード

引数

[in] clipID クリップデータの識別子

戻り値

true	成功
false	失敗

◆ FetchEntryData()

bool MGL::Leaderboard::FetchEntryData	(	Identifier	identifier,
		uint32_t	startRank,
		uint32_t	requestSize,
		PlayerScope	playerScope )

inlinenoexcept

エントリデータを取得

引数

[in]	identifier	リーダーボードの識別子
[in]	startRank	取得する最初の順位
[in]	requestSize	取得するエントリ数
[in]	playerScope	取得するプレイヤーのスコープ

戻り値

true	成功
false	失敗

◆ FetchEntryDataAroundUser()

bool MGL::Leaderboard::FetchEntryDataAroundUser	(	Identifier	identifier,
		uint32_t	requestSize,
		PlayerScope	playerScope )

inlinenoexcept

プレイヤーの順位を中心にエントリデータを取得

引数

[in]	identifier	リーダーボードの識別子
[in]	requestSize	取得するエントリ数
[in]	playerScope	取得するプレイヤーのスコープ

戻り値

true	成功
false	失敗

◆ GetClipData()

const ClipData & MGL::Leaderboard::GetClipData ( )

inlinenodiscardnoexcept

ダウンロードしたクリップデータを取得

戻り値: クリップデータ

◆ GetClipDataUploadResults()

ClipData::ErrorType MGL::Leaderboard::GetClipDataUploadResults ( )

inlinenodiscardnoexcept

クリップデータのアップロード結果を取得

戻り値: クリップデータのエラータイプ．成功している場合はErrorType::None

◆ GetFetchedData()

const FetchResults & MGL::Leaderboard::GetFetchedData ( )

inlinenodiscardnoexcept

エントリ取得結果を取得

戻り値: 取得結果

◆ GetReportResults()

const ReportResults & MGL::Leaderboard::GetReportResults ( )

inlinenodiscardnoexcept

送信結果を取得

戻り値: 送信結果

◆ GetServerState()

Server::State MGL::Leaderboard::GetServerState ( )

inlinenodiscardnoexcept

現在のサーバのステートを取得

戻り値: 現在のサーバのステート

◆ IsAvailableServer()

bool MGL::Leaderboard::IsAvailableServer ( )

inlinenodiscardnoexcept

サーバの有効状態を取得

戻り値

true	有効
false	無効

◆ IsProcessing()

bool MGL::Leaderboard::IsProcessing ( )

inlinenodiscardnoexcept

サーバが処理中かどうかを取得

戻り値

true	処理中
false	処理中でない

◆ IsReady()

bool MGL::Leaderboard::IsReady ( )

inlinenodiscardnoexcept

サーバが処理可能な状態かを取得

戻り値

true	処理中
false	処理中でない

◆ ReportScore()

bool MGL::Leaderboard::ReportScore	(	Identifier	identifier,
		uint64_t	score,
		const OptionDataArray &	options = OptionDataArray() )

inlinenoexcept

スコアの送信

引数

[in]	identifier	リーダーボードの識別子
[in]	score	送信するスコア
[in]	options	送信するオプションデータ

戻り値

true	成功
false	失敗

◆ UploadClipData()

bool MGL::Leaderboard::UploadClipData	(	Identifier	identifier,
		const ClipData &	clipData )

inlinenoexcept

クリップデータの送信

引数

[in]	identifier	リーダーボードの識別子
[in]	clipData	送信するクリップデータ

戻り値

true	成功
false	失敗