PC SDK Native Reference — 3.4.x and Earlier

Based on SDK version 3.4.x. 128 items combined in alphabetical order.

Contents

Base_AccessTokenRenewed

Kind Function · Module Base · Version 3.3.0

Description

When the AccessToken available in Stove is renewed, the newly issued AccessToken is passed to the registered callback function.

This is not a function that issues a new AccessToken.

Declaration

void Base_AccessTokenRenewed(OnRenewTokenFinished onFinished);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). It is passed repeatedly each time the AccessToken is renewed.

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::ACCESS_TOKEN_RENEWED.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_AccessTokenRenewed([](CallbackResult callbackResult, StovePCToken token)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* newAccessToken = token.GetAccessToken();
        int32_t expireIn = token.GetExpireIn();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This is a callback that is called repeatedly every time the token is renewed. It is not a one-time callback.
• If you need the latest token each time, you can look it up as needed using Base_GetAccessToken.
• The name of the older version with the same functionality is Base_GetRenewToken. The new code uses this function.

See Also

• Base_GetAccessToken
• Base_GetRenewToken

Base_GetAccessToken

Kind Function · Module Base · Version 3.0.0.4

Description

Retrieves the AccessToken available in Stove.

Declaration

Result Base_GetAccessToken(wchar_t* accessToken, uint32_t length);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::GET_ACCESS_TOKEN.

If you receive the code below, you must exit the game. The game cannot proceed normally.

• 19 INVALID_ACCESS_TOKEN — You must restart the game after it closes.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

wchar_t accessToken[1024] = { 0 };
Result result = Base_GetAccessToken(accessToken, 1024);
if (result.IsSuccessful())
{
    // Please implement the logic for a successful operation. Use `accessToken`.
}
else
{
    // Please implement the logic for when a failure occurs.
}

Notes

• This function does not issue a new AccessToken; rather, it retrieves the currently valid AccessToken managed internally by the SDK.
• Do not keep the retrieved token in the game and reuse it later. The SDK renews the token periodically, so a stored value can expire. Call this function every time a token is needed and use the value returned at that moment.
• Use Base_AccessTokenRenewed to receive a separate notification when your token is renewed.

See Also

• Base_AccessTokenRenewed

Base_GetGds

Kind Function · Module Base · Version 3.1.0

Description

Returns information from the GDS. Retrieves the logged-in user's country information.

Declaration

Result Base_GetGds(StovePCGds* gds);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::GET_GDS.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCGds gds;
Result result = Base_GetGds(&gds);
if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
    const wchar_t* nation = gds.GetNation();
    const wchar_t* timeZone = gds.GetTimeZone();
    bool isDefault = gds.IsDefault();
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• If IsDefault() is true, it means that the country code could not be determined from the IP address, so it was processed using Stove's default country code.
• GetRegulation() returns the name of the regulation only when the country is subject to regulations such as the GDPR.

See Also

• Base_GetUser
• Base_GetSignin

Base_GetOverImmersion

Kind Function · Module Base · Version 3.0.0.4

Description

For individuals in South Korea subject to gaming addiction prevention measures, the system passes the information to a callback function every hour of gameplay.

This API is for use in Korea only. It is scheduled to be deprecated. Although it has not yet been deprecated, you should use Base_OverImmersionNotification in new code.

Declaration

void Base_GetOverImmersion(OnOverImmersionFinished callback);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). It is passed repeatedly every hour of gameplay.

Error Codes

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_GetOverImmersion([](CallbackResult callbackResult, StovePCOverImmersion overImmersion)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* warningMessage = overImmersion.GetWarningMessage();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This API is scheduled to be deprecated. You should use Base_OverImmersionNotification in new code.
• This API is for use in Korea only.

See Also

• Base_OverImmersionNotification

Base_GetRenewToken

Kind Function · Module Base · Version 3.0.0.4

Description

When the AccessToken available in Stove is renewed, the newly issued AccessToken is passed to the registered callback function. This is not a function that issues a new AccessToken.

This is scheduled to be deprecated. It has not yet been deprecated, but you should use Base_AccessTokenRenewed in new code.

Declaration

void Base_GetRenewToken(OnRenewTokenFinished onFinished);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). It is passed repeatedly each time the AccessToken is renewed.

