PC SDK Unity Reference — 3.4.x and Earlier

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

Contents

Base_AccessTokenRenewed

Kind Function · Module Base · Version 3.3.0

Description

Base_AccessTokenRenewed is a function that registers a callback to be called whenever the access token is renewed. Once registered, the callback is called repeatedly each time the token is renewed.

If you call onFinished again, any previously registered callbacks of the same type will be replaced by the new callback.

Declaration

public static void Base_AccessTokenRenewed(OnRenewTokenFinished onFinished);

Parameters

Returns

Callback

public delegate void OnRenewTokenFinished(CallbackResult result, StovePCToken token);

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

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnRenewTokenFinished(CallbackResult callbackResult, StovePCToken token)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic that uses `token.accessToken`.
    }
}

Base_AccessTokenRenewed(OnRenewTokenFinished);

Notes

• This is a notification-type callback that is called repeatedly. It differs in nature from callbacks for one-time asynchronous APIs, such as Base_RestartAppIfNecessaryAsync.

See Also

• Base_GetAccessToken
• StovePCToken

Base_GetAccessToken

Kind Function · Module Base · Version 3.0.0.4

Description

Base_GetAccessToken is a function that returns the current access token by populating accessToken with it. It must be called after initialization.

Declaration

public static Result Base_GetAccessToken(ref string accessToken, uint length);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

string accessToken = string.Empty;
Result result = Base_GetAccessToken(ref accessToken, 1024);

