stingray.Leaderboard ネームスペース リファレンス

説明

このインタフェースは、Steam のリーダーボード機能にアクセスするためのものです。

オブジェクトはシングルトンである(1 つの Leaderboard のみが存在する)ため、関数に Leaderboard オブジェクトを渡す必要はありません。すべての関数は Leaderboard シングルトンに対して動作します。

その他の関連リファレンス項目

	stingray.LeaderboardTransactionToken
	steam_leaderboard_progress
	Steam

関数

close ( token ) 指定されたトークンに対応する要求をモニタするためにエンジンによって使用されているメモリを解放します。

パラメータ

token :

stingray.LeaderboardTransactionToken

閉じるトークンです。

戻り値

この関数は値を返しません。

その他の関連リファレンス項目

stingray.LeaderboardTransactionToken

init_leaderboards ( boards ) : stingray.LeaderboardTransactionToken 指定されたリーダーボードをプリロードします。

パラメータ

boards :

any(string, string[])

リーダーボードの名前、または複数のリーダーボード名が含まれているテーブル。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

戻り値

stingray.LeaderboardTransactionToken

progress() を呼び出すことによってクエリーできるトークンです。

Leaderboard インタフェースを介してゲームで使用されるすべてのリーダーボードは、使用する前に「プリロード」できます。すべてのリーダーボードが事前にわかっている場合は、プリロードすることをお勧めします。これは必須ではありませんが、その後のリーダーボードのクエリーがすばやくなります(プリロードされたリーダーボードの 1 つを初めて使用するとき)。

たとえば、次のようになります。

token1 = stingray.Leaderboard.init_leaderboards("jumps")
token2 = stingray.Leaderboard.init_leaderboards({ "jumps", "high_jumps" })

progress ( token ) : table 指定されたトークンで識別される操作の現在の状態に関する情報を取得します。

パラメータ

token :

stingray.LeaderboardTransactionToken

LeaderboardTransactionToken を指定します。

戻り値

table

操作に関する情報が含まれているテーブルです。

その他の関連リファレンス項目

	stingray.LeaderboardTransactionToken
	steam_leaderboard_progress
	stingray.Leaderboard.init_leaderboards() stingray.Leaderboard.ranking_around_self() stingray.Leaderboard.ranking_for_friends() stingray.Leaderboard.ranking_range() stingray.Leaderboard.register_score()

ranking_around_self ( board, ranks_before, ranks_after, data_template ) : stingray.LeaderboardTransactionToken ログインしているプレイヤーの周辺のプレイヤーのランキング情報を取得します。

パラメータ

board :	string	データを取得するリーダーボードの ID です。
ranks_before :	integer	ログインしているプレイヤーより前に取得するランクの数です(つまり、取得する上位スコアの数)。
ranks_after :	integer	ログインしているプレイヤーより後に取得するランクの数です(つまり、取得する下位スコアの数)。
data_template :	table?	オプション。リーダーボードにカスタム データを格納しない場合は、このパラメータをスキップします。または、データを読み取る場合は、これをカスタム データの形式が含まれているテーブルに設定します。このテーブルは、データ テンプレートとして stingray.Leaderboard.register_score()関数に送信されるテーブルと正確に同じでなければなりません。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.LeaderboardTransactionToken

progress() を呼び出すことによってクエリーできるトークンです。

たとえば、次のようになります。

template =
{
    Leaderboard.BOOL,
    Leaderboard.STRING(6),
    Leaderboard.INT(8)
}

token = Leaderboard.ranking_around_self("jumps", 5, 5, template)

ranking_for_friends ( board, data_template ) : stingray.LeaderboardTransactionToken 現在のプレイヤーおよび友人のランキング情報を取得します。

パラメータ

board :	string	データを取得するリーダーボードの ID です。
data_template :	table?	オプション。リーダーボードにカスタム データを格納しない場合は、このパラメータをスキップします。または、データを読み取る場合は、これをカスタム データの形式が含まれているテーブルに設定します。このテーブルは、データ テンプレートとして stingray.Leaderboard.register_score()関数に送信されるテーブルと正確に同じでなければなりません。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.LeaderboardTransactionToken

progress() を呼び出すことによってクエリーできるトークンです。

ranking_range ( board, start_range, num_ranks, data_template ) : stingray.LeaderboardTransactionToken リーダーボードの一部を取得します。

パラメータ

board :	string	データを取得するリーダーボードの ID です。
start_range :	integer	取得する最初の連番ランクです(1 で開始)。
num_ranks :	integer	開始ランクを含む、取得するランクの数です。
data_template :	table?	オプション。リーダーボードにカスタム データを格納しない場合は、このパラメータをスキップします。または、データを読み取る場合は、これをカスタム データの形式が含まれているテーブルに設定します。このテーブルは、データ テンプレートとして stingray.Leaderboard.register_score()関数に送信されるテーブルと正確に同じでなければなりません。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.LeaderboardTransactionToken

