모듈: session
목차
기능
- gameplayStart
- gameplayStop
- getDevice
- getEntryPointAsync
- getEntryPointData
- getLocale
- getOrientation
- getPlatform
- getTrafficSource
- happyTime
- onOrientationChange
- setSessionData
- switchGameAsync
- isAudioEnabled
- onAudioStatusChange
기능
gameplayStart
▸ gameplayStart(): void
게임 플레이 세션의 시작을 추적합니다. (게임 재개 후 포함). 플레이어가 플레이를 시작하거나 재개할 때 호출합니다(메뉴, 로딩 화면, 업적 화면, 게임 일시정지 시 등).
예
Returns
void
gameplayStop
▸ gameplayStop(): void
게임 플레이의 세션 종료, 플레이 일시정지, 화면 전환 등 게임 플레이의 모든 중단을 추적합니다. 게임 중단(메뉴 표시, 레벨 전환, 게임 일시 정지 등)이 있을 때마다 호출하십시오.
예
Returns
void
getDevice
▸ getDevice(): Device
플레이어가 사용 중인 디바이스를 가져옵니다. 이 부분은 디바이스별 코드를 구현할 때 유용합니다..
예
Returns
플레이어가 사용하는 기기.
getEntryPointAsync
▸ getEntryPointAsync(): Promise
<string
>
게임을 시작한 진입점을 반환합니다.
예
Returns
Promise
<string
>
사용자가 게임을 시작한 엔트리 포인트 이름을 해결하는 Promise.
Throws
- NOT_SUPPORTED
- RETHROW_FROM_PLATFORM
getEntryPointData
▸ getEntryPointData(): Record
<string
, unknown
>
게임을 시작한 진입점과 관련된 모든 데이터 객체를 반환한다.
객체의 내용은 개발자가 결정하며, 다른 플랫폼의 엔트리포인트에서 생성할 수 있습니다. 오래된 모바일을 사용하는 클라이언트나 특정 엔트리포인트와 관련된 데이터가 없는 경우 Null을 반환한다.
예
Returns
Record
<string
, unknown
>
엔트리 포인트에 대한 데이터 또는 존재하지 않는 경우 빈 객체를 의미합니다.
getLocale
▸ getLocale(): string
플레이어가 사용하는 로케일을 가져옵니다. 이는 게임 현지화에 도움이 됩니다.
예
Returns
string
BCP47형식의 로케일.
getOrientation
▸ getOrientation(): Orientation
플레이어가 사용하는 기기의 화면 방향을 가져옵니다. 이 정보는 게임이 어떻게 표시될지 결정하는 데 도움이 됩니다.
예
const orientation = Wortal.session.getOrientation();
if (orientation === 'portrait') {
// 세로 모드로 표시합니다.
}
Returns
Orientation
플레이어가 사용하는 기기의 화면 방향.
getPlatform
▸ getPlatform(): Platform
게임을 시작한 플랫폼을 가져옵니다. 예를 들어, 페이스북과 링크에서 서로 다른 소셜 공유 자산을 표시하고 싶을 때 등 플랫폼별 코드를 구현하는 데 유용합니다.
예
Returns
Platform
게임을 시작한 플랫폼.
getTrafficSource
▸ getTrafficSource(): TrafficSource
게임 트래픽 소스를 가져옵니다. 이를 통해 플레이어가 어디서 동영상을 찾았는지, 유입 경로를 파악할 수 있습니다. 예를 들어, 특정 캠페인에서 플레이어가 어디서 유입되었는지 확인하고 싶을 때 유용하게 사용할 수 있습니다.
예
const source = Wortal.session.getTrafficSource();
console.log(source['r_entrypoint']);
console.log(source['utm_source']);
Returns
TrafficSource
게임에 부여하는 URL 파라미터.
happyTime
▸ happyTime(): void
happyTimeAsync 메소드는 플레이어가 보스를 물리치거나 높은 점수를 획득하는 등 다양한 목표를 달성했을 때 사용할 수 있습니다. 이를 통해 웹사이트에 축하 분위기를 연출할 수 있습니다(예를 들어, 색종이를 뿌려주는 등). 단, 레벨 클리어나 아이템 획득 시에는 이 메소드를 호출할 필요가 없습니다.
예
Returns
void
onOrientationChange
▸ onOrientationChange(callback
): void
기기의 화면 방향이 전환될 때 호출되는 콜백을 지정합니다.
예
Wortal.session.onOrientationChange(orientation => {
if (orientation === 'portrait') {
// 세로 모드로 표시합니다
}
});
매개변수
이름 | 유형 | 설명 |
---|---|---|
callback |
(orientation: Orientation) => void |
기기의 화면 방향이 바뀌었을 때 호출되는 콜백 |
Returns
void
setSessionData
▸ setSessionData(data
): void
현재 컨텍스트의 개별 게임 플레이 세션과 관련된 데이터를 설정합니다.
게임이 현재 세션 데이터를 업데이트하고 싶을 때 호출할 수 있습니다. 세션 데이터는 게임플레이 웹훅 등 다양한 페이로드를 전송하는 데 사용할 수 있습니다.
예
매개변수
이름 | 유형 | 설명 |
---|---|---|
data |
Record <string , unknown > |
임의의 데이터 객체에서 문자열은 1000자 이하이어야 한다. |
Returns
void
switchGameAsync
▸ switchGameAsync(gameID
, data?
): Promise
<void
>
게임을 다른 게임으로 전환하기 위한 요청입니다. 전환에 실패하면 API는 거부합니다. 성공하면 플레이어는 새로운 게임을 로드합니다.
예
매개변수
이름 | 유형 | 설명 |
---|---|---|
gameID |
string |
게임 ID를 전환할 수 있는 것은 Wortal 게임만 가능합니다. game. |
data? |
object |
임의의 페이로드 데이터. 이 데이터는 전환할 게임의 진입점 데이터로 설정됩니다. 최대 문자 수는 1000자 이내여야 합니다. |
Returns
Promise
<void
>
게임이 전환될 때 해결되는 Promise, 게임이 전환되지 않으면 Promise는 거부됩니다.
Throws
- INVALID_PARAMS
- USER_INPUT
- PENDING_REQUEST
- CLIENT_REQUIRES_UPDATE
- NOT_SUPPORTED
isAudioEnabled
▸ isAudioEnabled(): boolean
플레이어의 오디오가 활성화되어 있는지 여부를 반환합니다.
예시
Returns
boolean
오디오가 활성화되어 있으면 true , 비활성화되어 있으면 false .
onAudioStatusChange
▸ onAudioStatusChange(callback
): void
플레이어의 오디오 상태가 변경될 때 호출되는 콜백을 설정합니다.
예
// 오디오 상태 변화를 감지하여 게임 오디오를 조정합니다
Wortal.session.onAudioStatusChange(isAudioEnabled => {
// 예시:
if (isAudioEnabled) {
GameAudioManager.unmute();
}
else {
GameAudioManager.mute();
}
});
매개변수
이름 | 타입 | 설명 |
---|---|---|
callback |
(isAudioEnabled: boolean) => void |
플레이어의 오디오 상태가 변경될 때 호출되는 콜백. |
Returns
void