stingray.Leaderboard 네임스페이스 참조

설명

Steam의 순위표 기능에 액세스하기 위한 인터페이스입니다.

이 오브젝트는 싱글톤(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() 호출을 통해 쿼리할 수 있는 토큰입니다.

순위표 인터페이스를 통해 게임에서 사용되는 모든 순위표를 사용 전에 '미리 로드'할 수 있습니다. 모든 순위표를 사전에 알고 있는 경우에는 미리 로드하는 것이 좋습니다. 꼭 필요한 건 아니지만 이렇게 하면 순위표에 대한 이후의 쿼리가 더 깔끔해집니다(미리 로드한 순위표 중 하나를 처음으로 사용할 때).

예를 들면 다음과 같습니다.

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() 함수에 데이터 템플릿으로 전송한 테이블과 정확히 같아야 합니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

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() 함수에 데이터 템플릿으로 전송한 테이블과 정확히 같아야 합니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

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() 함수에 데이터 템플릿으로 전송한 테이블과 정확히 같아야 합니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

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입니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.
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바이트를 넘으면 안 됩니다. 이 크기 제한을 넘으면 정보를 잃을 수 있습니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.
data :	table?	선택 사항입니다. 여기에는 데이터 템플릿으로 패킹해야 하는 값들이 나열됩니다. INT, UINT 및 NUMBER 유형은 숫자 값으로 나타내야 합니다. BOOL 유형은 부울 값이어야 하며, STRING 유형은 템플릿에 지정되어 있는 문자열과 문자 수가 같거나 보다 적은 문자열이어야 합니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

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()
	Update modes

데이터 유형 식별자

BOOL : integer 데이터 템플릿 테이블에서 사용되는 부울 값의 유형 식별자입니다.

기타 관련 참조 항목

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

NUMBER : integer 데이터 템플릿 테이블에서 사용되는 부동 소수점 숫자의 유형 식별자입니다.

INT ( num_bits ) : userdata 데이터 템플릿 테이블에서 사용되는 부호 있는 정수의 유형 식별자를 반환합니다.

매개변수

num_bits :

integer

숫자를 저장하는 데 사용하는 비트 수입니다. 참고: 부호에 비트 하나가 사용되기 때문에 2비트 INT는 -2부터 1까지의 값을 저장할 수 있습니다. 저장할 수 있는 가장 큰 값은 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()