설명

Xbox One의 세션 기능에 액세스하는 인터페이스입니다.

기타 관련 참조 항목

함수

custom_property_json ( session_id, custom_property_key ) : integer

세션의 사용자 정의 특성을 가져오기 위한 비동기 요청을 시작합니다.

매개변수

session_id :	integer	세션의 ID입니다.
custom_property_key :	string	검색할 JSON 특성입니다.

반환하는 항목

integer

Lua 인터페이스에서 이 세션 작업을 참조하는 데 사용되는 세션 조회 ID입니다.

custom_property_json_result ( session_lookup_id ) : string

매개변수

session_lookup_id :

integer

상태를 가져오려는 세션 조회의 ID입니다. [stingray.MultiplayerSession.custom_properties_json()]을 통해 반환됩니다.

반환하는 항목

string

특성의 JSON 문자열 또는 null을 반환합니다.

custom_property_json_status ( session_lookup_id ) : integer

매개변수

session_lookup_id :

integer

상태를 가져오려는 세션 조회의 ID입니다.

반환하는 항목

integer

[stingray.MultiplayerSession.custom_properties_json()]으로 시작한 세션 조회의 상태를 반환합니다. SessionJobStatus(network.xbl.work_status) 상수 중 하나일 수 있습니다.

delete_smartmatch_ticket ( session_id, hopper_name, ticket_id )

SmartMatch 매치메이킹을 삭제하는 비동기 작업을 시작합니다.

매개변수

session_id :	integer	세션의 ID입니다.
hopper_name :	string	삭제할 호퍼의 이름입니다.
ticket_id :	string	start_smartmatch_result를 통해 반환되는 티켓 ID입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

기타 관련 참조 항목

free_custom_property_json ( session_lookup_id )

[stingray.MultiplayerSession.custom_properties_json()]으로 시작한 비동기 작업에 배정된 리소스의 점유를 풀어줍니다.

매개변수

session_lookup_id :

integer

리소스의 점유를 풀어줄 세션 조회의 ID입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

이 결과는 [stingray.MultiplayerSession.free_custom_property_json_status()]가 stingray.SessionJobStatus.COMPLETE 또는 stingray.SessionJobStatus.FAILED를 반환하는 경우에만 리소스 점유를 해제할 수 있습니다.

group_id ( session_id ) : integer

매개변수

session_id :

integer

세션 그룹 ID를 가져오려는 세션의 ID입니다.

반환하는 항목

integer

제공된 세션이 속해 있는 세션 그룹의 세션 그룹 ID입니다.

has_session_changed ( session_id ) : boolean

마지막 호출 시간 이후 세션이 변경되었는지 여부를 반환합니다.

매개변수

session_id :

integer

키워드를 설정하려는 세션의 ID입니다.

반환하는 항목

boolean

세션이 변경된 경우 true를 반환합니다.

이 변경 사항은 가시적이지 않을 수도 있습니다.

host_peer ( session_id ) : string?

매개변수

session_id :

integer

호스트를 가져오려는 세션의 ID입니다.

반환하는 항목

string?

호스트의 PeerId입니다. 호스트가 없으면 nil이 반환됩니다.

? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

keywords ( session_id ) : string[]

매개변수

session_id :

integer

키워드를 가져오려는 세션의 ID입니다.

반환하는 항목

string[]

세션 키워드 목록입니다.

[] 표기는 이 유형이 어레이임을 나타냅니다. 어레이는 구성원의 키가 순차적인 정수이며, 각 요소의 값이 표시된 유형의 인스턴스인 테이블입니다.

leave ( session_id )

제공된 세션에서 나가는 비동기 작업을 시작합니다.

매개변수

session_id :

integer

나가려는 세션의 ID입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

stingray.MultiplayerSession.status()가 stingray.MultiplayerSession.SHUTDOWN을 반환하면 stingray.Network.free_multiplayer_session()을 통해 세션의 점유를 풀어주는 것이 안전합니다.

기타 관련 참조 항목

members ( session_id ) : session_member[]

매개변수

session_id :

integer

구성원 목록을 가져오려는 세션의 ID입니다.

반환하는 항목

session_member[]

세션 내 구성원 목록입니다.

[] 표기는 이 유형이 어레이임을 나타냅니다. 어레이는 구성원의 키가 순차적인 정수이며, 각 요소의 값이 표시된 유형의 인스턴스인 테이블입니다.

session_id_to_uri ( session_id ) : string

매개변수

session_id :

string

URI를 검색하려는 세션 ID입니다.

반환하는 항목

string

세션 URI입니다.

session_uri_to_description ( session_uri ) : string, string

매개변수

session_uri :

string

세션 URI입니다.

반환하는 항목

string	세션 이름입니다.
string	세션 템플릿 이름

set_closed ( session_id, closed )

비동기적으로 값을 설정하고, 이 함수를 호출하기 전에 세션이 준비되어 있는지만 확인합니다.

매개변수

session_id :	integer	세션의 ID입니다.
closed :	boolean	새로운 닫힘 상태입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

set_current_user_member_custom_property_json ( session_id, custom_property_key, custom_property_json )

비동기적으로 값을 설정하고, 이 함수를 호출하기 전에 세션이 준비되어 있는지만 확인합니다.

매개변수

session_id :	integer	세션의 ID입니다.
custom_property_key :	string	설정할 JSON 특성입니다.
custom_property_json :	string	키의 JSON 값을 포함한 문자열입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

set_custom_property_json ( session_id, custom_property_key, custom_property_json )

비동기적으로 값을 설정하고, 이 함수를 호출하기 전에 세션이 준비되어 있는지만 확인합니다.

매개변수