if (result.IsSuccessful())
{
    // Please implement the logic that uses the accessToken.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• To receive a notification when the token is renewed, you must use Base_AccessTokenRenewed.
• 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.

See Also

• Base_AccessTokenRenewed

Base_GetGds

Kind Function · Module Base · Version 3.1.0

Description

Base_GetGds is a function that populates StovePCGds with the user's GDS information and returns it. It must be called after initialization.

Declaration

public static Result Base_GetGds(ref StovePCGds gds);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

StovePCGds gds = default;
Result result = Base_GetGds(ref gds);

if (result.IsSuccessful())
{
    // Please implement logic that uses gds.nation, gds.regulation, and so on.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• If the operation fails, gds will remain at its default value (default).

See Also

• StovePCGds

Base_GetSignin

Kind Function · Module Base · Version 3.1.0

Description

Base_GetSignin is a function that fills in the user's login information into StovePCSignin and returns it. It must be called after initialization.

Declaration

public static Result Base_GetSignin(ref StovePCSignin signin);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

StovePCSignin signin = default;
Result result = Base_GetSignin(ref signin);

if (result.IsSuccessful())
{
    // Please implement the logic that uses `signin.personVerify`, `signin.nationality`, and so on.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• If the operation fails, signin remains at its default value (default).

See Also

• StovePCSignin

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.

Base_GetTraceHint is a function that fills in the session hint information for log tracing into StovePCTraceHint and returns it. It must be called after initialization.

Declaration

public static Result Base_GetTraceHint(ref StovePCTraceHint traceHint);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

StovePCTraceHint traceHint = default;
Result result = Base_GetTraceHint(ref traceHint);

if (result.IsSuccessful())
{
    // Please implement logic to log items such as `traceHint.sessionId`.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• If the operation fails, traceHint will remain at its default value (default).
• This function and StovePCTraceHint are scheduled to be removed in a future version.

See Also

• StovePCTraceHint

Base_GetUser

Kind Function · Module Base · Version 3.0.0.4

Description

Base_GetUser is a function that fills in the logged-in user's information into StovePCUser and returns it. It must be called after initialization.

Declaration

public static Result Base_GetUser(ref StovePCUser user);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

StovePCUser user = default;
Result result = Base_GetUser(ref user);

if (result.IsSuccessful())
{
    // Please implement the logic using `user.nickname` and `user.gameUserId`.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• If the operation fails, user remains at its default value (default).

See Also

• StovePCUser

Base_GetVersion

Kind Function · Module Base · Version 3.0.0.4

Description

Base_GetVersion is a function that returns the SDK version string with version substituted into it.

Declaration

public static Result Base_GetVersion(ref string version, uint length);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

string version = string.Empty;
Result result = Base_GetVersion(ref version, 64);

if (result.IsSuccessful())
{
    // Please implement the logic that uses "version."
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• None

See Also

• None

Base_Initialize

Kind Function · Module Base · Version 3.0.0.4

Description

Base_Initialize is an asynchronous function that takes StovePCInitializeParam as an argument to initialize the SDK. The result is passed to the onFinished callback.

You cannot call any other SDK APIs before calling this function. To call it without initialization parameters, you must use Base_InitializeEx.

Before calling this function, you must first call a function from the Base_RestartAppIfNecessary series (such as Base_RestartAppIfNecessary, Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx, etc.) to verify that it was executed via the launcher. If you do not call them first, the function will fail with error code NEED_STOVE_LAUNCHER (84).

Declaration

public static void Base_Initialize(StovePCInitializeParam initParam, OnInitializeFinished onFinished);

Parameters

Returns

Callback

public delegate void OnInitializeFinished(CallbackResult result);

The callback runs in the thread that called Base_RunCallback(). It runs once for each such call.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnInitializeFinished(CallbackResult callbackResult)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for the success case.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

StovePCInitializeParam initParam = new StovePCInitializeParam
{
    environment = "real",
    gameId = "your_game_id",
    applicationKey = "your_application_key"
};

Base_Initialize(initParam, OnInitializeFinished);

// Please handle the callback by calling it repeatedly within the game loop.
while (isRunning)
{
    Base_RunCallback();
}

Notes

• To receive a callback, you must repeatedly call Base_RunCallback within the game loop. This function should not be called separately in the form of while(true); rather, it must be called every frame within the game loop.
• When the process ends, you must call Base_UnInitialize.

See Also

• Base_InitializeEx
• Base_UnInitialize
• Base_RunCallback

Base_InitializeEx

Kind Function · Module Base · Version 3.4.1

Description

Unlike Base_Initialize, Base_InitializeEx does not accept StovePCInitializeParam; it only accepts a callback. The initialization result is passed to the onFinished callback in the same way.

This function reuses the initialization parameters cached by the Base_RestartAppIfNecessary series of functions (Base_RestartAppIfNecessary, Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx2, etc.). You must call a function from the Base_RestartAppIfNecessary series before calling this function; otherwise, it will fail with error NEED_STOVE_LAUNCHER(84).

Declaration

public static void Base_InitializeEx(OnInitializeFinished onFinished);

Parameters

Returns

Callback

public delegate void OnInitializeFinished(CallbackResult result);

The callback runs in the thread that called Base_RunCallback(). It runs once for each such call.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnInitializeFinished(CallbackResult callbackResult)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for when the operation is successful.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Base_InitializeEx(OnInitializeFinished);

Notes

• The only difference in the signature compared to Base_Initialize is that the StovePCInitializeParam parameter is missing.
• To receive the callback, you must repeatedly call Base_RunCallback within the game loop.

See Also

• Base_Initialize
• Base_UnInitialize

Base_OpenExternalUrl

Kind Function · Module Base · Version 3.3.4

Description

Base_OpenExternalUrl is an asynchronous function that opens the specified URL externally. The result is passed to the onFinished callback.

Declaration

public static void Base_OpenExternalUrl(string url, OnOpenExternalUrlFinished onFinished);

Parameters

Returns

Callback

public delegate void OnOpenExternalUrlFinished(CallbackResult result);

The callback runs in the thread that called Base_RunCallback(). It runs once for each such call.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnOpenExternalUrlFinished(CallbackResult callbackResult)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Base_OpenExternalUrl("https://www.onstove.com", OnOpenExternalUrlFinished);

Notes

• onFinished is required. If it is not provided, it will be treated as INVALID_PARAM.
• Opens the specified URL in your default browser. The game window remains open.
• The callback runs in the thread that called Base_RunCallback().

See Also

• None

Base_OverImmersionNotification

Kind Function · Module Base · Version 3.3.0

Description

Base_OverImmersionNotification is a function that registers a callback to be called when an over-engagement warning is triggered. Calling onFinished again replaces any previously registered callbacks of the same type with the new callback.

Declaration

public static void Base_OverImmersionNotification(OnOverImmersionFinished onFinished);

Parameters

Returns

Callback

public delegate void OnOverImmersionFinished(CallbackResult result, StovePCOverImmersion overImmersion);

The callback runs in the thread that called Base_RunCallback(). It is called whenever an immersion warning occurs.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnOverImmersionFinished(CallbackResult callbackResult, StovePCOverImmersion overImmersion)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic to display warnings using `overImmersion.warningMessage` and similar methods.
    }
}

Base_OverImmersionNotification(OnOverImmersionFinished);

Notes

• This notification may continue to function even in PCBANG_FREE state. You must maintain the callback registration regardless of the state.

See Also

• StovePCOverImmersion
• Base_ShutdownNotification

Base_RestartAppIfNecessary

Kind Function · Module Base · Version 3.1.0

Description

Base_RestartAppIfNecessary is a synchronous function that returns StovePCInitializeParam and restarts the app if necessary. It immediately returns the value bool without a callback.

To process this asynchronously, you must use the Base_RestartAppIfNecessaryAsync series.

Declaration

public static bool Base_RestartAppIfNecessary(StovePCInitializeParam initParam);

Parameters

Returns

Error Codes

None. This function does not return Result/CallbackResult; if an exception occurs internally, the C# exception is rethrown as-is.

Example

using static Stove.PCSDK.Base;

StovePCInitializeParam initParam = new StovePCInitializeParam
{
    environment = "real",
    gameId = "your_game_id",
    applicationKey = "your_application_key"
};

bool restarted = Base_RestartAppIfNecessary(initParam);

Notes

• This function is synchronous and does not accept callbacks. To handle restarts asynchronously, you must use Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx, and Base_RestartAppIfNecessaryAsyncEx2.
• If an exception occurs, the C# exception is rethrown as-is without being wrapped in Result, so the calling code must handle the exception accordingly.

See Also

• Base_RestartAppIfNecessaryAsync
• StovePCInitializeParam

Base_RestartAppIfNecessaryAsync

Kind Function · Module Base · Version 3.3.0

Description

Base_RestartAppIfNecessaryAsync accepts StovePCInitializeParam and a timeout (waitTimeMillisec), and, if necessary, restarts the app asynchronously and notifies you of the result via a callback.

If you need to specify whether to run the launcher, use Base_RestartAppIfNecessaryAsyncEx; if you want to pass the extension initialization parameters as a single structure, use Base_RestartAppIfNecessaryAsyncEx2.

Declaration

public static void Base_RestartAppIfNecessaryAsync(StovePCInitializeParam initParam, uint waitTimeMillisec, OnRestartAppIfNecessaryAsyncFinished onFinished);

Parameters

Returns

Callback

public delegate void OnRestartAppIfNecessaryAsyncFinished(CallbackResult result, bool restartAppIfNecessary);

The callback runs in the thread that called Base_RunCallback(). It runs once for each such call.

Error Codes

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

• 87 IPC_CONNECT_FAILED · 88 IPC_AES_KEY_NOT_RECEIVED · 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 closed.

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnRestartAppIfNecessaryAsyncFinished(CallbackResult callbackResult, bool restartAppIfNecessary)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

StovePCInitializeParam initParam = new StovePCInitializeParam
{
    environment = "real",
    gameId = "your_game_id",
    applicationKey = "your_application_key"
};

Base_RestartAppIfNecessaryAsync(initParam, 3000, OnRestartAppIfNecessaryAsyncFinished);

Notes

• If you pass onFinished to null, only the restart will be handled without a callback.
• To receive the callback, you must repeatedly call Base_RunCallback within the game loop.

See Also

• Base_RestartAppIfNecessaryAsyncEx
• Base_RestartAppIfNecessaryAsyncEx2
• Base_RunCallback

Base_RestartAppIfNecessaryAsyncEx

Kind Function · Module Base · Version 3.4.0

Description

Base_RestartAppIfNecessaryAsyncEx is a version of Base_RestartAppIfNecessaryAsync with the launchLauncher parameter added. The caller can specify whether to run the launcher.

Declaration

public static void Base_RestartAppIfNecessaryAsyncEx(StovePCInitializeParam initParam, uint waitTimeMillisec, bool launchLauncher, OnRestartAppIfNecessaryAsyncFinished onFinished);

Parameters

Returns

Callback

public delegate void OnRestartAppIfNecessaryAsyncFinished(CallbackResult result, bool restartAppIfNecessary);

The callback runs in the thread that called Base_RunCallback(). It runs once for each such call.

Error Codes

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

• 87 IPC_CONNECT_FAILED · 88 IPC_AES_KEY_NOT_RECEIVED · 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 closed.

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnRestartAppIfNecessaryAsyncFinished(CallbackResult callbackResult, bool restartAppIfNecessary)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

StovePCInitializeParam initParam = new StovePCInitializeParam
{
    environment = "real",
    gameId = "your_game_id",
    applicationKey = "your_application_key"
};

Base_RestartAppIfNecessaryAsyncEx(initParam, 3000, true, OnRestartAppIfNecessaryAsyncFinished);

Notes

• Exceptions that occur in a background thread are also passed to the callback as UNMANAGED_EXCEPTION (253) or MANAGED_EXCEPTION (254).
• The only difference between Base_RestartAppIfNecessaryAsync and the signature is the single parameter launchLauncher.

See Also

• Base_RestartAppIfNecessaryAsync
• Base_RestartAppIfNecessaryAsyncEx2

Base_RestartAppIfNecessaryAsyncEx2

Kind Function · Module Base · Version 3.4.1

Description

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

Base_RestartAppIfNecessaryAsyncEx2 is a version of Base_RestartAppIfNecessaryAsyncEx that combines initParam, waitTimeMillisec, and launchLauncher into a single StovePCInitializeParamEx2 structure. platformName and the reserved fields are also passed together via this structure.

Declaration

public static void Base_RestartAppIfNecessaryAsyncEx2(StovePCInitializeParamEx2 initParam, OnRestartAppIfNecessaryAsyncFinished onFinished);

Parameters

Returns

Callback

public delegate void OnRestartAppIfNecessaryAsyncFinished(CallbackResult result, bool restartAppIfNecessary);

The callback runs in the thread that called Base_RunCallback(). It runs once for each such call.

Error Codes

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

• 87 IPC_CONNECT_FAILED · 88 IPC_AES_KEY_NOT_RECEIVED · 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.

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnRestartAppIfNecessaryAsyncFinished(CallbackResult callbackResult, bool restartAppIfNecessary)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

StovePCInitializeParamEx2 initParam = new StovePCInitializeParamEx2
{
    environment = "real",
    gameId = "your_game_id",
    applicationKey = "your_application_key",
    waitTimeMillisec = 3000,
    launchLauncher = true,
    platformName = "your_platform_name"
};

Base_RestartAppIfNecessaryAsyncEx2(initParam, OnRestartAppIfNecessaryAsyncFinished);

Notes

• Exceptions that occur in a background thread are also passed to the callback as UNMANAGED_EXCEPTION(253) or MANAGED_EXCEPTION(254).
• Unlike Base_RestartAppIfNecessaryAsync and Base_RestartAppIfNecessaryAsyncEx, it accepts only StovePCInitializeParamEx2 without any additional parameters.

See Also

• Base_RestartAppIfNecessaryAsyncEx
• StovePCInitializeParamEx2

Base_RunCallback

Kind Function · Module Base · Version 3.0.0.4

Description

Base_RunCallback is a function that executes pending asynchronous API callbacks on the current calling thread. Callbacks for all SDK asynchronous APIs (e.g., Base_Initialize) are executed on the thread that called this function, rather than on an internal SDK thread.

Pending callbacks are processed when they are called every frame (or periodically) within the game loop.

Declaration

public static void Base_RunCallback();

Parameters

None

Returns

Error Codes

None. This function does not return Result/CallbackResult; if an exception occurs internally, the C# exception is rethrown as-is.

Example

using static Stove.PCSDK.Base;

// Please call this every frame within the game loop.
void Update()
{
    Base_RunCallback();
}

Notes

• This is not a function that is called separately in the form of while(true), but rather a function that must be called repeatedly within the game loop.
• To specify a wait time, you must use Base_RunCallbackWithTimeout.

See Also

• Base_RunCallbackWithTimeout
• Base_Initialize

Base_RunCallbackWithTimeout

Kind Function · Module Base · Version 3.3.0

Description

Base_RunCallbackWithTimeout is a function that behaves similarly to Base_RunCallback, but allows you to specify a wait time using timeoutMillisec. The callback is executed on the thread that called this function.

Declaration

public static void Base_RunCallbackWithTimeout(uint timeoutMillisec);

Parameters

Returns

Error Codes

None. This function does not return Result/CallbackResult; if an exception occurs internally, the C# exception is rethrown as-is.

Example

using static Stove.PCSDK.Base;

Base_RunCallbackWithTimeout(100);

Notes

• Just like Base_RunCallback, this must be called repeatedly within the game loop.

See Also

• Base_RunCallback

Base_SetGameProfile

Kind Function · Module Base · Version 3.0.0.4

Description

Base_SetGameProfile is a synchronous function that passes StovePCGameProfile to the SDK.

Declaration

public static Result Base_SetGameProfile(StovePCGameProfile gameProfile);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

StovePCGameProfile gameProfile = new StovePCGameProfile
{
    worldId = "world_01",
    characterNumber = 12345L
};

Result result = Base_SetGameProfile(gameProfile);

if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
}
else
{
    // Please implement the logic for when a failure occurs.
}

Notes

• None

See Also

• StovePCGameProfile

Base_SetLanguage

Kind Function · Module Base · Version 3.1.0

Description

Base_SetLanguage is a synchronous function that sets the SDK language to the enumeration value StoveLanguage.

If you need to specify a language that is not listed here, use Base_SetLanguageEx.

When setting up a new integration, use Base_SetLanguageEx. This allows you to specify languages not listed in the enumeration as strings, so you can continue using them even if new languages are added later.

Declaration

public static Result Base_SetLanguage(StoveLanguage language);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static 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

• Base_SetLanguageEx accepts a string instead of a value from the StoveLanguage enumeration.

See Also

• Base_SetLanguageEx
• StoveLanguage

Base_SetLanguageEx

Kind Function · Module Base · Version 3.4.0

Description

Unlike Base_SetLanguage, Base_SetLanguageEx is a synchronous function that sets the language as a string rather than using the StoveLanguage enumeration. It is used when you need to set a language value that is not listed in StoveLanguage.

Declaration

public static Result Base_SetLanguageEx(string language);

Parameters

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

Result result = Base_SetLanguageEx("ko");

if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• The only difference in the signature compared to Base_SetLanguage is that the parameter type is string rather than the StoveLanguage enumeration.

See Also

• Base_SetLanguage

Base_ShutdownNotification

Kind Function · Module Base · Version 3.3.0

Description

Base_ShutdownNotification is a function that registers a callback to be invoked when a shutdown notification is sent to a user subject to shutdown. Calling onFinished again replaces any previously registered callbacks of the same type with the new callback.

Declaration

public static void Base_ShutdownNotification(OnShutdownFinished onFinished);

Parameters

Returns

Callback

public delegate void OnShutdownFinished(CallbackResult result, StovePCShutdown shutdown);

The callback runs in the thread that called Base_RunCallback(). It is called whenever a shutdown notification occurs.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnShutdownFinished(CallbackResult callbackResult, StovePCShutdown shutdown)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic to display prompts using `shutdown`, `shutdownMessage`, etc.
    }
}

Base_ShutdownNotification(OnShutdownFinished);

Notes

• ShutdownNotification is not a feature exclusive to South Korea. If an account has been shut down, this callback will be triggered even from overseas.

See Also

• StovePCShutdown
• Base_OverImmersionNotification

Base_UnInitialize

Kind Function · Module Base · Version 3.0.0.4

Description

You must call this function before exiting the game. Since this function is responsible for calculating the total playtime and updating the server with that data, if you terminate the process without calling it, the playtime for that session will be missing.

Base_UnInitialize is a synchronous function that terminates the SDK. It clears the pending callback queue in disposal mode (registered user delegates are not called during this process), cleans up the callback container, and performs a native termination.

Declaration

public static Result Base_UnInitialize();

Parameters

None

Returns

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

Result result = Base_UnInitialize();

if (result.IsSuccessful())
{
    // Please implement the logic for a successful outcome.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• During the shutdown process, any callbacks that have already been registered are treated as being in "discard" mode, so the user's delegate is not called. In other words, you should not expect callbacks from asynchronous APIs registered immediately before shutdown.
• Initialization pairs with Base_Initialize or Base_InitializeEx.
• If there are multiple ways for the game to end (normal exit, exception exit, forced exit), ensure that this function is called in all cases. The playtime statistics are calculated at this point.

See Also

• Base_Initialize
• Base_InitializeEx

Base_VietnamAgeRatingNotification

Kind Function · Module Base · Version 3.4.1

Description

Base_VietnamAgeRatingNotification is a function that registers a callback to be invoked when a Vietnamese age rating overlay is required.

This callback is a one-time event and must be registered after rendering is complete.

Declaration

public static void Base_VietnamAgeRatingNotification(OnVietnamAgeRatingFinished onFinished);

Parameters

Returns

Callback

public delegate void OnVietnamAgeRatingFinished(CallbackResult result, StovePCVietnamAgeRatingInfo vietnamAgeRatingInfo);

The callback runs in the thread that called Base_RunCallback(). This is a one-time callback.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnVietnamAgeRatingFinished(CallbackResult callbackResult, StovePCVietnamAgeRatingInfo vietnamAgeRatingInfo)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic to draw an overlay using `vietnamAgeRatingInfo`.
    }
}