Error Codes

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_GetRenewToken([](CallbackResult callbackResult, StovePCToken token)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* newAccessToken = token.GetAccessToken();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This API is scheduled to be deprecated. You should use Base_AccessTokenRenewed in new code.

See Also

• Base_AccessTokenRenewed

Base_GetShutdown

Kind Function · Module Base · Version 3.0.0.4

Description

If the user is subject to the shutdown, the shutdown notification is passed to the callback function that was registered for it.

This is scheduled to be deprecated. It has not been deprecated yet, but you should use Base_ShutdownNotification in new code.

Declaration

void Base_GetShutdown(OnShutdownFinished callback);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback().

Error Codes

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_GetShutdown([](CallbackResult callbackResult, StovePCShutdown shutdown)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* shutdownMessage = shutdown.GetShutdownMessage();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This API is scheduled to be deprecated. You should use Base_ShutdownNotification in new code.
• This API is not limited to South Korea. It works even overseas if the account is subject to the shutdown policy.

See Also

• Base_ShutdownNotification

Base_GetSignin

Kind Function · Module Base · Version 3.1.0

Description

Returns Signin information. Retrieves the signed-in user's registration and authentication information.

Declaration

Result Base_GetSignin(StovePCSignin* signin);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you get the value Stove::PCSDK::Base::SDKMethod::GET_SIGNIN.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCSignin signin;
Result result = Base_GetSignin(&signin);
if (result.IsSuccessful())
{
    // Please implement the logic for when the operation is successful.
    bool personVerify = signin.GetPersonVerify();
    const wchar_t* providerCode = signin.GetProviderCode();
    int accountType = signin.GetAccountType();
}
else
{
    // Please implement the logic for when a failure occurs.
}

Notes

• GetProviderCode() is the authentication method classification code at the time of login (SO: Email, FB: Facebook, TW: Twitter, NAVER: Naver, GP: Google, APPLE: Apple, SAO: One-time code, QR: QR code login, RT: Automatic login via PC client, LINE: LINE, STEAM: Steam).
• GetAccountType() is an account type code (2: Facebook, 3: Twitter, 6: Naver, 9: Google+, 11: Stove PC sign-up, 12: Apple, 13: LINE, 14: LINE Games, 15: Steam).

See Also

• Base_GetUser
• Base_GetGds

Base_GetTraceHint

Kind Function · Module Base · Version 3.0.0.4 · Deprecated

Description

This feature is deprecated. It is not available in the new interface either.

Retrieves a series of clues for tracking user navigation on the Stove platform.

Declaration

Result Base_GetTraceHint(StovePCTraceHint* traceHint);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::GET_TRACE_HINT.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCTraceHint traceHint;
Result result = Base_GetTraceHint(&traceHint);
if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
    const wchar_t* sessionId = traceHint.GetSessionId();
    const wchar_t* refSessionId = traceHint.GetRefSessionId();
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• GetSessionId() is a session ID issued each time the PCSDK is initialized, and GetRefSessionId() is a session ID issued each time a reference (launcher or SGA) is executed.
• This information is used as a log trace clue when reproducing the issue.

See Also

• Base_GetUser

Base_GetUser

Kind Function · Module Base · Version 3.0.0.4

Description

Retrieves information about the logged-in user.

Declaration

Result Base_GetUser(StovePCUser* user);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::GET_USER.

For a complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

StovePCUser user;
Result result = Base_GetUser(&user);
if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
    const wchar_t* nickname = user.GetNickname();
    uint64_t gameUserId = user.GetGameUserId();
}
else
{
    // Please implement the logic for when the operation fails.
}

Notes

• StovePCUser::GetMemberNumber() is scheduled to be deprecated. You should use GetGameUserId() instead.
• The logged-in user's country and time zone information is retrieved separately via Base_GetGds, and their registration information via Base_GetSignin.

See Also

• Base_GetGds
• Base_GetSignin

Base_GetVersion

Kind Function · Module Base · Version 3.0.0.4

Description

Retrieves the SDK version information.

Declaration

Result Base_GetVersion(wchar_t* version, uint32_t length);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::GET_VERSION.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

wchar_t version[64] = { 0 };
Result result = Base_GetVersion(version, 64);
if (result.IsSuccessful())
{
    // Please implement the logic for when the operation succeeds. Use the `version` parameter.
}
else
{
    // Please implement the logic for when a failure occurs.
}

Notes

• This function is synchronous and does not accept callbacks.

Base_Initialize

Kind Function · Module Base · Version 3.0.0.4

Description

Initialize the SDK.

Declaration

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

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback().

Error Codes

If you look up Result::GetMethodCode(), you get the value Stove::PCSDK::Base::SDKMethod::INITIALIZE.

If you receive the code below, you must exit the game immediately. The game cannot continue normally.

• 84 NEED_STOVE_LAUNCHER — You must relaunch the game via the Stove PC client

For a complete list, see 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())
    {
        // Please implement the logic for the success case.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• to initialize to the cached parameters, use Base_InitializeEx.
• To exit, call Base_UnInitialize.

See Also

• Base_InitializeEx
• Base_UnInitialize
• Base_RestartAppIfNecessary

Base_InitializeEx

Kind Function · Module Base · Version 3.4.1

Description

Initialize the SDK using cached parameters. Reuse the cached initialization parameters by calling functions in the Base_RestartAppIfNecessary series.

Before calling this function, you must first call a function from the Base_RestartAppIfNecessary series so that the parameters are cached.

Declaration

void Base_InitializeEx(OnInitializeFinished onFinished);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback().

Error Codes

If you receive the code below, you must exit the game. The game cannot proceed normally.

• 84 NEED_STOVE_LAUNCHER — You must restart the game via the Stove PC client

For the complete list, see SDKResultCode.

Example

using namespace Stove::PCSDK::Base;

Base_InitializeEx([](CallbackResult callbackResult)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• The Base_RestartAppIfNecessary series of functions reuses the cached environment, game ID, and app key. You do not need to recreate the initialization parameters.

See Also

• Base_Initialize
• Base_RestartAppIfNecessary

Base_OpenExternalUrl

Kind Function · Module Base · Version 3.3.4

Description

Opens the URL in an external browser. When opening Stove-related domains, SSO is applied (e.g., Stove Community, Customer Support).

Declaration

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

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback().

Error Codes

If you look up Result::GetMethodCode(), you get the value Stove::PCSDK::Base::SDKMethod::OPEN_EXTERNAL_URL.

For a complete list, see SDKResultCode.

Example

using namespace Stove::PCSDK::Base;

Base_OpenExternalUrl(L"https://www.onstove.com", [](CallbackResult callbackResult)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• When you open a Stove-related domain (e.g., the Stove Community or Help Center), SSO is processed simultaneously.

Base_OverImmersionNotification

Kind Function · Module Base · Version 3.3.0

Description

For individuals in South Korea subject to measures to prevent excessive gaming, the system passes the information to a callback function every hour of gameplay.

This API is for use in Korea only.

Declaration

void Base_OverImmersionNotification(OnOverImmersionFinished callback);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). It is passed repeatedly every hour of gameplay.

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::OVER_IMMERSION_NOTIFICATION.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_OverImmersionNotification([](CallbackResult callbackResult, StovePCOverImmersion overImmersion)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* warningMessage = overImmersion.GetWarningMessage();
        int32_t elapsedTimeInHours = overImmersion.GetElapsedTimeInHours();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This API is for use in Korea only.
• This is a callback that is repeatedly called every hour of gameplay. It is not a one-time callback.
• The name of the older version with the same functionality is Base_GetOverImmersion. The new code uses this function.

See Also

• Base_ShutdownNotification
• Base_GetOverImmersion

Base_RestartAppIfNecessary

Kind Function · Module Base · Version 3.1.0

Description

Check whether PCSDK was launched via the launcher. If the launcher is not running or the program was not launched via the launcher, relaunch it using the Stove Protocol handler.

It operates in synchronous mode. To process it asynchronously, use the Base_RestartAppIfNecessaryAsync series of functions.

Declaration

bool Base_RestartAppIfNecessary(const StovePCInitializeParam* initParam);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::RESTART_APP_IF_NECESSARY.

For possible error codes, see 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)
{
    // Please implement the logic for a successful outcome. Then, call Base_Initialize().
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• This function is synchronous and does not accept callbacks.
• The asynchronous versions are Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx, and Base_RestartAppIfNecessaryAsyncEx2.

See Also

• Base_Initialize
• Base_RestartAppIfNecessaryAsync

Base_RestartAppIfNecessaryAsync

Kind Function · Module Base · Version 3.3.0

Description

Check whether PCSDK was launched via the launcher. If the launcher is not running or the program was not launched via the launcher, relaunch it using the Stove Protocol handler.

It operates in asynchronous mode. waitTimeMillisec is the time spent waiting to confirm whether the application was launched via the launcher; the recommended value is 60,000 (1 minute).

Declaration

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

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). The callback is also passed even if a retry is required.

Error Codes

If you look up Result::GetMethodCode(), you will get the value Stove::PCSDK::Base::SDKMethod::RESTART_APP_IF_NECESSARY_ASYNC.

If you receive the code below, you must exit the game immediately. The game cannot proceed normally.

• 87 IPC_CONNECT_FAILED — You must relaunch the game through the Stove PC client
• 88 IPC_AES_KEY_NOT_RECEIVED — You must restart the game via the Stove PC client
• 89 IPC_TIMEOUT — You must restart the game via the Stove PC client
• 253 UNMANAGED_EXCEPTION · 254 MANAGED_EXCEPTION — Since it is impossible to determine whether to restart, the game must be terminated.

This error occurs if you run the game executable directly without launching the Stove PC client. When you exit the game, the Stove launcher will launch automatically.

For the complete list, see 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())
    {
        // Please implement the logic for a successful outcome. If `restartAppIfNecessary` is false, call `Base_Initialize()` next.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• To specify both the wait time and whether to run the launcher, use Base_RestartAppIfNecessaryAsyncEx.

See Also

• Base_RestartAppIfNecessary
• Base_RestartAppIfNecessaryAsyncEx
• Base_Initialize

Base_RestartAppIfNecessaryAsyncEx

Kind Function · Module Base · Version 3.4.0

Description

Check whether PCSDK was launched via the launcher. If the launcher is not running or the program was not launched via the launcher, relaunch it using the Stove Protocol handler.

It works the same as Base_RestartAppIfNecessaryAsync, but the launchLauncher argument allows you to specify whether to launch the launcher if it is not already running.

Declaration

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

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). The callback is passed even if a retry is required.

Error Codes

If you receive the code below, you must exit the game. The game cannot proceed normally.

• 87 IPC_CONNECT_FAILED — You must restart the game via the Stove PC client
• 88 IPC_AES_KEY_NOT_RECEIVED — You must restart the game via the Stove PC client
• 89 IPC_TIMEOUT — You must relaunch the game via the Stove PC client
• 253 UNMANAGED_EXCEPTION · 254 MANAGED_EXCEPTION — Since it is impossible to determine whether to restart, the game must be terminated.

This error occurs if you run the game executable directly without launching the Stove PC client. When you exit the game, the Stove launcher will launch automatically.

For a complete list, see 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())
    {
        // Please implement the logic for a successful outcome. If `restartAppIfNecessary` is false, call `Base_Initialize()` next.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• Unlike Base_RestartAppIfNecessaryAsync, you can use the launchLauncher argument to control whether the launcher runs automatically.
• To pass waitTimeMillisec and launchLauncher as a single structure, use Base_RestartAppIfNecessaryAsyncEx2.

See Also

• Base_RestartAppIfNecessaryAsync
• Base_RestartAppIfNecessaryAsyncEx2

Base_RestartAppIfNecessaryAsyncEx2

Kind Function · Module Base · Version 3.4.1

Description

This feature can be used regardless of whether it is linked to Steam. platformName is an optional field that should only be filled in when linking to platforms other than Stove (such as Steam); if you are linking to Stove alone, leave the value blank or set it to an empty string (L""), and it will function the same as Base_RestartAppIfNecessaryAsyncEx.

Check whether PCSDK was launched via the launcher. If the launcher is not running or the program was not launched via the launcher, relaunch it using the Stove Protocol handler.

It functions the same as Base_RestartAppIfNecessaryAsyncEx, but the waitTimeMillisec and launchLauncher options are included within the StovePCInitializeParamEx2 structure.

Declaration

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

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). The callback is also passed even if a re-execution is required.