session_id :	integer	세션의 ID입니다.
custom_property_key :	string	설정할 JSON 특성입니다.
custom_property_json :	string	키의 JSON 값을 포함한 문자열입니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

set_keywords ( user_id, session_id, session_keywords )

세션 키워드를 설정하는 비동기 작업을 시작합니다.

매개변수

user_id :	integer	키워드를 설정하려는 사용자의 ID입니다.
session_id :	integer	키워드를 설정하려는 세션의 ID입니다.
session_keywords :	string[]?	세션의 키워드를 나타내는 문자열의 테이블입니다(선택 사항). 문자열은 비어 있으면 안 되고, 최대 63자로 구성할 수 있습니다. [] 표기는 이 유형이 어레이임을 나타냅니다. 어레이는 구성원의 키가 순차적인 정수이며, 각 요소의 값이 표시된 유형의 인스턴스인 테이블입니다. ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

stingray.MultiplayerSession.status()를 통해 세션 상태를 추적할 수 있습니다. session_keywords가 제공되지 않는 경우에는 키워드가 빈 어레이로 설정됩니다.

smartmatch_result ( session_id ) : string, string, number

SmartMatch 매치메이킹으로 검색된 세션을 반환합니다.

매개변수

session_id :

integer

세션의 ID입니다.

반환하는 항목

string	매칭된 세션의 이름입니다.
string	매칭된 세션의 세션 템플릿 이름입니다.
number	SmartMatch을 통해 반환된 보통의 대기 시간입니다.

smartmatch_status ( session_id ) : integer

현재 SmartMatch 상태를 반환합니다.

매개변수

session_id :

integer

세션의 ID입니다.

반환하는 항목

integer

SmartMatch 매치메이킹의 상태. stingray.SmartMatchStatus 상수 중 하나가 됩니다.

기타 관련 참조 항목

start_smartmatch ( session_id, hopper_name, timeout, preserve_mode, ticket_attributes_json )

SmartMatch 매치메이킹 티켓을 생성하는 비동기 작업을 시작합니다.

매개변수

session_id :	integer	세션의 ID입니다.
hopper_name :	string	SmartMatch에 사용할 호퍼의 이름입니다.
timeout :	number	SmartMatch 시간 초과 값입니다.
preserve_mode :	integer	SmartMatch에 대한 보존 모드입니다. stingray.PreserveSessionMode 상수 중 하나여야 합니다.
ticket_attributes_json :	string?	SmartMatch 티켓 속성을 포함한 JSON 문자열입니다(선택 사항). ? 표기는 이 유형이 선택 사항임을 나타냅니다. 해당 인스턴스가 0개 또는 한 개일 수 있습니다.

반환하는 항목

이 함수는 아무 값도 반환하지 않습니다.

작업이 완료되면 start_smartmatch_result를 통해 티켓 시작 작업의 결과를 가져올 수 있습니다.

smartmatch_status를 통해 세션에서의 매치메이킹 상태를 추적할 수 있습니다.

매치메이킹을 취소하거나 완료 시 티켓을 삭제하려면 delete_smartmatch_ticket을 사용하십시오.

start_smartmatch_result ( session_id ) : string, number

매치메이킹 티켓 시작 작업의 결과를 반환합니다.

매개변수

session_id :

integer

세션의 ID입니다.

반환하는 항목

string	SmartMatch 매치메이킹 티켓의 티켓 ID입니다.
number	SmartMatch를 통해 반환된 예상 대기 시간입니다.

기타 관련 참조 항목

status ( session_id ) : integer

매개변수

session_id :

integer

상태를 가져오려는 세션의 ID입니다.

반환하는 항목

integer

세션의 현재 상태입니다. SessionStatus 상수 중 하나일 수 있습니다.

기타 관련 참조 항목

SessionStatus

세션의 현재 상태를 설명합니다.

stingray.MultiplayerSession.status() 호출을 통해 반환될 수 있습니다.

BROKEN : integer

비동기 작업 중 발생한 오류입니다.

READY : integer

세션이 유휴 상태이며, 상호 작용할 수 있습니다.

기타 관련 참조 항목

stingray.Network.set_activity()

SHUTDOWN : integer

세션이 비동기 종료 작업을 완료했으며, 점유 해제를 대기 중입니다.

기타 관련 참조 항목

stingray.MultiplayerSession.leave()
stingray.Network.free_multiplayer_session()

WORKING : integer

세션이 비동기 작업의 완료를 대기 중입니다.

MultiplayerSession - stingray.MultiplayerSession 네임스페이스 참조 - Stingray Lua API 참조

설명

함수

custom_property_json ( session_id, custom_property_key ) : integer

custom_property_json_result ( session_lookup_id ) : string

custom_property_json_status ( session_lookup_id ) : integer

delete_smartmatch_ticket ( session_id, hopper_name, ticket_id )

free_custom_property_json ( session_lookup_id )

group_id ( session_id ) : integer

has_session_changed ( session_id ) : boolean

host_peer ( session_id ) : string?

keywords ( session_id ) : string[]

leave ( session_id )

members ( session_id ) : session_member[]

session_id_to_uri ( session_id ) : string

session_uri_to_description ( session_uri ) : string, string

set_closed ( session_id, closed )

set_current_user_member_custom_property_json ( session_id, custom_property_key, custom_property_json )

set_custom_property_json ( session_id, custom_property_key, custom_property_json )

set_keywords ( user_id, session_id, session_keywords )

smartmatch_result ( session_id ) : string, string, number

smartmatch_status ( session_id ) : integer

start_smartmatch ( session_id, hopper_name, timeout, preserve_mode, ticket_attributes_json )

start_smartmatch_result ( session_id ) : string, number

status ( session_id ) : integer

SessionStatus

BROKEN : integer

READY : integer

SHUTDOWN : integer

WORKING : integer