Base_VietnamAgeRatingNotification(OnVietnamAgeRatingFinished);

Notes

• This callback must be registered after rendering is possible. If it is registered at a time when rendering is not yet ready—such as immediately after initialization—the overlay may not display properly.
• You must register the "Excessive Engagement Alert" separately under Base_VietnamOverimmersionNotification.

See Also

• StovePCVietnamAgeRatingInfo
• Base_VietnamOverimmersionNotification

Base_VietnamOverimmersionNotification

Kind Function · Module Base · Version 3.4.1

Description

Base_VietnamOverimmersionNotification is a function that registers a callback to be invoked when the Vietnam Immersion overlay needs to be displayed. Calling onFinished again replaces any previously registered callbacks of the same type with the new callback.

This callback is a one-time event and must be registered after the point at which rendering is possible.

Declaration

public static void Base_VietnamOverimmersionNotification(OnVietnamOverimmersionFinished onFinished);

Parameters

Returns

Callback

public delegate void OnVietnamOverimmersionFinished(CallbackResult result, StovePCVietnamOverimmersionInfo vietnamOverimmersionInfo);

The callback runs in the thread that called Base_RunCallback(). This is a one-time callback.

Error Codes

For possible error codes, see BaseSDKResultCode.

Example

using static Stove.PCSDK.Base;

