PC SDK native 레퍼런스 — 3.4.x 이전

SDK 버전 3.4.x 기준이에요. 항목 128개를 이름순으로 모은 통합 문서예요.

Contents

Base_AccessTokenRenewed

종류 함수 · 모듈 Base · 버전 3.3.0

Description

Stove에서 사용 가능한 AccessToken이 갱신되는 시점에 새로 발급된 AccessToken을 등록한 콜백 함수에 넘겨줘요.

새로운 AccessToken을 발급받는 함수가 아니에요.

Declaration

void Base_AccessTokenRenewed(OnRenewTokenFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnRenewTokenFinished)(CallbackResult callbackResult, StovePCToken token);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. AccessToken이 갱신될 때마다 반복해서 전달돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::ACCESS_TOKEN_RENEWED 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_AccessTokenRenewed([](CallbackResult callbackResult, StovePCToken token)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* newAccessToken = token.GetAccessToken();
        int32_t expireIn = token.GetExpireIn();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 토큰이 갱신될 때마다 반복해서 호출되는 콜백이에요. 1회성 콜백이 아니에요.
• 매번 최신 토큰이 필요하다면 Base_GetAccessToken으로 그때그때 조회해도 돼요.
• 같은 기능의 구버전 이름은 Base_GetRenewToken이에요. 신규 코드는 이 함수를 사용해요.

See Also

• Base_GetAccessToken
• Base_GetRenewToken

Base_GetAccessToken

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

Stove에서 사용 가능한 AccessToken을 조회해요.

Declaration

Result Base_GetAccessToken(wchar_t* accessToken, uint32_t length);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::GET_ACCESS_TOKEN 값을 얻어요.

아래 코드를 받으면 반드시 게임을 종료해야 해요. 정상 진행이 불가능한 상태예요.

• 19 INVALID_ACCESS_TOKEN — 게임 종료 후 재실행이 필요해요

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

wchar_t accessToken[1024] = { 0 };
Result result = Base_GetAccessToken(accessToken, 1024);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요. accessToken을 사용합니다.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 새로운 AccessToken을 발급받는 함수가 아니라, SDK가 내부적으로 관리하는 현재 유효한 AccessToken을 조회하는 함수예요.
• 조회한 토큰을 게임에서 따로 보관해 두고 다시 쓰지 마세요. SDK 가 토큰을 주기적으로 갱신하므로 보관해 둔 값은 만료될 수 있어요. 토큰이 필요할 때마다 이 함수를 호출해 그때의 유효한 값을 받아 쓰세요.
• 토큰이 갱신되는 시점에 별도로 알림을 받으려면 Base_AccessTokenRenewed를 사용해요.

See Also

• Base_AccessTokenRenewed

Base_GetGds

종류 함수 · 모듈 Base · 버전 3.1.0

Description

GDS의 정보를 반환해요. 로그인한 사용자의 국가 정보를 조회해요.

Declaration

Result Base_GetGds(StovePCGds* gds);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::GET_GDS 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCGds gds;
Result result = Base_GetGds(&gds);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
    const wchar_t* nation = gds.GetNation();
    const wchar_t* timeZone = gds.GetTimeZone();
    bool isDefault = gds.IsDefault();
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• IsDefault()가 true이면 IP로 국가 코드를 판별하지 못해 스토브 기본 국가 코드로 처리되었다는 뜻이에요.
• GetRegulation()은 GDPR 등 규제적용 국가에 해당할 때만 규제명을 반환해요.

See Also

• Base_GetUser
• Base_GetSignin

Base_GetOverImmersion

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

한국 과몰입 방지 대상자에게 게임 플레이 1시간마다 정보를 등록한 콜백 함수에 넘겨줘요.

한국 전용 API예요. Deprecated 될 예정이에요. 아직 폐기되지 않았으나, 신규 코드에서는 Base_OverImmersionNotification을 사용해야 해요.

Declaration

void Base_GetOverImmersion(OnOverImmersionFinished callback);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnOverImmersionFinished)(CallbackResult callbackResult, StovePCOverImmersion overImmersion);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 게임 플레이 1시간마다 반복해서 전달돼요.