progress() を呼び出すことによってクエリーできるトークンです。

たとえば、次のようになります。

token = Leaderboard.ranking_range("jumps", 1, 100)

その他の関連リファレンス項目

steam_leaderboard_progress.scores steam_leaderboard_progress.total_scores

register_score ( board, score, update_method, data_template, data ) : stingray.LeaderboardTransactionToken 指定されたリーダーボードに新しいスコアを登録します。

パラメータ

board :	string	新しいスコアを登録するリーダーボードです。
score :	any(integer, string)	スコアが数値である場合、その値を使用してスコアを更新します。スコアが文字列である場合、同じ名前を持つ統計情報の値を使用してスコアを更新します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
update_method :	integer?	リーダーボードに既存のスコアの更新方法を指定します。update mode グループ内のいずれかの定数です。(オプション) 既定値は Leaderboard.KEEP_BEST です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
data_template :	table?	オプション。データおよびそれらのパック方法が含まれているデータ型をリストします。テーブルは、次の選択可能エントリが含まれるプレーン リストである必要があります。 stingray.Leaderboard.INT(num_bits) stingray.Leaderboard.UNIT(num_bits) stingray.Leaderboard.STRING(num_chars) stingray.Leaderboard.BOOL stingray.Leaderboard.NUMBER 各型定義は、data パラメータで指定されている値に対応している必要があります。パックされたデータの合計サイズは 64 バイトを超えてはなりません。サイズ制限を超えると情報が失われます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
data :	table?	オプション。データ テンプレートを使用してパックする必要のある値をリストします。INT、UINT、および NUMBER の各型は数値で表す必要があります。BOOL 型はブール値、STRING 型はテンプレートで指定されている文字数以下の文字列である必要があります。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

stingray.LeaderboardTransactionToken

progress() を呼び出すことによってクエリーできるトークンです。

たとえば、次のようになります。

token1 = stingray.Leaderboard.register_score("jumps", 10)

token2 = stingray.Leaderboard.register_score(
    "jumps",
    10,
    {
        stingray.Leaderboard.BOOL,
        stingray.Leaderboard.STRING(6),
        stingray.Leaderboard.INT(8)
    },
    {
        false,
        "high",
        -128
    }
)

その他の関連リファレンス項目

	stingray.Leaderboard.ranking_around_self() stingray.Leaderboard.ranking_for_friends() stingray.Leaderboard.ranking_range()
	更新モード

データ型指定子

BOOL : integer データ テンプレート テーブルで使用される、ブール値の型指定子です。

その他の関連リファレンス項目

stingray.Leaderboard.ranking_around_self() stingray.Leaderboard.register_score()

NUMBER : integer データ テンプレート テーブルで使用される、浮動小数点数の型指定子です。

INT ( num_bits ) : userdata データ テンプレート テーブルで使用される、符号付き整数の型指定子を返します。

パラメータ

num_bits :

integer

数値を格納するために使用するビット数です。 注: 1 ビットは符号に使用されるため、2 ビット INT は -2 ～ 1 の範囲の値を保持できます。格納できる最大値は s 2^(num_bits-1) -1 です。

戻り値

userdata

データ テンプレート テーブルで使用される、符号付き整数の型指定子です。

その他の関連リファレンス項目

stingray.Leaderboard.ranking_around_self() stingray.Leaderboard.register_score()

STRING ( num_chars ) : userdata データ テンプレート テーブルで使用される、固定サイズ文字列の型指定子を返します。

パラメータ

num_chars :

integer

文字列を格納するために予約される文字数です。これは、格納する最大の文字列の文字数以上である必要があります。実際には、追加の終端文字が予約されます。

戻り値

userdata

データ テンプレート テーブルで使用される、固定サイズ文字列の型指定子です。

その他の関連リファレンス項目

stingray.Leaderboard.ranking_around_self() stingray.Leaderboard.register_score()

UINT ( num_bits ) : userdata データ テンプレート テーブルで使用される、符号なし整数の型指定子を返します。

パラメータ

num_bits :

integer

数値を格納するために使用するビット数です。格納できる最大値は 2^num_bits - 1 です。

戻り値

userdata

データ テンプレート テーブルで使用される、符号なし整数の型指定子です。

更新モード

このグループ内の定数を register_score()の呼び出しで渡すことができます。

FORCE_UPDATE : integer リーダーボードのスコアは、常に新しい値で更新されます。

KEEP_BEST : integer 既存のスコアは、新しいスコアの方が良い場合にのみ更新されます。

その他の関連リファレンス項目

stingray.Leaderboard.register_score()