void OnVietnamOverimmersionFinished(CallbackResult callbackResult, StovePCVietnamOverimmersionInfo vietnamOverimmersionInfo)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic to draw overlays using `vietnamOverimmersionInfo`.
    }
}

Base_VietnamOverimmersionNotification(OnVietnamOverimmersionFinished);

Notes

• This callback must be registered after rendering is possible.
• Age rating notifications must be registered separately under Base_VietnamAgeRatingNotification.

See Also

• StovePCVietnamOverimmersionInfo
• Base_VietnamAgeRatingNotification

BaseSDKMethod

Kind Enum · Module Base · Version 3.0.0.4

Description

BaseSDKMethod is the value stored in result.methodCode within Result.methodCode and CallbackResult. It is used to indicate which API call occurred when the C# wrapper converts Managed exception to Result / CallbackResult.

The values are categorized by type as follows.

• Life Cycle: Initialization · Termination · Version Lookup
• Authentication/Token: View and Renew Access Tokens
• User/Game Information: User · GDS · View Login Information
• Language
• Notices/Regulations: Excessive Gaming · Shutdown · Vietnam Regulatory Notice
• Logs/Diagnostics: Log Transmission, Trace Hints, Game Profiles
• App Restart/External Links: Launcher Restart, External URLs

Among these, values prefixed with INTERNAL_ are for internal SDK use only and have been excluded from the table below.