Error Codes

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_GetOverImmersion([](CallbackResult callbackResult, StovePCOverImmersion overImmersion)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* warningMessage = overImmersion.GetWarningMessage();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• Deprecated 될 예정인 API예요. 신규 코드에서는 Base_OverImmersionNotification을 사용해야 해요.
• 한국 전용 API예요.

See Also

• Base_OverImmersionNotification

Base_GetRenewToken

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

Stove에서 사용 가능한 AccessToken이 갱신되는 시점에 새로 발급된 AccessToken을 등록한 콜백 함수에 넘겨줘요. 새로운 AccessToken을 발급받는 함수가 아니에요.

Deprecated 될 예정이에요. 아직 폐기되지 않았으나, 신규 코드에서는 Base_AccessTokenRenewed를 사용해야 해요.

Declaration

void Base_GetRenewToken(OnRenewTokenFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnRenewTokenFinished)(CallbackResult callbackResult, StovePCToken token);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. AccessToken이 갱신될 때마다 반복해서 전달돼요.

Error Codes

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_GetRenewToken([](CallbackResult callbackResult, StovePCToken token)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* newAccessToken = token.GetAccessToken();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• Deprecated 될 예정인 API예요. 신규 코드에서는 Base_AccessTokenRenewed를 사용해야 해요.

See Also

• Base_AccessTokenRenewed

Base_GetShutdown

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

셧다운 대상자이면 셧다운 알림을 등록한 콜백 함수에 넘겨줘요.

Deprecated 될 예정이에요. 아직 폐기되지 않았으나, 신규 코드에서는 Base_ShutdownNotification을 사용해야 해요.

Declaration

void Base_GetShutdown(OnShutdownFinished callback);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnShutdownFinished)(CallbackResult callbackResult, StovePCShutdown shutdown);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.

Error Codes

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_GetShutdown([](CallbackResult callbackResult, StovePCShutdown shutdown)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* shutdownMessage = shutdown.GetShutdownMessage();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• Deprecated 될 예정인 API예요. 신규 코드에서는 Base_ShutdownNotification을 사용해야 해요.
• 이 API는 한국 전용이 아니에요. 셧다운 정책이 적용된 계정이면 해외에서도 동작해요.

See Also

• Base_ShutdownNotification

Base_GetSignin

종류 함수 · 모듈 Base · 버전 3.1.0

Description

Signin의 정보를 반환해요. 로그인한 사용자의 서명(가입 · 인증) 정보를 조회해요.

Declaration

Result Base_GetSignin(StovePCSignin* signin);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::GET_SIGNIN 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCSignin signin;
Result result = Base_GetSignin(&signin);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
    bool personVerify = signin.GetPersonVerify();
    const wchar_t* providerCode = signin.GetProviderCode();
    int accountType = signin.GetAccountType();
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• GetProviderCode()는 로그인 시점의 인증 방법 구분 코드예요(SO: 이메일, FB: 페이스북, TW: 트위터, NAVER: 네이버, GP: 구글, APPLE: 애플, SAO: 일회용 번호, QR: QR코드 로그인, RT: PC클라이언트 기반 자동 로그인, LINE: 라인, STEAM: 스팀).
• GetAccountType()은 계정타입코드예요(2: FACEBOOK, 3: TWITTER, 6: 네이버, 9: 구글플러스, 11: Stove PC 회원가입, 12: 애플, 13: 라인, 14: 라인게임즈, 15: 스팀).

See Also

• Base_GetUser
• Base_GetGds

Base_GetTraceHint

종류 함수 · 모듈 Base · 버전 3.0.0.4 · 폐기 예정

Description

폐기(deprecated)된 기능이에요. 신규 인터페이스에서도 제공하지 않아요.

스토브 플랫폼 동선 추적을 위한 일련의 단서를 조회해요.

Declaration

Result Base_GetTraceHint(StovePCTraceHint* traceHint);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::GET_TRACE_HINT 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCTraceHint traceHint;
Result result = Base_GetTraceHint(&traceHint);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
    const wchar_t* sessionId = traceHint.GetSessionId();
    const wchar_t* refSessionId = traceHint.GetRefSessionId();
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• GetSessionId()는 PCSDK가 초기화될 때마다 발급되는 세션 아이디이고, GetRefSessionId()는 레퍼런스(런처 또는 SGA)가 실행될 때마다 발급되는 세션 아이디예요.
• 이 정보는 문제 상황 재현 시 로그 추적 단서로 사용돼요.

See Also

• Base_GetUser

Base_GetUser

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

로그인한 사용자의 정보를 조회해요.

Declaration

Result Base_GetUser(StovePCUser* user);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::GET_USER 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCUser user;
Result result = Base_GetUser(&user);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
    const wchar_t* nickname = user.GetNickname();
    uint64_t gameUserId = user.GetGameUserId();
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• StovePCUser::GetMemberNumber()는 Deprecated 될 예정이에요. GetGameUserId()를 사용해야 해요.
• 로그인한 사용자의 국가 · 시간대 정보는 Base_GetGds, 가입 정보는 Base_GetSignin으로 별도 조회해요.

See Also

• Base_GetGds
• Base_GetSignin

Base_GetVersion

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

SDK의 버전 정보를 조회해요.

Declaration

Result Base_GetVersion(wchar_t* version, uint32_t length);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::GET_VERSION 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

wchar_t version[64] = { 0 };
Result result = Base_GetVersion(version, 64);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요. version을 사용합니다.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 이 함수는 동기 함수이며 콜백을 받지 않아요.

Base_Initialize

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

SDK를 초기화해요.

Declaration

void Base_Initialize(const StovePCInitializeParam* initParam, OnInitializeFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnInitializeFinished)(CallbackResult callbackResult);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::INITIALIZE 값을 얻어요.

아래 코드를 받으면 반드시 게임을 종료해야 해요. 정상 진행이 불가능한 상태예요.

• 84 NEED_STOVE_LAUNCHER — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

StovePCInitializeParam initParam;
initParam.SetEnvironment(L"REAL");
initParam.SetGameID(L"YOUR_GAME_ID");
initParam.SetApplicationKey(L"YOUR_APP_KEY");

Base_Initialize(&initParam, [](CallbackResult callbackResult)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 캐시된 파라미터로 다시 초기화하려면 Base_InitializeEx를 사용해요.
• 종료할 때는 Base_UnInitialize를 호출해요.

See Also

• Base_InitializeEx
• Base_UnInitialize
• Base_RestartAppIfNecessary

Base_InitializeEx

종류 함수 · 모듈 Base · 버전 3.4.1

Description

캐시된 파라미터를 사용하여 SDK를 초기화해요. Base_RestartAppIfNecessary 계열 함수 호출로 캐시된 초기화 파라미터를 재사용해요.

이 함수를 호출하기 전에 Base_RestartAppIfNecessary 계열 함수를 먼저 호출해 파라미터가 캐시되어 있어야 해요.

Declaration

void Base_InitializeEx(OnInitializeFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnInitializeFinished)(CallbackResult callbackResult);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.

Error Codes

아래 코드를 받으면 반드시 게임을 종료해야 해요. 정상 진행이 불가능한 상태예요.

• 84 NEED_STOVE_LAUNCHER — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

Base_InitializeEx([](CallbackResult callbackResult)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• Base_RestartAppIfNecessary 계열 함수가 캐시해 둔 환경 · 게임 ID · 앱 키를 재사용해요. 초기화 파라미터를 다시 만들지 않아도 돼요.

See Also

• Base_Initialize
• Base_RestartAppIfNecessary

Base_OpenExternalUrl

종류 함수 · 모듈 Base · 버전 3.3.4

Description

외부 브라우저를 통해 URL을 열어요. Stove 관련 도메인을 열 때는 SSO 처리를 진행해요(예: Stove 커뮤니티, 고객센터).

Declaration

void Base_OpenExternalUrl(const wchar_t* url, OnOpenExternalUrlFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnOpenExternalUrlFinished)(CallbackResult callbackResult);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::OPEN_EXTERNAL_URL 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

Base_OpenExternalUrl(L"https://www.onstove.com", [](CallbackResult callbackResult)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• Stove 관련 도메인(예: Stove 커뮤니티, 고객센터)을 열 때는 SSO 처리가 함께 진행돼요.

Base_OverImmersionNotification

종류 함수 · 모듈 Base · 버전 3.3.0

Description

한국 과몰입 방지 대상자에게 게임 플레이 1시간마다 정보를 등록한 콜백 함수에 넘겨줘요.

한국 전용 API예요.

Declaration

void Base_OverImmersionNotification(OnOverImmersionFinished callback);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnOverImmersionFinished)(CallbackResult callbackResult, StovePCOverImmersion overImmersion);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 게임 플레이 1시간마다 반복해서 전달돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::OVER_IMMERSION_NOTIFICATION 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_OverImmersionNotification([](CallbackResult callbackResult, StovePCOverImmersion overImmersion)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* warningMessage = overImmersion.GetWarningMessage();
        int32_t elapsedTimeInHours = overImmersion.GetElapsedTimeInHours();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 한국 전용 API예요.
• 게임 플레이 1시간마다 반복해서 호출되는 콜백이에요. 1회성 콜백이 아니에요.
• 같은 기능의 구버전 이름은 Base_GetOverImmersion이에요. 신규 코드는 이 함수를 사용해요.

See Also

• Base_ShutdownNotification
• Base_GetOverImmersion

Base_RestartAppIfNecessary

종류 함수 · 모듈 Base · 버전 3.1.0

Description

PCSDK가 런처를 통해 실행되었는지 확인해요. 런처가 실행되어 있지 않거나 런처를 통해 프로그램이 실행되지 않았다면 스토브 프로토콜 핸들러를 이용해 다시 실행해요.

동기(Synchronous) 방식으로 동작해요. 비동기로 처리하려면 Base_RestartAppIfNecessaryAsync 계열 함수를 사용해요.

Declaration

bool Base_RestartAppIfNecessary(const StovePCInitializeParam* initParam);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::RESTART_APP_IF_NECESSARY 값을 얻어요.

발생 가능한 결과 코드는 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

StovePCInitializeParam initParam;
initParam.SetEnvironment(L"REAL");
initParam.SetGameID(L"YOUR_GAME_ID");
initParam.SetApplicationKey(L"YOUR_APP_KEY");

bool needRestart = Base_RestartAppIfNecessary(&initParam);
if (!needRestart)
{
    // 성공 시 로직을 구현해 주세요. 이어서 Base_Initialize()를 호출합니다.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 이 함수는 동기 함수이며 콜백을 받지 않아요.
• 비동기 버전은 Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx, Base_RestartAppIfNecessaryAsyncEx2가 있어요.

See Also

• Base_Initialize
• Base_RestartAppIfNecessaryAsync

Base_RestartAppIfNecessaryAsync

종류 함수 · 모듈 Base · 버전 3.3.0

Description

PCSDK가 런처를 통해 실행되었는지 확인해요. 런처가 실행되어 있지 않거나 런처를 통해 프로그램이 실행되지 않았다면 스토브 프로토콜 핸들러를 이용해 다시 실행해요.

비동기(Asynchronous) 방식으로 동작해요. waitTimeMillisec은 런처를 통해 실행되었는지 확인을 기다리는 시간이며, 권장값은 60,000(1분)이에요.

Declaration

void Base_RestartAppIfNecessaryAsync(const StovePCInitializeParam* initParam, uint32_t waitTimeMillisec, OnRestartAppIfNecessaryAsyncFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnRestartAppIfNecessaryAsyncFinished)(CallbackResult callbackResult, bool restartAppIfNecessary);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 재실행이 필요한 경우에도 콜백은 전달돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::RESTART_APP_IF_NECESSARY_ASYNC 값을 얻어요.

아래 코드를 받으면 반드시 게임을 종료해야 해요. 정상 진행이 불가능한 상태예요.

• 87 IPC_CONNECT_FAILED — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 88 IPC_AES_KEY_NOT_RECEIVED — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 89 IPC_TIMEOUT — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 253 UNMANAGED_EXCEPTION · 254 MANAGED_EXCEPTION — 재시작 여부를 판단할 수 없는 상태이므로 게임을 종료해야 해요

스토브 PC클라이언트를 실행하지 않고 게임 실행 파일을 직접 실행하면 이 코드가 발생해요. 게임을 종료하면 스토브 런처가 자동으로 실행돼요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

StovePCInitializeParam initParam;
initParam.SetEnvironment(L"REAL");
initParam.SetGameID(L"YOUR_GAME_ID");
initParam.SetApplicationKey(L"YOUR_APP_KEY");

Base_RestartAppIfNecessaryAsync(&initParam, 60000, [](CallbackResult callbackResult, bool restartAppIfNecessary)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요. restartAppIfNecessary가 false이면 이어서 Base_Initialize()를 호출합니다.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 대기 시간과 런처 실행 여부를 함께 지정하려면 Base_RestartAppIfNecessaryAsyncEx를 사용해요.

See Also

• Base_RestartAppIfNecessary
• Base_RestartAppIfNecessaryAsyncEx
• Base_Initialize

Base_RestartAppIfNecessaryAsyncEx

종류 함수 · 모듈 Base · 버전 3.4.0

Description

PCSDK가 런처를 통해 실행되었는지 확인해요. 런처가 실행되어 있지 않거나 런처를 통해 프로그램이 실행되지 않았다면 스토브 프로토콜 핸들러를 이용해 다시 실행해요.

Base_RestartAppIfNecessaryAsync와 동작은 같지만, launchLauncher 인자로 런처가 실행되어 있지 않을 때 런처를 실행할지 여부를 지정할 수 있어요.

Declaration

void Base_RestartAppIfNecessaryAsyncEx(const StovePCInitializeParam* initParam, uint32_t waitTimeMillisec, bool launchLauncher, OnRestartAppIfNecessaryAsyncFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnRestartAppIfNecessaryAsyncFinished)(CallbackResult callbackResult, bool restartAppIfNecessary);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 재실행이 필요한 경우에도 콜백은 전달돼요.

Error Codes

아래 코드를 받으면 반드시 게임을 종료해야 해요. 정상 진행이 불가능한 상태예요.

• 87 IPC_CONNECT_FAILED — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 88 IPC_AES_KEY_NOT_RECEIVED — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 89 IPC_TIMEOUT — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 253 UNMANAGED_EXCEPTION · 254 MANAGED_EXCEPTION — 재시작 여부를 판단할 수 없는 상태이므로 게임을 종료해야 해요

스토브 PC클라이언트를 실행하지 않고 게임 실행 파일을 직접 실행하면 이 코드가 발생해요. 게임을 종료하면 스토브 런처가 자동으로 실행돼요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

StovePCInitializeParam initParam;
initParam.SetEnvironment(L"REAL");
initParam.SetGameID(L"YOUR_GAME_ID");
initParam.SetApplicationKey(L"YOUR_APP_KEY");

Base_RestartAppIfNecessaryAsyncEx(&initParam, 60000, true, [](CallbackResult callbackResult, bool restartAppIfNecessary)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요. restartAppIfNecessary가 false이면 이어서 Base_Initialize()를 호출합니다.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• Base_RestartAppIfNecessaryAsync와 달리 launchLauncher 인자로 런처 자동 실행 여부를 제어할 수 있어요.
• waitTimeMillisec과 launchLauncher를 구조체 하나에 담아 전달하려면 Base_RestartAppIfNecessaryAsyncEx2를 사용해요.

See Also

• Base_RestartAppIfNecessaryAsync
• Base_RestartAppIfNecessaryAsyncEx2

Base_RestartAppIfNecessaryAsyncEx2

종류 함수 · 모듈 Base · 버전 3.4.1

Description

스팀 연동 여부와 관계없이 사용할 수 있어요. platformName 만 스토브 외 플랫폼(Steam 등)과 함께 연동할 때 채우는 선택 필드이며, 스토브 단독 연동이라면 값을 설정하지 않거나 빈 문자열(L"")로 두면 Base_RestartAppIfNecessaryAsyncEx 와 동일하게 동작해요.

PCSDK가 런처를 통해 실행되었는지 확인해요. 런처가 실행되어 있지 않거나 런처를 통해 프로그램이 실행되지 않았다면 스토브 프로토콜 핸들러를 이용해 다시 실행해요.

Base_RestartAppIfNecessaryAsyncEx와 동작은 같지만, waitTimeMillisec과 launchLauncher 옵션이 StovePCInitializeParamEx2 구조체 안에 포함되어 있어요.

Declaration

void Base_RestartAppIfNecessaryAsyncEx2(const StovePCInitializeParamEx2* initParam, OnRestartAppIfNecessaryAsyncFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnRestartAppIfNecessaryAsyncFinished)(CallbackResult callbackResult, bool restartAppIfNecessary);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 재실행이 필요한 경우에도 콜백은 전달돼요.

Error Codes

아래 코드를 받으면 반드시 게임을 종료해야 해요. 정상 진행이 불가능한 상태예요.

• 87 IPC_CONNECT_FAILED — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 88 IPC_AES_KEY_NOT_RECEIVED — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 89 IPC_TIMEOUT — 스토브 PC 클라이언트를 통해 게임을 다시 실행해야 해요
• 253 UNMANAGED_EXCEPTION · 254 MANAGED_EXCEPTION — 재시작 여부를 판단할 수 없는 상태이므로 게임을 종료해야 해요

스토브 PC클라이언트를 실행하지 않고 게임 실행 파일을 직접 실행하면 이 코드가 발생해요. 게임을 종료하면 스토브 런처가 자동으로 실행돼요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

StovePCInitializeParamEx2 initParam;
initParam.SetEnvironment(L"REAL");
initParam.SetGameID(L"YOUR_GAME_ID");
initParam.SetApplicationKey(L"YOUR_APP_KEY");
initParam.SetWaitTimeMillisec(60000);
initParam.SetLaunchLauncher(true);
initParam.SetPlatformName(L"Stove");

Base_RestartAppIfNecessaryAsyncEx2(&initParam, [](CallbackResult callbackResult, bool restartAppIfNecessary)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요. restartAppIfNecessary가 false이면 이어서 Base_Initialize()를 호출합니다.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• waitTimeMillisec, launchLauncher, platformName을 StovePCInitializeParamEx2 구조체 하나로 전달하는 방식이에요.
• StovePCInitializeParamEx2는 3.4.1에 추가된 구조체예요.

See Also

• Base_RestartAppIfNecessaryAsyncEx

Base_RunCallback

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

각각의 SDK 모듈에서 등록한 콜백 함수를 실행해요. 등록된 콜백을 전부 실행해요.

게임 루프에서 호출해야 해요. while(true) 형태로 이 함수만 반복 호출하는 방식으로 사용하지 않아요.

Declaration

void Base_RunCallback();

Parameters

없음

Returns

없음

Error Codes

없음

Example

using namespace Stove::PCSDK::Base;

// 게임 루프 예시
while (isGameRunning)
{
    // ... 게임 로직 ...

    Base_RunCallback();

    // ... 렌더링 등 나머지 루프 로직 ...
}

Notes

• 모든 비동기 API의 콜백은 이 함수를 호출한 스레드에서 실행돼요. SDK 내부 스레드가 아니에요.
• 대기 시간을 지정하려면 Base_RunCallbackWithTimeout을 사용해요.

See Also

• Base_RunCallbackWithTimeout

Base_RunCallbackWithTimeout

종류 함수 · 모듈 Base · 버전 3.3.0

Description

각각의 SDK 모듈에서 등록한 콜백 함수를 실행해요. 등록된 콜백을 실행할 때 시간을 계산하여 timeoutMillisec을 초과하면 실행을 중지해요. 다음에 호출될 때 이어서 실행해요.

Declaration

void Base_RunCallbackWithTimeout(uint32_t timeoutMillisec);

Parameters

Returns

없음

Error Codes

없음

Example

using namespace Stove::PCSDK::Base;

// 게임 루프 예시 (최대 10ms 대기)
while (isGameRunning)
{
    // ... 게임 로직 ...

    Base_RunCallbackWithTimeout(10);

    // ... 렌더링 등 나머지 루프 로직 ...
}

Notes

• timeoutMillisec을 초과하면 남은 콜백은 다음 호출 때 이어서 실행돼요.
• 일반적인 사용에는 Base_RunCallback을 사용하고, 대기 시간 제어가 필요할 때 이 함수를 사용해요.

See Also

• Base_RunCallback

Base_SetGameProfile

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

게임 프로필을 설정해요.

Declaration

Result Base_SetGameProfile(const StovePCGameProfile* gameProfile);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::SET_GAME_PROFILE 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

StovePCGameProfile gameProfile(L"world_01", 12345);

Result result = Base_SetGameProfile(&gameProfile);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• StovePCGameProfile은 worldId, characterNumber를 생성자로 바로 지정하거나 SetWorldId() / SetCharacterNumber()로 설정할 수 있어요.

Base_SetLanguage

종류 함수 · 모듈 Base · 버전 3.1.0

Description

SDK의 언어 정보를 설정해요. 지원하는 언어는 StoveLanguage 열거값(system, en, ko, ja, zh_cn, zh_tw, de, fr, es, pt, th, vi)으로 지정해요.

문자열로 언어를 지정하려면 Base_SetLanguageEx를 사용해요.

새로 연동하는 경우에는 Base_SetLanguageEx를 사용하세요. 열거형에 없는 언어까지 문자열로 지정할 수 있어 이후 언어가 추가되어도 그대로 쓸 수 있어요.

Declaration

Result Base_SetLanguage(StoveLanguage language);

Parameters

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::SET_LANGUAGE 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

Result result = Base_SetLanguage(StoveLanguage::ko);
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• StoveLanguage에 없는 언어를 지정해야 한다면 문자열 기반의 Base_SetLanguageEx를 사용해요.

See Also

• Base_SetLanguageEx

Base_SetLanguageEx

종류 함수 · 모듈 Base · 버전 3.4.0

Description

PCSDK의 언어 정보를 설정해요. Base_SetLanguage와 달리 문자열로 언어를 지정해요.

Declaration

Result Base_SetLanguageEx(const wchar_t* language);

Parameters

Returns

Error Codes

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

Result result = Base_SetLanguageEx(L"ko");
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• StoveLanguage 열거값에 없는 언어 코드를 지정할 수 있다는 점이 Base_SetLanguage와의 차이예요.

See Also

• Base_SetLanguage

Base_ShutdownNotification

종류 함수 · 모듈 Base · 버전 3.3.0

Description

셧다운 대상자이면 셧다운 알림을 등록한 콜백 함수에 넘겨줘요.

이 API는 한국 전용이 아니에요. 셧다운 정책이 적용된 계정이라면 해외 사용자에게도 동작해요.

Declaration

void Base_ShutdownNotification(OnShutdownFinished callback);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnShutdownFinished)(CallbackResult callbackResult, StovePCShutdown shutdown);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::SHUTDOWN_NOTIFICATION 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_ShutdownNotification([](CallbackResult callbackResult, StovePCShutdown shutdown)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* shutdownMessage = shutdown.GetShutdownMessage();
        int32_t inadvanceTimeInMinutes = shutdown.GetInadvanceTimeInMinutes();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 한국 전용 API가 아니에요. 셧다운 정책이 적용된 계정이면 해외에서도 동작해요.
• 같은 기능의 구버전 이름은 Base_GetShutdown이에요. 신규 코드는 이 함수를 사용해요.

See Also

• Base_OverImmersionNotification
• Base_GetShutdown

Base_UnInitialize

종류 함수 · 모듈 Base · 버전 3.0.0.4

Description

SDK의 자원을 해제해요. Base_Initialize / Base_InitializeEx와 짝을 이루는 함수예요.

게임을 종료하기 전에 반드시 호출해야 해요. 게임 이용 시간을 집계해 서버에 반영하는 처리가 이 함수에서 이루어지므로, 호출하지 않고 프로세스를 내리면 해당 플레이 구간의 이용 시간이 누락돼요.

Declaration

Result Base_UnInitialize();

Parameters

없음

Returns

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::UNINITIALIZE 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::Base;

Result result = Base_UnInitialize();
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• Base_Initialize() / Base_InitializeEx()와 짝을 이루는 종료 함수예요.
• 게임 종료 경로가 여러 개라면(정상 종료 · 예외 종료 · 강제 종료 처리) 모든 경로에서 이 함수를 거치도록 두세요. 이용 시간 집계가 이 시점에 정리돼요.

See Also

• Base_Initialize

Base_VietnamAgeRatingNotification

종류 함수 · 모듈 Base · 버전 3.4.1

Description

베트남 연령 등급 안내 오버레이 정보를 등록한 콜백 함수에 넘겨줘요.

베트남 전용 API예요. 타이머 없이 런처의 SHOW/HIDE 패킷으로만 동작해요. 1회성 콜백이며, 렌더링이 가능한 시점 이후에 호출해야 해요.

Declaration

void Base_VietnamAgeRatingNotification(OnVietnamAgeRatingFinished callback);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnVietnamAgeRatingFinished)(CallbackResult callbackResult, StovePCVietnamAgeRatingInfo vietnamAgeRatingInfo);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 1회성 콜백이며, 렌더링이 가능한 시점 이후에 호출해야 해요. 타이머 없이 런처의 SHOW/HIDE 패킷으로만 동작해요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::VIETNAM_AGE_RATING_NOTIFICATION 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_VietnamAgeRatingNotification([](CallbackResult callbackResult, StovePCVietnamAgeRatingInfo vietnamAgeRatingInfo)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        StoveOverlayState overlayState = vietnamAgeRatingInfo.GetOverlayState();
        const wchar_t* message = vietnamAgeRatingInfo.GetAgeRatingMessage();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 베트남 전용 API예요.
• 1회성 콜백이에요. 렌더링이 가능한 시점 이후에 호출해야 해요.

See Also

• Base_VietnamOverimmersionNotification

Base_VietnamOverimmersionNotification

종류 함수 · 모듈 Base · 버전 3.4.1

Description

베트남 과몰입 방지 대상자에게 게임 플레이 중 정기적으로 정보를 등록한 콜백 함수에 넘겨줘요.

베트남 전용 API예요.

Declaration

void Base_VietnamOverimmersionNotification(OnVietnamOverimmersionFinished callback);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnVietnamOverimmersionFinished)(CallbackResult callbackResult, StovePCVietnamOverimmersionInfo vietnamOverimmersionInfo);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 게임 플레이 중 정기적으로 반복해서 전달돼요.

Error Codes

Result::GetMethodCode()로 조회하면 Stove::PCSDK::Base::SDKMethod::VIETNAM_OVER_IMMERSION_NOTIFICATION 값을 얻어요.

전체 목록은 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_VietnamOverimmersionNotification([](CallbackResult callbackResult, StovePCVietnamOverimmersionInfo vietnamOverimmersionInfo)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        const wchar_t* message = vietnamOverimmersionInfo.GetOverimmersionMessage();
        int32_t elapsedTime = vietnamOverimmersionInfo.GetElapsedTime();
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
});

Notes

• 베트남 전용 API예요.
• 게임 플레이 중 정기적으로 반복해서 호출되는 콜백이에요. 1회성 콜백이 아니에요.

See Also

• Base_VietnamAgeRatingNotification

CallbackResult

종류 구조체 · 모듈 Base · 버전 3.0.0.4

Description

비동기 API 의 콜백 함수 첫 번째 인자로 전달되는 결과 구조체예요. 내부에 Result 를 포함하고, 에러 발생 이유에 대한 상세 메세지와 외부에서 발생한 에러 값, 호출자에 대한 식별자를 함께 담아요.

CallbackResult 는 Result 와 마찬가지로 Stove::PCSDK 네임스페이스에 정의된 공통 타입이에요. Stove::PCSDK::Base 전용이 아니며, 결제 · 팝업 등 다른 모든 기능의 비동기 콜백도 동일한 CallbackResult 타입을 사용해요. 값 타입이며 콜백 함수 인자로 값으로 전달돼요. 별도의 해제 호출은 필요하지 않지만, 콜백이 반환되면 내부 버퍼(errorMessage 등)는 함께 소멸해요.

Declaration

namespace Stove
{
    namespace PCSDK
    {
        struct CallbackResult
        {
        public:
            Result GetResult() const;
            const wchar_t* GetErrorMessage() const;
            int32_t GetExternalError() const;

        public:
            Result result;
            wchar_t* errorMessage = nullptr;
            int32_t externalError;
            uint64_t callerIdentifier;
        };
    }
}

Members

Example

using namespace Stove::PCSDK;
using namespace Stove::PCSDK::Base;

void __cdecl OnInitializeFinishedCallback(CallbackResult callbackResult)
{
    if (callbackResult.result.IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• Base_Initialize(), Base_RestartAppIfNecessaryAsync() 등 콜백 기반 비동기 API 의 첫 번째 콜백 인자로 전달돼요.
• 콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.
• callerIdentifier 는 호출자를 구분하기 위한 식별자예요.

See Also

• Result

CloseButtonType

종류 열거형 · 모듈 View · 버전 3.0.0.4

Description

팝업 닫기 버튼의 유형을 식별하는 열거형이에요. Stove::PCSDK::View::CloseButtonType예요.

이 열거형은 헤더에 공개되어 있으나, 이 문서가 다루는 구 C++ 인터페이스의 다른 공개 함수·구조체(ViewSDK.h, ViewSDKStructures.h) 시그니처에서는 직접 참조되지 않아요.

Declaration

enum class CloseButtonType : uint32_t
{
    CUSTOM = 0,
    PRESET_01 = 1,
    PRESET_02 = 2,
    PRESET_03 = 3,
    PRESET_04 = 4,
    PRESET_05 = 5,
    PRESET_06 = 6,
    DEFAULT = 7,
};

Enum Values

Example

using namespace Stove::PCSDK::View;

CloseButtonType type = CloseButtonType::DEFAULT;

Notes

• 이 열거형을 매개변수나 반환값으로 받는 공개 함수·구조체는 ViewSDK.h, ViewSDKStructures.h 범위에서 확인되지 않아요.
• SDK 내부에는 사용하는 곳이 있어요. 쿠폰 팝업/고객센터 팝업을 구성할 때 팝업 닫기 버튼 옵션의 기본값(PRESET_01)으로 내부적으로 고정 설정돼요. 다만 이 값을 게임이 직접 조회하거나 지정할 수 있는 공개 API는 없어요.

See Also

• StovePCPopupDisallowed

DiscountType

종류 열거형 · 모듈 IAP · 버전 3.0.0.4

Description

상품의 할인 방식을 나타내요. IAP_FetchProducts / IAP_FetchProductsEx 콜백으로 전달되는 StovePCProduct / StovePCProductEx 의 GetDiscountType() 으로 확인할 수 있어요. IsDiscount() 가 true 인 경우에만 유효해요.

Declaration

enum class DiscountType : uint32_t
{
    NONE = 0,
    FIXED_RATE = 1,
    FLAT_RATE = 2,
};

Enum Values

Example

using namespace Stove::PCSDK::IAP;

if (product.IsDiscount() && product.GetDiscountType() == DiscountType::FIXED_RATE)
{
    int32_t discountValue = product.GetDiscountTypeValue();
}

Notes

• 할인 값의 실제 의미(정률의 %, 정액의 화폐 단위)는 GetDiscountTypeValue() 와 함께 확인해야 해요.

See Also

• IAP_FetchProducts
• IAP_FetchProductsEx

IAP_CloseAllPopups

종류 함수 · 모듈 IAP · 버전 3.1.3

Description

결제 기능을 통해 열린 모든 팝업을 닫아요.

Declaration

Result IAP_CloseAllPopups();

Parameters

없음

Returns

Error Codes

그 외 발생 가능한 결과 코드는 SDKResultCode 를 참조하세요.

Example

using namespace Stove::PCSDK::IAP;

Result result = IAP_CloseAllPopups();
if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 이 함수는 동기 함수이며 콜백을 받지 않아요.
• 결제 기능이 띄운 팝업(구매, 약관 동의, 1회성 결제, 게임 탈퇴 등)만 대상이에요. 팝업 기능으로 띄운 팝업은 대상이 아니에요.

See Also

• IAP_StartPurchase
• IAP_WithdrawGame

IAP_ConfirmPurchase

종류 함수 · 모듈 IAP · 버전 3.0.0.4

Description

상품구매 완료 후 구매 ID(주문 마스터 번호)로 정상 처리되었는지 확인해요. IAP_StartPurchase 의 StovePCPurchaseOperation 이 DEFAULT 또는 WITH_WEBVIEW 인 경우 결제 완료 후 이 함수를 호출해 구매를 확정해요. transactionMasterNumber 에는 IAP_StartPurchase 결과로 받은 StovePCPurchaseResult::GetTransactionMasterNumber() 값을 전달해요.

Declaration

void IAP_ConfirmPurchase(int64_t transactionMasterNumber, OnConfirmPurchaseFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnConfirmPurchaseFinished)(CallbackResult callbackResult, bool status, StovePCPurchasedProduct* purchasedProducts, uint32_t purchasedProductSize, StovePCChargeInfo* chargeInfos, uint32_t chargeInfoSize);

Base_RunCallback() 을 호출한 스레드에서 실행돼요. 호출 1건당 1회만 전달돼요.

Error Codes

그 외 발생 가능한 결과 코드는 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::IAP;

void __cdecl OnConfirmPurchaseFinished(CallbackResult callbackResult, bool status,
    StovePCPurchasedProduct* purchasedProducts, uint32_t purchasedProductSize,
    StovePCChargeInfo* chargeInfos, uint32_t chargeInfoSize)
{
    if (callbackResult.GetResult().IsSuccessful() && status)
    {
        // 성공 시 로직을 구현해 주세요.
        for (uint32_t i = 0; i < purchasedProductSize; ++i)
        {
            int64_t productId = purchasedProducts[i].GetProductId();
        }
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

// 호출 (transactionMasterNumber 는 IAP_StartPurchase() 결과의 GetTransactionMasterNumber() 값)
IAP_ConfirmPurchase(transactionMasterNumber, OnConfirmPurchaseFinished);

Notes

• 이 함수는 비동기 함수이며 결과는 onFinished 콜백으로만 전달돼요.
• IAP_StartPurchase 의 StovePCPurchaseOperation 이 WITH_WEBVIEW_AND_CONFIRM_RESULT 인 경우에는 SDK가 이 함수를 자동으로 호출하므로 별도로 호출할 필요가 없어요.
• status 와 callbackResult 의 성공 여부는 별개예요. 호출 자체가 성공했더라도 status 가 false 이면 구매가 최종 확정되지 않은 상태예요.

See Also

• IAP_StartPurchase

IAP_FetchInventory

종류 함수 · 모듈 IAP · 버전 3.0.0.4

Description

전체 구매한 상품목록을 조회해요. 조회 결과는 onFinished 콜백으로 전달돼요.

IAP_Initialize() 로 초기화한 뒤 호출해야 해요.

Declaration

void IAP_FetchInventory(OnFetchInventoryFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnFetchInventoryFinished)(CallbackResult callbackResult, StovePCInventoryItem* inventoryItems, uint32_t inventoryItemSize);

Base_RunCallback() 을 호출한 스레드에서 실행돼요. 호출 1건당 1회만 전달돼요.

Error Codes

그 외 발생 가능한 결과 코드는 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::IAP;

void __cdecl OnFetchInventoryFinished(CallbackResult callbackResult, StovePCInventoryItem* inventoryItems, uint32_t inventoryItemSize)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

// 호출
IAP_FetchInventory(OnFetchInventoryFinished);

Notes

• 이 함수는 비동기 함수이며 결과는 onFinished 콜백으로만 전달돼요.

See Also

• IAP_FetchProducts
• IAP_ConfirmPurchase

IAP_FetchProducts

종류 함수 · 모듈 IAP · 버전 3.0.0.4 · 폐기 예정

Description

이 기본형은 사용하지 않아요. 대신 IAP_FetchProductsEx 를 사용하세요.

스토브 플랫폼에 등록된 상품 정보를 조회해요. params 로 카테고리 · 페이지 번호 · 페이지 크기를 지정할 수 있어요.

IAP_Initialize() 로 초기화한 뒤 호출해야 해요.

Declaration

void IAP_FetchProducts(const StovePCFetchProductParam* params, OnFetchProductsFinished onFinished);

Parameters

Returns

없음

Callback

typedef void(__cdecl* OnFetchProductsFinished)(CallbackResult callbackResult, StovePCProduct* products, uint32_t productSize);

Base_RunCallback() 을 호출한 스레드에서 실행돼요. 호출 1건당 1회만 전달돼요.

Error Codes

그 외 발생 가능한 결과 코드는 SDKResultCode 를 참조하세요.

Memory Management

Example

using namespace Stove::PCSDK::IAP;

void __cdecl OnFetchProductsFinished(CallbackResult callbackResult, StovePCProduct* products, uint32_t productSize)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
        for (uint32_t i = 0; i < productSize; ++i)
        {
            int64_t productId = products[i].GetProductId();
        }
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

// 호출
StovePCFetchProductParam params;
params.SetPageNumber(1);
params.SetPageSize(20);

IAP_FetchProducts(&params, OnFetchProductsFinished);

Notes

• 이 함수는 비동기 함수이며 결과는 onFinished 콜백으로만 전달돼요.
• params 의 카테고리 ID를 비워 두면 전체 상품 목록을 조회해요. 페이지 번호를 전달하지 않으면 1, 페이지 크기를 전달하지 않으면 20이 기본값으로 사용돼요.
• 실제 연동에는 항상 IAP_FetchProductsEx 를 사용하세요. 구매 가능 코드(purchase_availability_code)도 Ex 변형에서만 받을 수 있어요.

See Also

• IAP_FetchProductsEx
• IAP_FetchShopCategories
• IAP_StartPurchase

IAP_FetchProductsEx

종류 함수 · 모듈 IAP · 버전 3.4.1

Description

스토브 플랫폼에 등록된 상품 정보를 조회해요. params 로 카테고리 · 페이지 번호 · 페이지 크기를 지정할 수 있어요.

IAP_FetchProducts() 와의 차이는 콜백으로 전달되는 상품 정보가 StovePCProduct 대신 StovePCProductEx 라는 점이에요. StovePCProductEx 는 StovePCProduct 의 모든 필드에 더해 구매 가능 코드(purchase_availability_code)를 추가로 제공해요. 구매 가능 코드가 1이어도, 남은 수량 대비 더 많은 수량으로 구매를 요청하면 구매 불가 응답이 올 수 있어요.

IAP_Initialize() 로 초기화한 뒤 호출해야 해요.

Declaration

void IAP_FetchProductsEx(const StovePCFetchProductParam* params, OnFetchProductsExFinished onFinished);

Parameters