Error Codes

If you receive the code below, you must exit the game. The game cannot proceed normally.

• 87 IPC_CONNECT_FAILED — You must restart the game via the Stove PC client
• 88 IPC_AES_KEY_NOT_RECEIVED — You must relaunch the game via the Stove PC client
• 89 IPC_TIMEOUT — You must restart the game via the Stove PC client
• 253 UNMANAGED_EXCEPTION · 254 MANAGED_EXCEPTION — Since it is impossible to determine whether to restart, the game must be terminated.

This error occurs if you run the game executable directly without launching the Stove PC client. When you exit the game, the Stove launcher will launch automatically.

For the complete list, see 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())
    {
        // Please implement the logic for when the operation succeeds. If `restartAppIfNecessary` is false, call `Base_Initialize()` next.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This method passes waitTimeMillisec, launchLauncher, and platformName as a single StovePCInitializeParamEx2 structure.
• StovePCInitializeParamEx2 is a structure added in version 3.4.1.

See Also

• Base_RestartAppIfNecessaryAsyncEx

Base_RunCallback

Kind Function · Module Base · Version 3.0.0.4

Description

Executes the callback functions registered in each SDK module. Executes all registered callbacks.

It must be called within the game loop. Do not use it by repeatedly calling this function alone in the form while(true).

Declaration

void Base_RunCallback();

Parameters

None

Returns

None

Error Codes

None

Example

using namespace Stove::PCSDK::Base;

// Example of a Game Loop
while (isGameRunning)
{
    // ... Game Logic ...

    Base_RunCallback();

    // ... the rest of the loop logic, such as rendering ...
}

Notes

• Callbacks for all asynchronous APIs are executed on the thread that called this function. They are not executed on an internal SDK thread.
• To specify a wait time, use Base_RunCallbackWithTimeout.

See Also

• Base_RunCallbackWithTimeout

Base_RunCallbackWithTimeout

Kind Function · Module Base · Version 3.3.0

Description

Executes the callback functions registered in each SDK module. When executing a registered callback, the system tracks the elapsed time and stops execution if it exceeds timeoutMillisec. Execution resumes the next time the callback is called.

Declaration

void Base_RunCallbackWithTimeout(uint32_t timeoutMillisec);

Parameters

Returns

None

Error Codes

None

Example

using namespace Stove::PCSDK::Base;

// Game Loop Example (Maximum 10 ms Wait)
while (isGameRunning)
{
    // ... Game Logic ...

    Base_RunCallbackWithTimeout(10);

    // ... rendering and the rest of the loop logic ...
}

Notes

• If the count exceeds timeoutMillisec, the remaining callbacks will continue to execute during the next call.
• Use Base_RunCallback for general purposes, and use this function when you need to control the wait time.

See Also

• Base_RunCallback

Base_SetGameProfile

Kind Function · Module Base · Version 3.0.0.4

Description

Set up your game profile.

Declaration

Result Base_SetGameProfile(const StovePCGameProfile* gameProfile);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::SET_GAME_PROFILE.

For the complete list, see SDKResultCode.

Example

using namespace Stove::PCSDK::Base;

StovePCGameProfile gameProfile(L"world_01", 12345);

Result result = Base_SetGameProfile(&gameProfile);
if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• StovePCGameProfile can be set directly to worldId or characterNumber as its constructor, or it can be set to SetWorldId() or SetCharacterNumber().

Base_SetLanguage

Kind Function · Module Base · Version 3.1.0

Description

Configure the SDK's language settings. Supported languages are the StoveLanguage enumeration values (system, en, ko, ja, zh_cn, zh_tw, de, fr, es, pt, th, vi).

To specify a language as a string, use Base_SetLanguageEx.

If you are setting up a new integration, use Base_SetLanguageEx. You can specify even languages not listed in the dropdown as strings, so you can continue using them even if new languages are added later.

Declaration

Result Base_SetLanguage(StoveLanguage language);

Parameters

Returns

Error Codes

If you look up Result::GetMethodCode(), you will get the value Stove::PCSDK::Base::SDKMethod::SET_LANGUAGE.

For the complete list, see SDKResultCode.

Example

using namespace Stove::PCSDK::Base;

Result result = Base_SetLanguage(StoveLanguage::ko);
if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• If you need to specify a language not listed in StoveLanguage, use the string-based Base_SetLanguageEx.

See Also

• Base_SetLanguageEx

Base_SetLanguageEx

Kind Function · Module Base · Version 3.4.0

Description

Configure the language settings for PCSDK. Unlike Base_SetLanguage, the language is specified as a string.

Declaration

Result Base_SetLanguageEx(const wchar_t* language);

Parameters

Returns

Error Codes

For the complete list, see SDKResultCode.

Example

using namespace Stove::PCSDK::Base;

Result result = Base_SetLanguageEx(L"ko");
if (result.IsSuccessful())
{
    // Please implement the logic for the success case.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• The difference from Base_SetLanguage is that you can specify a language code that is not included in the list of values in StoveLanguage.

See Also

• Base_SetLanguage

Base_ShutdownNotification

Kind Function · Module Base · Version 3.3.0

Description

If the user is subject to a shutdown, the shutdown notification is passed to the callback function that was registered for it.

This API is not limited to South Korea. It works for users outside of South Korea as well, provided their accounts are subject to the shutdown policy.

Declaration

void Base_ShutdownNotification(OnShutdownFinished callback);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback().

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::SHUTDOWN_NOTIFICATION.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_ShutdownNotification([](CallbackResult callbackResult, StovePCShutdown shutdown)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* shutdownMessage = shutdown.GetShutdownMessage();
        int32_t inadvanceTimeInMinutes = shutdown.GetInadvanceTimeInMinutes();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This API is not exclusive to South Korea. It works even overseas if your account is subject to the shutdown policy.
• The name of the older version with the same functionality is Base_GetShutdown. The new code uses this function.

See Also

• Base_OverImmersionNotification
• Base_GetShutdown

Base_UnInitialize

Kind Function · Module Base · Version 3.0.0.4

Description

Releases the SDK's resources. This function pairs with Base_Initialize / Base_InitializeEx.

You must call this function before exiting the game. Since this function aggregates the game playtime and updates the server with that data, if you terminate the process without calling it, the playtime for that session will be omitted.

Declaration

Result Base_UnInitialize();

Parameters

None

Returns

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::UNINITIALIZE.

For the complete list, see SDKResultCode.

Example

using namespace Stove::PCSDK::Base;

Result result = Base_UnInitialize();
if (result.IsSuccessful())
{
    // Please implement the logic for when the operation succeeds.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• This is the termination function that pairs with Base_Initialize() / Base_InitializeEx().
• If there are multiple ways for the game to end (normal exit, exception exit, forced exit), ensure that this function is called from all of them. The playtime statistics are finalized at this point.

See Also

• Base_Initialize

Base_VietnamAgeRatingNotification

Kind Function · Module Base · Version 3.4.1

Description

Passes the overlay information for the Vietnam age rating guide to the registered callback function.

This is an API specific to Vietnam. It operates solely using the launcher's SHOW/HIDE packets, without a timer. It is a one-time callback and must be called after rendering is possible.

Declaration

void Base_VietnamAgeRatingNotification(OnVietnamAgeRatingFinished callback);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). It is a one-time callback and must be called after the system is ready for rendering. It operates solely via the launcher's SHOW/HIDE packets, without a timer.

Error Codes

If you look up Result::GetMethodCode(), you'll get the value Stove::PCSDK::Base::SDKMethod::VIETNAM_AGE_RATING_NOTIFICATION.

For a complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_VietnamAgeRatingNotification([](CallbackResult callbackResult, StovePCVietnamAgeRatingInfo vietnamAgeRatingInfo)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        StoveOverlayState overlayState = vietnamAgeRatingInfo.GetOverlayState();
        const wchar_t* message = vietnamAgeRatingInfo.GetAgeRatingMessage();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This is an API specifically for Vietnam.
• This is a one-time callback. It must be called after rendering is complete.

See Also

• Base_VietnamOverimmersionNotification

Base_VietnamOverimmersionNotification

Kind Function · Module Base · Version 3.4.1

Description

For users in Vietnam subject to anti-excessive gaming measures, information is passed to a callback function that registers data periodically while they are playing games.

This is an API specifically for Vietnam.

Declaration

void Base_VietnamOverimmersionNotification(OnVietnamOverimmersionFinished callback);

Parameters

Returns

None

Callback

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

The callback runs in the thread that called Base_RunCallback(). It is passed repeatedly at regular intervals during gameplay.

Error Codes

If you look up Result::GetMethodCode(), you will get the value Stove::PCSDK::Base::SDKMethod::VIETNAM_OVER_IMMERSION_NOTIFICATION.

For the complete list, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::Base;

Base_VietnamOverimmersionNotification([](CallbackResult callbackResult, StovePCVietnamOverimmersionInfo vietnamOverimmersionInfo)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        const wchar_t* message = vietnamOverimmersionInfo.GetOverimmersionMessage();
        int32_t elapsedTime = vietnamOverimmersionInfo.GetElapsedTime();
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
});

Notes

• This is an API specifically for Vietnam.
• This is a callback that is repeatedly invoked at regular intervals during gameplay. It is not a one-time callback.

See Also

• Base_VietnamAgeRatingNotification

CallbackResult

Kind Struct · Module Base · Version 3.0.0.4

Description

This is the result structure passed as the first argument to the callback function of an asynchronous API. It contains Result and includes a detailed message explaining the cause of the error, the error value generated externally, and an identifier for the caller.

CallbackResult is a common type defined in the Stove::PCSDK namespace, just like Result. It is not specific to Stove::PCSDK::Base; asynchronous callbacks for all other features, such as payment and pop-ups, also use the same CallbackResult type. It is a value type and is passed as a value to the callback function. No separate deallocation call is required; however, when the callback returns, any internal buffers (such as errorMessage) are destroyed along with it.

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())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Notes

• It is passed as the first callback argument to callback-based asynchronous APIs such as Base_Initialize() and Base_RestartAppIfNecessaryAsync().
• The callback runs in the thread that called Base_RunCallback().
• callerIdentifier is an identifier used to distinguish the caller.

See Also

• Result

CloseButtonType

Kind Enum · Module View · Version 3.0.0.4

Description

An enumeration that identifies the types of pop-up close buttons. It is Stove::PCSDK::View::CloseButtonType.

Although this enumeration is declared in the header, it is not directly referenced in the signatures of the other public functions and structures (ViewSDK.h, ViewSDKStructures.h) of the legacy C++ interface covered in this document.

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

• No public functions or structures that accept this enumeration as a parameter or return value were found in the ViewSDK.h and ViewSDKStructures.h ranges.
• This value is used internally within the SDK. When configuring coupon pop-ups or customer support pop-ups, it is internally set as the default value (PRESET_01) for the "Close Pop-up" button. However, there is no public API that allows the game to directly retrieve or specify this value.

See Also

• StovePCPopupDisallowed

DiscountType

Kind Enum · Module IAP · Version 3.0.0.4

Description

Indicates the product's discount method. You can verify this by checking the GetDiscountType() value of StovePCProduct / StovePCProductEx, which is passed via the IAP_FetchProducts / IAP_FetchProductsEx callback. This is valid only when IsDiscount() equals 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

• The actual meaning of the discount amount (percentage or fixed monetary unit) should be verified using GetDiscountTypeValue().

See Also

• IAP_FetchProducts
• IAP_FetchProductsEx

IAP_CloseAllPopups

Kind Function · Module IAP · Version 3.1.3

Description

Closes all pop-ups opened through the payment feature.

Declaration

Result IAP_CloseAllPopups();

Parameters

None

Returns

Error Codes

For other possible error codes, see SDKResultCode.

Example

using namespace Stove::PCSDK::IAP;

Result result = IAP_CloseAllPopups();
if (result.IsSuccessful())
{
    // Please implement the logic for when the operation is successful.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• This function is synchronous and does not accept callbacks.
• This applies only to pop-ups triggered by the payment feature (such as purchase, terms of service agreement, one-time payment, and game withdrawal). Pop-ups triggered by the pop-up feature are not included.

See Also

• IAP_StartPurchase
• IAP_WithdrawGame

IAP_ConfirmPurchase

Kind Function · Module IAP · Version 3.0.0.4

Description

After completing a purchase, verify that it was processed correctly using the purchase ID (order master number). If StovePCPurchaseOperation of IAP_StartPurchase is DEFAULT or WITH_WEBVIEW, call this function after payment is complete to confirm the purchase. Pass the StovePCPurchaseResult::GetTransactionMasterNumber() value received as the result of IAP_StartPurchase to transactionMasterNumber.

Declaration

void IAP_ConfirmPurchase(int64_t transactionMasterNumber, OnConfirmPurchaseFinished onFinished);

Parameters

Returns

None

Callback

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

It runs in the thread that called Base_RunCallback(). It is passed only once per call.

Error Codes

For other possible error codes, see 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)
    {
        // Please implement the logic for a successful outcome.
        for (uint32_t i = 0; i < purchasedProductSize; ++i)
        {
            int64_t productId = purchasedProducts[i].GetProductId();
        }
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

// Call (where `transactionMasterNumber` is the value returned by `GetTransactionMasterNumber()` in the result of `IAP_StartPurchase()`)
IAP_ConfirmPurchase(transactionMasterNumber, OnConfirmPurchaseFinished);

Notes

• This function is asynchronous, and the result is returned only via the onFinished callback.
• If StovePCPurchaseOperation of IAP_StartPurchase is WITH_WEBVIEW_AND_CONFIRM_RESULT, the SDK automatically calls this function, so you do not need to call it separately.
• Whether status and callbackResult are successful is a separate matter. Even if the call itself was successful, if status is false, the purchase has not yet been finalized.

See Also

• IAP_StartPurchase

IAP_FetchInventory

Kind Function · Module IAP · Version 3.0.0.4

Description

Retrieves the list of all purchased items. The results are passed to the onFinished callback.

You must initialize it to IAP_Initialize() before calling it.

Declaration

void IAP_FetchInventory(OnFetchInventoryFinished onFinished);

Parameters

Returns

None

Callback

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

It runs on the thread that called Base_RunCallback(). It is passed only once per call.

Error Codes

For other possible error codes, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::IAP;

void __cdecl OnFetchInventoryFinished(CallbackResult callbackResult, StovePCInventoryItem* inventoryItems, uint32_t inventoryItemSize)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

// Call
IAP_FetchInventory(OnFetchInventoryFinished);

Notes

• This function is asynchronous, and the result is returned only via the onFinished callback.

See Also

• IAP_FetchProducts
• IAP_ConfirmPurchase

IAP_FetchProducts

Kind Function · Module IAP · Version 3.0.0.4 · Deprecated

Description

Do not use this default format. Use IAP_FetchProductsEx instead.

Retrieves product information registered on the Stove platform. You can specify the category, page number, and page size using params.

You must initialize it to IAP_Initialize() before calling it.

Declaration

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

Parameters

Returns

None

Callback

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

It runs in the thread that called Base_RunCallback(). It is passed only once per call.

Error Codes

For other possible error codes, see SDKResultCode.

Memory Management

Example

using namespace Stove::PCSDK::IAP;

void __cdecl OnFetchProductsFinished(CallbackResult callbackResult, StovePCProduct* products, uint32_t productSize)
{
    if (callbackResult.GetResult().IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
        for (uint32_t i = 0; i < productSize; ++i)
        {
            int64_t productId = products[i].GetProductId();
        }
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

// Call
StovePCFetchProductParam params;
params.SetPageNumber(1);
params.SetPageSize(20);

IAP_FetchProducts(&params, OnFetchProductsFinished);

Notes

• This function is asynchronous, and the result is returned only via the onFinished callback.
• If you leave the category ID for params blank, the entire product list will be retrieved. If you do not specify a page number, 1 is used as the default; if you do not specify a page size, 20 is used as the default.
• Always use IAP_FetchProductsEx for actual integration. Purchase-eligible codes (purchase_availability_code) are also only available in the Ex variant.

See Also

• IAP_FetchProductsEx
• IAP_FetchShopCategories
• IAP_StartPurchase

IAP_FetchProductsEx

Kind Function · Module IAP · Version 3.4.1

Description

Retrieves product information registered on the Stove platform. You can specify the category, page number, and page size using params.

The difference from IAP_FetchProducts() is that the product information passed to the callback is StovePCProductEx instead of StovePCProduct. StovePCProductEx provides the purchase availability code (purchase_availability_code) in addition to all the fields in StovePCProduct. Even if the purchase availability code is 1, you may receive a "purchase not available" response if you request to purchase a quantity greater than the remaining stock.

You must initialize it to IAP_Initialize() before calling it.

Declaration

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

Parameters