Values prefixed with INTERNAL_ are for internal use only and have therefore been excluded from the table below. You will not need to handle these values directly in the game code.

Declaration

public enum BaseSDKMethod
{
    INITIALIZE = 1,
    UNINITIALIZE = 2,
    // ... See the "Values" table below
    GET_TRANSLATE_LANGUAGE = 119,
};

Enum Values

Life Cycle

Authentication/Token

User/Game Information

Language

Notices/Regulations

Log/Diagnostics

App Restart/External Connection

Unused numbers

Internal-use-only values (INTERNAL_SEND_81PLUG, INTERNAL_UPDATE_81PLUG, INTERNAL_SET_PLAYTIME_REPORT, INTERNAL_OPERATOR_REPORT_PLAYTIME, INTERNAL_GAME_EXIT_REPORT_PLAYTIME, INTERNAL_FILE_SAVE_UNSET_PLAYTIME, INTERNAL_FAILED_PLAYTIME_TRANSFERS, INTERNAL_OPERATOR_REPORT_CONCURRENT_USER, INTERNAL_SERVER_CONFIG, INTERNAL_GDS_INFO, INTERNAL_GAME_CHECKER_LOGIN, INTERNAL_ONSTOVE_LOGIN, INTERNAL_FUNCTION, INTERNAL_RENEW_GUID_TOKEN, INTERNAL_RENEW_TOKEN, INTERNAL_CONVERT_ONLINE_TOKEN, INTERNAL_TRANSLATE_LANGUAGE, INTERNAL_GET_GAMEMETA, for a total of 18) have been excluded from the table.

Example

using static Stove.PCSDK.Base;

// Result.methodCode stores the value of this enumeration as a uint.
void CheckMethod(Result result)
{
    if (result.methodCode == Convert.ToUInt32(BaseSDKMethod.INITIALIZE))
    {
        // These are the results of the calls to Base_Initialize and Base_InitializeEx.
    }
}

Notes

• GET_TOKEN_TO_PRIVATE, GET_ENV_TOKEN_TO_PRIVATE, GET_GAMEID_TO_PRIVATE, GET_MEMBERNO_PRIVATE, GET_PUBLIC_IP, FORCE_REFRESH_TOKEN, ACCESS_TOKEN_RENEWED_TO_PRIVATE, GET_TRANSLATE_LANGUAGE do not contain INTERNAL in their names, but no public Base_ API that uses this value within BaseAPI.cs has been identified. Values 112–119 in the C++ source header (BaseSDKResult.h) are all explicitly marked with the comment “Internal method,” confirming that these values are used exclusively within the SDK and have no corresponding public API.
• There is no public API corresponding to LOG_ADD(70). Although the C++ source header contains a comment for Base_LogAdd (deprecated), there is no function declaration for Base_LogAdd in any of the currently public headers. This is a deprecated API where only the code value remains for backward compatibility.

See Also

• Result
• CallbackResult

BaseSDKResultCode

Kind Result Code · Module Base · Version 3.0.0.4

Description

BaseSDKResultCode is the value stored in Result.resultCode. 0 (SUCCESS) indicates success; any other value indicates the cause of failure. Result.IsSuccessful() checks whether resultCode == 0 is true.

If an exception occurs inside the C# wrapper (such as a marshaling error), it always returns a Result filled with MANAGED_EXCEPTION(254).

Declaration

public enum BaseSDKResultCode
{
    SUCCESS = 0,
    FAIL = 1,
    // ... See the "Values" table below
    IPC_TIMEOUT = 89,
}

Enum Values

Success/General Error

Initial State

Authentication/Token

Response/Communication

81Plug Integration

Country/Regulations

For Internal Use Only

Language/GDS

Launcher Integration

For C# Wrappers Only

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

• 19 INVALID_ACCESS_TOKEN — Your login session has expired; please close the game and restart it.
• 84 NEED_STOVE_LAUNCHER — You'll need to restart the game after it closes.
• 87 IPC_CONNECT_FAILED — You'll need to restart the game after it closes.
• 88 IPC_AES_KEY_NOT_RECEIVED — You will need to restart the game after it closes
• 89 IPC_TIMEOUT — You will need to restart the game after it ends

If you run the game executable file directly without the Stove PC client, error 87(IPC_CONNECT_FAILED) or 89(IPC_TIMEOUT) will occur. In this case, you must close the game; once closed, the Stove launcher will launch automatically.

Example

using static Stove.PCSDK.Base;

Result result = Base_SetGameProfile(gameProfile);

if (result.IsSuccessful())
{
    // Please implement the logic for when the operation is successful.
}
else if (result.resultCode == Convert.ToUInt32(BaseSDKResultCode.BASE_NOT_INITIALIZED))
{
    // Please implement the logic for calling the initialization function first.
}
else
{
    // Please implement the logic for other failure scenarios.
}

Notes

• POPUP_NOT_CREATED(33) is used in the pop-up's internal cleanup path rather than in the SDK Legacy API itself, and is not passed to the user callback.

See Also

• Result
• CallbackResult

CallbackResult

Kind Struct · Module Base · Version 3.0.0.4

Description

CallbackResult is a structure passed as the first argument to callbacks by the SDK Legacy API—such as Base_Initialize and Base_RestartAppIfNecessaryAsync. The actual success or failure is determined by the internal result field.

Declaration

public struct CallbackResult
{
    public Result result;
    public string errorMessage;
    public int externalError;
}

Members

Example

using static Stove.PCSDK.Base;

void OnInitializeFinished(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

• The result is callbackResult.result.IsSuccessful(). result is a lowercase field, and IsSuccessful() is a method.
• The IStoveCallbackResult of the new C# interface (Stove.PCSDK.V3) uses the Result property (capitalized), so its notation differs from that of the old interface.

See Also

• Result

DiscountType

Kind Enum · Module IAP · Version 3.0.0.4

Description

Stored in the StovePCProduct.discountType / StovePCProductEx.discountType fields, this indicates whether the discount method (isDiscount == true) is a percentage or a fixed amount when the product is on sale.

Declaration

public enum DiscountType
{
    NONE = 0,
    FIXED_RATE = 1,
    FLAT_RATE,
};

Enum Values

Example

using static Stove.PCSDK.IAP;

void CheckDiscount(StovePCProduct product)
{
    if (product.isDiscount && product.discountType == DiscountType.FIXED_RATE)
    {
        // Please implement the logic to display a fixed-rate discount. `discountTypeValue` represents the discount rate.
    }
}

Notes

• It is used in conjunction with the discountTypeValue field. A value of FIXED_RATE indicates a percentage, while a value of FLAT_RATE indicates a fixed amount.

See Also

• StovePCProduct
• StovePCProductEx

IAP_CloseAllPopups

Kind Function · Module IAP · Version 3.1.3

Description

If any web view pop-ups triggered by the payment feature (such as purchase, payment, terms and conditions agreement, or game withdrawal) are open, close them all.

It must be called after IAP_Initialize.

Declaration

public static Result IAP_CloseAllPopups()

Parameters

None

Returns

Error Codes

The value of Result.methodCode is Convert.ToUInt32(IAPSDKMethod.CLOSE_ALL_POPUPS).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.IAP;

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

Notes

• This function is synchronous and does not accept callbacks.
• Use this when you need to close all open pop-ups at once, such as when exiting a game.

See Also

• IAP_StartPurchase
• IAP_StartPayment
• IAP_WithdrawGame

IAP_ConfirmPurchase

Kind Function · Module IAP · Version 3.0.0.4

Description

Confirms the purchase for the transaction specified as transactionMasterNo. Passes StovePCPurchaseResult.transactionMasterNumber, which was received via the callback from IAP_StartPurchase / IAP_StartPurchaseEx.

It must be called after IAP_Initialize.

Declaration

public static void IAP_ConfirmPurchase(long transactionMasterNo, OnConfirmPurchaseFinished onFinished)

Parameters

Returns

None

Callback

public delegate void OnConfirmPurchaseFinished(CallbackResult callbackResult, bool status, StovePCPurchasedProduct[] purchasedProducts, StovePCChargeInfo[] chargeInfos);

This callback runs in the thread that called Base_RunCallback(). It runs once per call.

Error Codes

The value of CallbackResult.result.methodCode is Convert.ToUInt32(IAPSDKMethod.CONFIRM_PURCHASE).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.IAP;

IAP_ConfirmPurchase(transactionMasterNumber, OnConfirmPurchaseFinished);

void OnConfirmPurchaseFinished(CallbackResult callbackResult, bool status, StovePCPurchasedProduct[] purchasedProducts, StovePCChargeInfo[] chargeInfos)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Notes

• transactionMasterNo is obtained from the callback result of the IAP_StartPurchase series API.
• You must call Base_RunCallback() repeatedly within the game loop for the callback to be passed.

See Also

• IAP_StartPurchase
• StovePCPurchasedProduct
• StovePCChargeInfo

IAP_FetchInventory

Kind Function · Module IAP · Version 3.0.0.4

Description

Displays a list of the items in the user's inventory.

It must be called after IAP_Initialize.

Declaration

public static void IAP_FetchInventory(OnFetchInventoryFinished onFinished)

Parameters

Returns

None

Callback

public delegate void OnFetchInventoryFinished(CallbackResult callbackResult, StovePCInventoryItem[] inventoryItems);

This callback runs in the thread that called Base_RunCallback(). It runs once per call.

Error Codes

The value of CallbackResult.result.methodCode is Convert.ToUInt32(IAPSDKMethod.FETCH_INVENTORY).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.IAP;

IAP_FetchInventory(OnFetchInventoryFinished);

void OnFetchInventoryFinished(CallbackResult callbackResult, StovePCInventoryItem[] inventoryItems)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Notes

• You must repeatedly call Base_RunCallback() within the game loop for the callback to be passed.

See Also

• StovePCInventoryItem

IAP_FetchProducts

Kind Function · Module IAP · Version 3.0.0.4 · Deprecated

Description

Do not use this default template. Use IAP_FetchProductsEx instead.

Retrieves a list of products within the category and page range specified by productParam.

It must be called after IAP_Initialize.

Declaration

public static void IAP_FetchProducts(StovePCFetchProductParam productParam, OnFetchProductsFinished onFinished)

Parameters

Returns

None

Callback

public delegate void OnFetchProductsFinished(CallbackResult callbackResult, StovePCProduct[] products);

This callback runs in the thread that called Base_RunCallback(). It runs once per call.

Error Codes

The value of CallbackResult.result.methodCode is Convert.ToUInt32(IAPSDKMethod.FETCH_PRODUCTS).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.IAP;

StovePCFetchProductParam param = new StovePCFetchProductParam();
param.categoryId = "YOUR_CATEGORY_ID";
param.pageNumber = 1;
param.pageSize = 20;

IAP_FetchProducts(param, OnFetchProductsFinished);

void OnFetchProductsFinished(CallbackResult callbackResult, StovePCProduct[] products)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for when the operation is successful.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Notes

• Always use IAP_FetchProductsEx for actual integration. The availability code (purchaseAvailabilityCode) is also only available in the Ex variant.
• You must call Base_RunCallback() repeatedly within the game loop for the callback to be passed.

See Also

• IAP_FetchProductsEx
• StovePCFetchProductParam
• StovePCProduct
• IAP_FetchShopCategories

IAP_FetchProductsEx

Kind Function · Module IAP · Version 3.4.1

Description

It returns StovePCProductEx[], which has the same input parameters (productParam) as IAP_FetchProducts but includes the purchaseAvailabilityCode field in the query results. It differs from IAP_FetchProducts—which returns StovePCProduct[]—only in the return type.

It must be called after IAP_Initialize.

Declaration

public static void IAP_FetchProductsEx(StovePCFetchProductParam productParam, OnFetchProductsExFinished onFinished)

Parameters

Returns

None

Callback

public delegate void OnFetchProductsExFinished(CallbackResult callbackResult, StovePCProductEx[] products);

This callback runs in the thread that called Base_RunCallback(). It runs once per call.

Error Codes

The value of CallbackResult.result.methodCode is Convert.ToUInt32(IAPSDKMethod.FETCH_PRODUCTS).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.IAP;

StovePCFetchProductParam param = new StovePCFetchProductParam();
param.categoryId = "YOUR_CATEGORY_ID";
param.pageNumber = 1;
param.pageSize = 20;

IAP_FetchProductsEx(param, OnFetchProductsExFinished);

void OnFetchProductsExFinished(CallbackResult callbackResult, StovePCProductEx[] products)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Notes

• If purchaseAvailabilityCode is not needed, use IAP_FetchProducts.
• You must call Base_RunCallback() repeatedly within the game loop for the callback to be passed.

See Also

• IAP_FetchProducts
• StovePCProductEx
• StovePCFetchProductParam

IAP_FetchShopCategories

Kind Function · Module IAP · Version 3.0.0.4

Description

Retrieves the list of categories registered in the store. The retrieved category ID is used in StovePCFetchProductParam.categoryId of IAP_FetchProducts / IAP_FetchProductsEx.

It must be called after IAP_Initialize.

Declaration

public static void IAP_FetchShopCategories(OnFetchShopCategoriesFinished onFinished)

Parameters

Returns

None

Callback

public delegate void OnFetchShopCategoriesFinished(CallbackResult callbackResult, StovePCShopCategory[] shopCategories);

This callback runs in the thread that called Base_RunCallback(). It runs once per call.

Error Codes

The value of CallbackResult.result.methodCode is Convert.ToUInt32(IAPSDKMethod.FETCH_SHOP_CATEGORIES).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.IAP;

IAP_FetchShopCategories(OnFetchShopCategoriesFinished);

void OnFetchShopCategoriesFinished(CallbackResult callbackResult, StovePCShopCategory[] shopCategories)
{
    if (callbackResult.result.IsSuccessful())
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Notes

• You must call Base_RunCallback() repeatedly within the game loop for the callback to be passed.

See Also

• StovePCShopCategory
• IAP_FetchProducts

IAP_FetchTermsAgreement

Kind Function · Module IAP · Version 3.0.0.4

Description

Checks whether the user has agreed to the terms and conditions. Depending on how option operates, a web view pop-up for agreeing to the terms and conditions may appear.

It must be called after IAP_Initialize.

Declaration

public static void IAP_FetchTermsAgreement(StovePCTermsOption option, OnFetchTermsAgreementFinished onFinished)

Parameters

Returns

None

Callback

public delegate void OnFetchTermsAgreementFinished(CallbackResult callbackResult, bool agreed, string url);

This callback runs in the thread that called Base_RunCallback(). It runs once per call.

Error Codes

The value of CallbackResult.result.methodCode is Convert.ToUInt32(IAPSDKMethod.FETCH_TERMS_AGREEMENT).

For the complete list, see IAPSDKResultCode.

Example

using static Stove.PCSDK.Base;
using static Stove.PCSDK.IAP;

StovePCTermsOption option = new StovePCTermsOption();
option.operation = StovePCTermsOperation.WITH_WEBVIEW;
option.webviewMode = WebViewMode.INTERNAL;
option.webviewWidth = 800;
option.webviewHeight = 600;

IAP_FetchTermsAgreement(option, OnFetchTermsAgreementFinished);

void OnFetchTermsAgreementFinished(CallbackResult callbackResult, bool agreed, string url)
{
    if (callbackResult.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 detect when the popup closes (destroy) separately, use IAP_FetchTermsAgreementEx.
• You must call Base_RunCallback() repeatedly within the game loop for the callback to be passed.

See Also

• IAP_FetchTermsAgreementEx
• StovePCTermsOption

IAP_FetchTermsAgreementEx

Kind Function · Module IAP · Version 3.3.4

Description

Just like IAP_FetchTermsAgreement, it checks whether the terms and conditions have been accepted, but it also receives an additional callback, onDestroy, which is triggered when the terms and conditions pop-up is closed. The remaining parameters and the result callback (onFinished) are the same as those for IAP_FetchTermsAgreement.

It must be called after IAP_Initialize.

Declaration

public static void IAP_FetchTermsAgreementEx(StovePCTermsOption option, OnFetchTermsAgreementFinished onFinished, OnIAPPopupDestroyFinished onDestroy)

Parameters

Returns

None

Callback