PC SDK Unity Reference

Based on SDK version 3.5.0. 100 items combined in alphabetical order.

Contents

Basic Integration Guide

Kind Integration Guide · Module Base · Version 3.5.0

Description

The C# API in this guide is a managed wrapper for calling all SDK functions in a .NET (Mono / IL2CPP) environment. Internally, it calls C flat functions in the native DLL via P/Invoke, but the caller only needs to deal with managed types (readonly struct, struct, enum, delegate).

Compatibility: C# 7.3 (.NET Framework 4.6, Unity 2019 Mono) or later.

Declaration Forms

All types are defined under the Stove.PCSDK.V3 namespace, and each module has static partial class (Base, IAP, Log, PCBang, View). Methods, structures, callback delegates, and enumerations are declared together within the same class. The GamingServices module is not provided in the new interface.

using Stove.PCSDK.V3;

// Or use static imports on a per-module basis:
using static Stove.PCSDK.V3.Base;
using static Stove.PCSDK.V3.IAP;

If you use using static, you can call it directly, like Stove_Initialize(), without a class prefix.

Naming Rules

Memory Lifetime

All types in this guide are managed (C#) types and are handled by the garbage collector. Unlike with the Native API, there is no need to explicitly call Destroy().

Initialization Order

1. Create the IStoveRestartAppIfNecessaryParam structure and set Environment, GameId, AppKey, WaitTimeMilliSec, LaunchStoveLauncher, and PlatformName. (IStoveRestartAppIfNecessaryParam)
2. Calls Stove_RestartAppIfNecessary(restartParam, onFinished) — asynchronously. The callback is dispatched when Stove_RunCallback() is called.
3. In the game's main loop (main/UI thread), it begins calling Stove_RunCallback() every frame. This loop must start running immediately after the call to Stove_RestartAppIfNecessary() so that the callback in (2) above is dispatched, leading to the initialization in (4).
4. Create the IStoveInitializeParam structure in the outcome.IsRestartRequired == false branch of the callback. To use View, also set MainWndHandle; to use IAP, also set ShopKey. (If IsRestartRequired == true, the SDK handles relaunch via the launcher, so the current process is terminated. IStoveInitializeParam)
5. Calls Stove_Initialize(initParam) in the same block — synchronously, immediately returns IStoveResult. Checks for success using result.IsSuccessful.
6. Call Stove_Uninitialize() upon termination.

using Stove.PCSDK.V3;
using static Stove.PCSDK.V3.Base;

// 1) Check the launcher / Create and configure the restart parameter structure
var restartParam = new IStoveRestartAppIfNecessaryParam
{
    Environment        = "LIVE",          // "QA" / "SANDBOX" / "LIVE"
    GameId             = "my_game_id",
    AppKey             = "my_app_key",
    WaitTimeMilliSec   = 5000,
    LaunchStoveLauncher = true,
    PlatformName       = "stove",
};

// 2) Check if the launcher is running (asynchronous). The callback is dispatched when Stove_RunCallback() is called.
Stove_RestartAppIfNecessary(restartParam, (callbackResult, outcome) =>
{
    if (outcome.IsRestartRequired)
        return;  // The SDK is being relaunched via the launcher; the current process has been terminated.

    // 4) SDK Initialization (Synchronous). View and IAP are also initialized based on the MainWndHandle and ShopKey settings in initParam.
    var initParam = new IStoveInitializeParam
    {
        // To use View, set MainWndHandle; to use IAP, set ShopKey as well.
        // MainWndHandle = myWindowHandle,
        // ShopKey       = "my_shop_key",
    };

    var result = Stove_Initialize(initParam);
    if (result.IsSuccessful)
    {
        // Initialization complete; SDK is now available
    }
    else
    {
        // Error Handling: result.ResultCode, result.ExceptionMessage
    }
});

// 3) Execute the callback on every frame / every tick (main / UI thread)
//    This loop must begin immediately after the call to `Stove_RestartAppIfNecessary()` so that the callback in (2) above is dispatched, leading to the initialization in (4).
void OnUpdate()
{
    Stove_RunCallback();
}

// 5) Upon completion
Stove_Uninitialize();

Callback Execution Rules

• The callbacks for all asynchronous methods run on the thread (main or UI thread) where Stove_RunCallback() or Stove_RunCallbackWithTimeout(timeoutMillisec) is called. They do not run on an internal SDK thread.
• The callback signature is of the form delegate void On<Action>Callback(IStoveCallbackResult callbackResult, ...), and success is determined by callbackResult.Result.IsSuccessful.
• One-time callbacks (such as Stove_VietnamAgeRatingNotification and Stove_VietnamOverimmersionNotification) must be called after rendering is possible. Register and call them after the first frame has been rendered following the start of the game.
• Delegates registered with repeatable callbacks (such as Stove_AccessTokenRenewed and Stove_OverImmersionNotification) are referenced until the SDK is closed or the registration is canceled. Be mindful of the lifetime of the captured objects.
• The onFinished callback for a one-time asynchronous method is a required parameter. If it is not specified, a k_EStoveCommonResultCode_InvalidParam(5) error occurs.

Common Interface

For types shared by all modules, we only provide links to the respective documents. Please refer to each document for details.

• IStoveResult — The result of calling a synchronous method. It is an immutable struct that contains the method code, result code, and managed exception message.
• IStoveCallbackResult — This is the result passed via an asynchronous callback. It contains both IStoveResult and external error information (such as HTTP status codes).

Notes

• Stove_RestartAppIfNecessary() must be called before Stove_Initialize(), and to receive its callback, Stove_RunCallback() must be running in the game loop immediately after the call.
• Stove_Initialize() is a synchronous method, so it does not accept a callback, but it must be called from within the callback of Stove_RestartAppIfNecessary() (the outcome.IsRestartRequired == false branch).
• The asynchronous methods of this API do not accept the userData parameter. Please pass the context to be used within the callback via lambda capture.

See Also

EStoveBaseMethodCode

Kind Enum · Module Base · Version 3.5.0

Description

Identifies which SDK method generated this result based on the value returned by IStoveResult.MethodCode. It is used for logging and error routing.

Declaration

public enum EStoveBaseMethodCode
{
    k_EStoveBaseMethodCode_Invalid = -1,
    k_EStoveBaseMethodCode_BaseInitialize = 1,
    // ... See the table of enumerated values below
    k_EStoveBaseMethodCode_GetTranslateLanguage = 119,

    k_EStoveBaseMethodCode_Max = 0x7fffffff
}

Enum Values

Lifecycle / Versioning

Public APIs

Private getters (private getters exposed to other SDK modules—not exposed to the game)

Other

Values whose names contain Internal (3, 4, 96–108, 110–114) are excluded from the table. 109 is a reserved number that appears in the source without a name, accompanied only by a "Deprecated" comment.

Example

using static Stove.PCSDK.V3.Base;

IStoveResult result = Stove_Initialize();

if (result.MethodCode == (uint)EStoveBaseMethodCode.k_EStoveBaseMethodCode_BaseInitialize)
{
    // Please implement logic to verify that this result was generated by a call to `Stove_Initialize()`.
}

Notes

• The code for the "Internal" methods starting with line 96 is used for internal SDK operations, such as reporting playtime, configuring the server, and processing tokens, and does not correspond to any APIs that can be called directly from the game.
• The private getters numbered 115–119 were included in the table because their names do not contain Internal, but they are private APIs exposed only to other SDK modules and are not available in the game.
• Since IStoveResult.MethodCode is of type uint, it is cast to (uint)EStoveBaseMethodCode.k_... when compared to this enumeration value.
• In the previous version, there was no underscore in the value name (k_EStoveBaseMethodCodeBaseInitialize). In the current source, an underscore is inserted between the enumeration name and the value name, as in k_EStoveBaseMethodCode_BaseInitialize.

Changelog

See Also

• IStoveResult
• EStoveCommonResultCode
• EStoveResultCode

EStoveBaseTypeKind

Kind Enum · Module Base · Version 3.5.0

Description

This is the value that identifies concrete type in the SDK structure. In the new flat C interface, it is used to request a specific parameter object with Stove_CreateParam() and to identify the runtime type with IStoveTypeBase::GetTypeKind().

The C# interface does not have a public function corresponding to Stove_CreateParam(). Parameter structures such as IStoveInitializeParam and IStoveSetGameProfileParam are created directly by the game code as new IStoveXxx { ... }, and this enumeration is used only internally by the SDK during the marshaling process (interoperability with native DLLs).

The value range is 0 to 999.

Declaration

public enum EStoveBaseTypeKind
{
    k_EStoveBaseTypeKind_Invalid = -1,
    k_EStoveBaseTypeKind_Base = 0,
    // ... See the table of enumerated values below
    k_EStoveBaseTypeKind_SetGameProfileParam = 502,

    k_EStoveBaseTypeKind_Max = 0x7fffffff,
}

Enum Values

Result / Data types (returned by the SDK or passed via callback)

Parameter types (used internally for parameter marshaling)

Example

// The C# game code does not handle this enumeration directly.
// Parameters use value types that are created directly, as shown below.
IStoveSetGameProfileParam gameProfileParam = new IStoveSetGameProfileParam
{
    WorldId = "world_01",
    CharacterNo = 123456789L,
};

Notes

• In the new flat C interface, this enumeration is used directly in the Stove_CreateParam() call, but since the C# interface lacks a corresponding public constructor, there is rarely a need to reference this enumeration in the game code.
• The value 500 (k_EStoveBaseTypeKind_RestartAppIfNecessaryParam) has been added, and InitializeParam and SetGameProfileParam have been shifted one position to 501 and 502, respectively; as a result, the numbering differs from the previous format (InitializeParam=500, GameProfileParams=501).
• StoveOverImmersionInfo(7) and StoveShutdownInfo(10) were previously named StoveOverImmersion and StoveShutdown.

Changelog

See Also

• IStoveInitializeParam
• IStoveRestartAppIfNecessaryParam
• IStoveSetGameProfileParam

EStoveCommonResultCode

Kind Result Code · Module Base · Version 3.5.0

Description

This is the result code used by all Stove SDK modules. It is retrieved as IStoveResult.ResultCode; a value of 0 (Success) indicates success. The value range is 0–299.

For the dedicated codes reassigned by module-specific bands, see EStoveResultCode (300–503).

Declaration

public enum EStoveCommonResultCode
{
    k_EStoveCommonResultCode_Success = 0,
    k_EStoveCommonResultCode_Fail = 1,
    // ... See the table of enumerated values below
    k_EStoveCommonResultCode_UnknownError = 255,

    k_EStoveCommonResultCode_Max = 0x7fffffff
}

Enum Values

General Results

Configuration/Parameter Validation Failed

Initialization State Error

Token/Entity Error

HTTP/Response Errors

Other Conditions

Local DB Failure (Common to All Stove SDK Modules)

Web View/Pop-up UI Failure (Common to All Modules)

Parameter/Payload Validation (Common to All Modules)

Network Transmission Failure

System/Runtime Failure

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

• 19 k_EStoveCommonResultCode_InvalidAccessToken — The game has closed due to a expired login session; please restart it.

Example

using static Stove.PCSDK.V3.Base;

IStoveResult result = Stove_Uninitialize();

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

Notes

• These are the result codes used in common by all SDK APIs and other SDK modules.
• The dedicated codes, which have been reorganized by module-specific bands, are defined as EStoveResultCode (300–503), and their numbers do not overlap with this enumeration.
• The range has significantly expanded with the consolidation into a single binary. In the previous version, this enumeration was defined only up to the 32 range, but now, code for the WebView/pop-up UI (60–68) and parameter/payload validation (80–82), among others, has been incorporated into this enumeration, resulting in values distributed across the entire range from 0 to 255.
• k_EStoveCommonResultCode_PopupNotCreated(33) is intended solely for internal use and is not passed to user delegates; however, since its name does not include Internal, it has been included in the table.

Changelog

See Also

• EStoveResultCode
• IStoveResult
• IStoveCallbackResult

EStoveDiscountType

Kind Enum · Module IAP · Version 3.5.0

Description

This is the value returned by IStoveProduct.DiscountType. It determines whether the value of IStoveProduct.DiscountTypeValue should be interpreted as a percentage or a fixed amount.

Declaration

public enum EStoveDiscountType
{
    k_EStoveDiscountType_None = 0,
    k_EStoveDiscountType_FixedRate = 1,
    k_EStoveDiscountType_FlatRate = 2,

    k_EStoveDiscountType_Max = 0x7fffffff
}

Enum Values

Example

if (product.DiscountType == EStoveDiscountType.k_EStoveDiscountType_FixedRate)
{
    // Please implement logic that interprets `product.DiscountTypeValue` as a percentage.
}

Notes

• This value is valid only for products where IStoveProduct.IsDiscounted is true.

See Also

• Stove_FetchProducts
• IStoveProduct

EStoveIAPMethodCode

Kind Enum · Module IAP · Version 3.5.0

Description

Retrieve IStoveResult.MethodCode and identify which payment API generated this result. Use this for logging or error-handling branches.

Values are assigned sequentially within the IAP module block (2000 series).

Declaration

public enum EStoveIAPMethodCode
{
    k_EStoveIAPMethodCode_Invalid = -1,
    k_EStoveIAPMethodCode_FetchShopCategories = 2000,
    // ... See the table of enumerated values below
    k_EStoveIAPMethodCode_Max = 0x7fffffff
}

Enum Values

Example

if (callbackResult.Result.MethodCode == (uint)EStoveIAPMethodCode.k_EStoveIAPMethodCode_StartPurchase)
{
    // This is the result of the Stove_StartPurchase() call.
}

Notes

• The module-specific EStoveIAPResultCode has been removed. The resulting code has been consolidated into common (EStoveCommonResultCode) and module-specific (EStoveResultCode) enumerations.
• Since IStoveResult.MethodCode is of type uint, a type cast is required when comparing them.
• Lifecycle codes such as Initialize, Uninitialize, and GetVersion, which existed prior to the single-binary integration, have been moved to the enumeration on the Base side.

See Also

• EStoveResultCode
• EStoveCommonResultCode

EStoveIAPTypeKind

Kind Enum · Module IAP · Version 3.5.0

Description

In the Native (C) interface, Stove_CreateParam() is used to create the desired payment parameter object, and IStoveTypeBase::GetTypeKind() is used to determine the object's actual type at runtime.

In C# interfaces, parameters are provided as regular structs (such as IStoveFetchProductsParam), so the caller never uses these values directly. The Interop layer uses these values internally when creating native parameter objects.

The value range is 2000–2999. Within this range, the 2000s represent the result/data types passed by the SDK via callbacks, while the 2500s represent parameter types. Since there are more than 20 values, they are grouped by category.

Declaration

public enum EStoveIAPTypeKind
{
    k_EStoveIAPTypeKind_Invalid = -1,
    k_EStoveIAPTypeKind_ShopCategory = 2000,
    // ... See the table of enumerated values below
    k_EStoveIAPTypeKind_Max = 0x7fffffff
}

Enum Values

Results / Data Types (Passed by the SDK via callback)

Parameter Type (Created by the caller using Stove_CreateParam)

The numbers related to VoidedPurchase and PaymentParam have been designated for internal use only and excluded from the table. The numbers related to VoidedPurchasesEx and FetchVoidedPurchasesExParam (2007, 2508) remain only as reservation numbers, as the refund lookup feature itself has been removed from the source code. The VoidedPurchase family of types is not available in the v2 Managed API.

Example

// The C# interface does not use this value directly, and
// We create and use a struct that corresponds to the following right away.
var fetchProductsParam = new IStoveFetchProductsParam { CategoryId = "", PageIndex = 1, PageSize = 20 };

Notes

• The TypeKind enumerations for each module—such as Base and IAP—use distinct integer ranges.
• The 2000 series (results/data types) is not created directly by the caller; it appears only as the type of the value passed to the callback.
• k_EStoveIAPTypeKind_StartPurchaseOutcome corresponds to IStovePurchaseResult in the old interface. The name has been changed.

See Also

• Stove_FetchProducts
• Stove_StartPurchase

EStoveLocale

Kind Enum · Module Base · Version 3.5.0

Description

This is the PCSDK UI language selector. k_EStoveLocale_System follows the user's OS language.

It is used in the Stove_SetLanguage(EStoveLocale language) overload marked as [Obsolete]. This overload internally converts the value to a string and calls the same native API as Stove_SetLanguageEx(string language).

The Stove_SetLanguage(EStoveLocale) overload that uses this enumeration is marked as [Obsolete("Use Stove_SetLanguageEx(string language) instead.")]. New code must use Stove_SetLanguageEx(string), which accepts a string.

Declaration

public enum EStoveLocale
{
    k_EStoveLocale_Invalid = -1,

    k_EStoveLocale_System = 0,
    k_EStoveLocale_En = 1,
    k_EStoveLocale_Ko = 2,
    k_EStoveLocale_Ja = 3,
    k_EStoveLocale_ZhCn = 4,
    k_EStoveLocale_ZhTw = 5,
    k_EStoveLocale_De = 6,
    k_EStoveLocale_Fr = 7,
    k_EStoveLocale_Es = 8,
    k_EStoveLocale_Pt = 9,
    k_EStoveLocale_Th = 10,
    k_EStoveLocale_Vi = 11,

    k_EStoveLocale_Max = 0x7fffffff
}

Enum Values

Example

using static Stove.PCSDK.V3.Base;

// New code should use `Stove_SetLanguageEx(string)`.
IStoveResult result = Stove_SetLanguageEx("ko");

Notes

• EStoveLocale is an enumeration found only in C# interfaces. The new flat C interface has no corresponding enumeration; instead, the language setting is provided as Stove_SetLanguage(), which accepts only a single string (const wchar_t*).
• In the C# source code (BaseAPIV2.cs), LocaleToString() converts this enumeration value to a lowercase string. The mapping rule is '_' → '-' (e.g., k_EStoveLocale_ZhCn → "zh-cn").
• k_EStoveLocale_Invalid and k_EStoveLocale_Max are both treated as "system" during conversion.
• The Stove_SetLanguage(EStoveLocale) API that uses this enumeration is [Obsolete] itself, and new code must use Stove_SetLanguageEx(string).

Changelog

See Also

• None

EStoveLogMethodCode

Kind Enum · Module Log · Version 3.5.0

Description

This value identifies the API of the logging feature that generated IStoveResult. It can be queried as IStoveResult.MethodCode and is used in log entries or error-handling branches.

The integer range used by this enumeration is 6000 to 6999.

Declaration

public enum EStoveLogMethodCode
{
    k_EStoveLogMethodCode_Invalid = -1,
    k_EStoveLogMethodCode_SendLog = 6000,
    k_EStoveLogMethodCode_Max = 0x7fffffff
}

Enum Values

Example

using static Stove.PCSDK.V3.Log;

void OnSendLogCallback(IStoveCallbackResult callbackResult)
{
    uint methodCode = callbackResult.Result.MethodCode; // k_EStoveLogMethodCode_SendLog
}

Notes

• Since the log feature has only one public API, Stove_SendLog, it also has only one MethodCode value.
• The module-specific result code enumeration EStoveLogResultCode from the previous interface has been removed. The cause of failure is identified as IStoveResult.ResultCode, and the values are defined in the module-specific EStoveResultCode or the common EStoveCommonResultCode.

See Also

• Stove_SendLog

EStoveLogTypeKind

Kind Enum · Module Log · Version 3.5.0

Description

This is the value that identifies concrete type in the parameter structure handled by the log function.

The integer range used by this enumeration is 6000 to 6999.

Declaration

public enum EStoveLogTypeKind
{
    k_EStoveLogTypeKind_Invalid = -1,
    k_EStoveLogTypeKind_SendLogParam = 6500,
    k_EStoveLogTypeKind_Max = 0x7fffffff
}

Enum Values

Example

// The C# interface creates and uses the `IStoveSendLogParam` directly, and
// Do not pass this enumeration value directly to an API call.

Notes

• The log function defines only one parameter type, IStoveSendLogParam, and has no result or data type (the callback passes only IStoveCallbackResult).
• The range 6000–6999 is reserved exclusively for Log, so it does not overlap with the TypeKind values of other modules.

See Also

• IStoveSendLogParam
• Stove_SendLog

EStoveOverlayMode

Kind Enum · Module Base · Version 3.5.0

Description

This value indicates the display status of regulatory/notification overlays, such as Vietnam age rating notices and excessive use prevention notices.

Queries IStoveVietnamAgeRatingInfo.OverlayMode and IStoveVietnamOverimmersionInfo.OverlayMode (both properties are of type int and hold values from this enumeration).

Declaration

public enum EStoveOverlayMode
{
    k_EStoveOverlayMode_Invalid = -1,

    k_EStoveOverlayMode_Show = 0,
    k_EStoveOverlayMode_Hide = 1,
    k_EStoveOverlayMode_Expanded = 2,

    k_EStoveOverlayMode_Max = 0x7fffffff
}

Enum Values

Example

using static Stove.PCSDK.V3.Base;

void OnVietnamAgeRatingNotificationCallback(IStoveCallbackResult callbackResult, IStoveVietnamAgeRatingInfo ageRatingInfo)
{
    if (ageRatingInfo.OverlayMode == (int)EStoveOverlayMode.k_EStoveOverlayMode_Show)
    {
        // Please implement the logic to display the overlay.
    }
}

Notes

• k_EStoveOverlayMode_Expanded is a value used exclusively in the Vietnam Excessive Use Prevention Notice (IStoveVietnamOverimmersionInfo).
• Since the OverlayMode property is of type int, it is cast to (int)EStoveOverlayMode.k_... when compared with this enumeration value.
• In the previous version, the value names did not have underscores (k_EStoveOverlayModeInvalid). In the current source, as shown in k_EStoveOverlayMode_Invalid, an underscore is inserted between the enum name and the value name.

Changelog

See Also

• IStoveVietnamAgeRatingInfo
• IStoveVietnamOverimmersionInfo

EStovePCBangMethodCode

Kind Enum · Module PCBang · Version 3.5.0

Description

This value identifies the API of the PC Bang feature that created IStoveResult. It can be queried as IStoveResult.MethodCode and is used in log entries or error-handling branches.

The integer range used by this enumeration is 3000 to 3999, and values are assigned sequentially according to the public API order.

Declaration

public enum EStovePCBangMethodCode
{
    k_EStovePCBangMethodCode_Invalid = -1,
    k_EStovePCBangMethodCode_Login = 3000,
    k_EStovePCBangMethodCode_Logout = 3001,
    k_EStovePCBangMethodCode_CheckStatus = 3002,
    k_EStovePCBangMethodCode_RefreshBenefit = 3003,
    k_EStovePCBangMethodCode_Max = 0x7fffffff
}

Enum Values

Example

using static Stove.PCSDK.V3.PCBang;

void OnRefreshPCBangBenefitCallback(IStoveCallbackResult callbackResult, IStovePCBangBenefitInfo benefitInfo)
{
    uint methodCode = callbackResult.Result.MethodCode; // k_EStovePCBangMethodCode_RefreshBenefit
}

Notes

• k_EStovePCBangMethodCode_Login and k_EStovePCBangMethodCode_RefreshBenefit both result from a single call to Stove_PCBangLogin, but they are separate pieces of code corresponding to different callbacks (onUserLogin / onRefreshBenefit). onRefreshBenefit is called repeatedly every 4 minutes and is triggered regardless of whether the service is paid or free.
• The CheckUserStatus API from the previous interface has been renamed to Stove_PCBangCheckStatus.
• This enumeration does not have any result codes. The cause of failure is identified as IStoveResult.ResultCode, and the values are defined in EStoveResultCode (module-specific) or EStoveCommonResultCode (common). There is no result code enumeration specific to the PC Bang function.

See Also

• Stove_PCBangLogin
• Stove_PCBangLogout
• Stove_PCBangCheckStatus

EStovePCBangPremium

Kind Enum · Module PCBang · Version 3.5.0

Description

This value indicates the premium (paid) subscription status of the logged-in user, PC Bang. IStovePCBangLoginOutcome.PremiumCheck, IStovePCBangBenefitInfo.PremiumCheck, and IStovePCBangStatus.PremiumCheck return this value.

This enumeration does not include separate codes for determining success or failure. k_EStovePCBangPremium_Error indicates a server error or an unrecognizable condition, while the success of the call itself is determined separately using IStoveCallbackResult.Result.IsSuccessful.

Declaration

public enum EStovePCBangPremium
{
    k_EStovePCBangPremium_Error = -1,
    k_EStovePCBangPremium_Premium = 1,
    k_EStovePCBangPremium_Free = 2,
    k_EStovePCBangPremium_FreeOther = 3,
    k_EStovePCBangPremium_Max = 0x7fffffff
}

Enum Values

Example

using static Stove.PCSDK.V3.PCBang;

void OnPCBangLoginCallback(IStoveCallbackResult callbackResult, IStovePCBangLoginOutcome loginOutcome)
{
    if (callbackResult.Result.IsSuccessful)
    {
        if (loginOutcome.PremiumCheck == EStovePCBangPremium.k_EStovePCBangPremium_Premium)
        {
            // Please implement the logic for premium benefits.
        }
    }
}

Notes

• This value is returned by all three structures: IStovePCBangLoginOutcome, IStovePCBangBenefitInfo, and IStovePCBangStatus.
• The benefit renewal callback (onRefreshBenefit) is called every 4 minutes and is triggered not only when the status is k_EStovePCBangPremium_Premium (paid) but also when it is k_EStovePCBangPremium_Free (free).

See Also

• IStovePCBangLoginOutcome
• IStovePCBangBenefitInfo
• IStovePCBangStatus

EStovePCBangTypeKind

Kind Enum · Module PCBang · Version 3.5.0

Description

This value identifies each concrete type in the result/data structures passed to the asynchronous callback of the PC Bang function. Since the callback in the C# interface already passes data using structures such as concrete type (IStovePCBangLoginOutcome, etc.), no separate accessor is provided to retrieve this value.

The integer range used by this enumeration is 3000 to 3999.

Declaration

public enum EStovePCBangTypeKind
{
    k_EStovePCBangTypeKind_Invalid = -1,
    k_EStovePCBangTypeKind_StovePCBangLoginOutcome = 3000,
    k_EStovePCBangTypeKind_StovePCBangBenefitInfo = 3001,
    k_EStovePCBangTypeKind_StovePCBangStatus = 3002,
    k_EStovePCBangTypeKind_Max = 0x7fffffff
}

Enum Values

Example

// C# interfaces do not create each struct (such as IStovePCBangLoginOutcome) directly, but rather
// Since the SDK returns this as a callback, do not use this enumeration value directly in API calls.

Notes

• All values included in this enumeration are result/data types returned by the PC Bang function via a callback; there are no input parameter types defined by the caller (the PC Bang function provides only parameterless APIs).
• The range 3000–3999 is reserved exclusively for PCBang, so it does not overlap with the TypeKind values of other modules.

See Also

• IStovePCBangLoginOutcome
• IStovePCBangBenefitInfo
• IStovePCBangStatus

EStoveProductTypeCode

Kind Enum · Module IAP · Version 3.5.0

Description

This is the value returned as IStoveProduct.ProductTypeCode. It indicates the type of product.

Declaration

public enum EStoveProductTypeCode
{
    k_EStoveProductTypeCode_None = 0,
    k_EStoveProductTypeCode_IndiePackageGameItem = 1,
    k_EStoveProductTypeCode_InGameItem = 2,
    k_EStoveProductTypeCode_PackageItem = 3,

    k_EStoveProductTypeCode_Max = 0x7fffffff
}

Enum Values

Example

if (product.ProductTypeCode == EStoveProductTypeCode.k_EStoveProductTypeCode_InGameItem)
{
    // Please implement the logic for in-game items.
}

Notes

• This is used to distinguish the types of each product retrieved using Stove_FetchProducts.

See Also

• Stove_FetchProducts
• IStoveProduct

EStovePurchaseLimitTypeCode

Kind Enum · Module IAP · Version 3.5.0

Description

This is the value returned as IStoveProduct.PurchaseLimitTypeCode. It indicates whether the purchase limit applies per account, per character, or if there is no limit.

Declaration

public enum EStovePurchaseLimitTypeCode
{
    k_EStovePurchaseLimitTypeCode_None = 0,
    k_EStovePurchaseLimitTypeCode_Unlimited = 1,
    k_EStovePurchaseLimitTypeCode_Member = 2,
    k_EStovePurchaseLimitTypeCode_Character = 3,

    k_EStovePurchaseLimitTypeCode_Max = 0x7fffffff
}

Enum Values

Example

if (product.PurchaseLimitTypeCode == EStovePurchaseLimitTypeCode.k_EStovePurchaseLimitTypeCode_Member)
{
    // Please implement logic to check the account-level purchase limit using `product.PurchaseLimitCount`.
}

Notes

• If Member, use the value IStoveProduct.MemberQuantity; if Character, use the value IStoveProduct.GuidQuantity to calculate the remaining number of purchases available.

See Also

• Stove_FetchProducts
• IStoveProduct

EStovePurchaseOperation

Kind Enum · Module IAP · Version 3.5.0

Description

Set it to IStovePurchaseParam.Operation, and Stove_StartPurchase determines how the payment page opens and who processes the purchase confirmation.

Declaration

public enum EStovePurchaseOperation
{
    k_EStovePurchaseOperation_Default = 0,
    k_EStovePurchaseOperation_WithWebView = 1,
    k_EStovePurchaseOperation_WithWebViewAndConfirmResult = 2,

    k_EStovePurchaseOperation_Max = 0x7fffffff
}

Enum Values

Example

var purchaseParam = new IStovePurchaseParam
{
    Operation = EStovePurchaseOperation.k_EStovePurchaseOperation_WithWebViewAndConfirmResult
};

Notes

• The fields related to WebView* (position, size, and display mode) apply only when Operation != Default is true.
• Depending on the value of Operation, the fields that are populated in the callback result (IStoveStartPurchaseOutcome) of Stove_StartPurchase will vary.

See Also

• Stove_StartPurchase
• Stove_ConfirmPurchase
• IStoveStartPurchaseOutcome
• EStovePurchaseProgress

EStovePurchaseProgress

Kind Enum · Module IAP · Version 3.5.0

Description

This is the value returned as IStoveStartPurchaseOutcome.PurchaseProgress. After receiving the Stove_StartPurchase result, the caller uses it to determine whether to open the payment window directly.

Declaration

public enum EStovePurchaseProgress
{
    k_EStovePurchaseProgress_None = 0,
    k_EStovePurchaseProgress_NeedPaymentWindow = 1,
    k_EStovePurchaseProgress_NotNeedPaymentWindow = 2,

    k_EStovePurchaseProgress_Max = 0x7fffffff
}

Enum Values

Example

if (outcome.PurchaseProgress == EStovePurchaseProgress.k_EStovePurchaseProgress_NeedPaymentWindow)
{
    string url = outcome.TempPaymentUrl;
    // Please open the payment window using this URL.
}

Notes

• If you start a purchase with k_EStovePurchaseOperation_Default, NeedPaymentWindow is typically returned.

See Also

• Stove_StartPurchase
• IStoveStartPurchaseOutcome
• EStovePurchaseOperation

EStoveResultCode

Kind Result Code · Module Base · Version 3.5.0

Description

In the global result code dictionary, these are module-specific result codes grouped by range based on the hundreds place (category). Look them up using IStoveResult.ResultCode. 3xx refers to Base (language/GDS/launcher/token/IPC), 4xx refers to WebView/pop-up UI (currently absorbed into EStoveCommonResultCode 60–68, so there are no values in this enumeration), and 5xx refers to IAP order/payment information (only 503 remains).

In a single binary structure, it makes no sense to keep the result codes separate by module, so we have consolidated the code used with the same meaning across multiple modules into this single enumeration. You can identify which module generated a result using MethodCode (module block = code / 1000). For module-specific result codes (0–299), refer to EStoveCommonResultCode.

The previous version of EStoveBaseResultCode (numbers 80–89) has been deleted. Codes with the same meaning have been moved to this enumeration (number 300).

Declaration

public enum EStoveResultCode
{
    k_EStoveResultCode_LanguageNotSet = 300,
    k_EStoveResultCode_EmptyTranslatedString = 301,
    // ... See the table of enumerated values below
    k_EStoveResultCode_InvalidOrderProductInformation = 503,

    k_EStoveResultCode_Max = 0x7fffffff
}

Enum Values

3xx — Base Language/GDS/Launcher/Token/IPC

4xx — Web View/Pop-up UI (Reserved, no current value)

5xx — IAP Order/Payment Information

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

• 304 k_EStoveResultCode_NeedStoveLauncher — You will need to restart the game after it closes.
• 307 k_EStoveResultCode_IpcConnectFailed — You will need to restart the game after it closes.
• 308 k_EStoveResultCode_IpcAesKeyNotReceived — You must restart the game after it ends
• 309 k_EStoveResultCode_IpcTimeout — You'll need to restart the game after it ends

Example

using static Stove.PCSDK.V3.Base;

IStoveResult result = Stove_SetLanguageEx("ko");

if (result.ResultCode == (uint)EStoveResultCode.k_EStoveResultCode_LanguageNotSet)
{
    // Please implement the logic to handle the "Language Not Set" error.
}

Notes

• This is the code resulting from the reorganization by module-specific range (hundreds place). Currently, the only publicly available values are Base (3xx) and IAP (503); the remaining values in the 4xx and 5xx ranges have been absorbed into EStoveCommonResultCode.
• The previous version of EStoveBaseResultCode (numbers 80–89, Base-only) has been removed, and the corresponding code has been moved to the 300s range of this enumeration. Developers who were referencing the old documentation should migrate to this enumeration.
• Since IStoveResult.ResultCode is of type uint, it is cast to (uint)EStoveResultCode.k_... when compared with this enumeration value.

Changelog

See Also

• EStoveCommonResultCode
• IStoveResult

EStoveTermsOperation

Kind Enum · Module IAP · Version 3.5.0

Description

Set this to IStoveFetchTermsAgreementParam.Operation; this determines how Stove_FetchTermsAgreement displays the Terms of Service page when the user has not yet agreed to the terms.

Declaration

public enum EStoveTermsOperation
{
    k_EStoveTermsOperation_Default = 0,
    k_EStoveTermsOperation_WithWebView = 1,

    k_EStoveTermsOperation_Max = 0x7fffffff
}

Enum Values

Example

var termsParam = new IStoveFetchTermsAgreementParam
{
    Operation = EStoveTermsOperation.k_EStoveTermsOperation_WithWebView
};

Notes

• The fields related to WebView* (position, size, display mode) apply only when Operation != Default is true.

See Also

• Stove_FetchTermsAgreement
• IStoveFetchTermsAgreementParam
• IStoveTermsAgreementOutcome

EStoveViewMethodCode

Kind Enum · Module View · Version 3.5.0

Description

This is a value that identifies the pop-up API that generated IStoveResult. It can be retrieved as IStoveResult.MethodCode and is used in logging or error-handling logic.

The integer range used by this enumeration is 1000 to 1999; the Popup API uses numbers in the 1000 range, and the Popup Management and Utility API uses the numbers that follow in sequence.

Declaration

public enum EStoveViewMethodCode
{
    k_EStoveViewMethodCode_Invalid = -1,
    k_EStoveViewMethodCode_AutoPopup = 1000,
    // ... See the table of enumerated values below
    k_EStoveViewMethodCode_Max = 0x7fffffff
}

Enum Values

Example

using static Stove.PCSDK.V3.View;

void OnViewPopupCallback(IStoveCallbackResult callbackResult)
{
    uint methodCode = callbackResult.Result.MethodCode; // k_EStoveViewMethodCode_AutoPopup, etc.
}

Notes

• The module-specific result code enumeration EStoveViewResultCode from the previous interface has been removed. The cause of failure is identified as IStoveResult.ResultCode, and the values are defined in the module-specific EStoveResultCode or the common EStoveCommonResultCode.
• Since Stove_CloseAllPopups(), which closes all popups, is a function belonging to Base, it has the MethodCode value of Base rather than this enumeration.
• Value numbers are organized into blocks by module, so they do not overlap with the MethodCode of other modules. You can also use IStoveResult.SDKName to determine which module produced the result.
• Even for the same pop-up, the values differ from those in the old interface. The old interface (View_AutoPopup, etc.) returns 81, 83, 85, 87, 91, and 160, while the new interface returns the value in the 1000 range of this enumeration. While using both sets simultaneously, please keep the log aggregation criteria separate for each set.

See Also

• Stove_AutoPopup
• Stove_ManualPopup
• Stove_NewsPopup
• Stove_CouponPopup
• Stove_VerifyIdentificationPopup
• Stove_SetPopupDisallowed

EStoveViewTypeKind

Kind Enum · Module View · Version 3.5.0

Description

These are the values that identify each of the concrete type parameter structures and callback passage structures handled by the popup feature. Although the C# API does not handle these values directly—instead, it creates and passes the structures as-is—understanding the range and mapping of these values can be helpful for logging and debugging.

The integer range used by this enumeration is 1000 to 1999. Its numbers do not overlap with those of other modules' TypeKind values.

Declaration

public enum EStoveViewTypeKind
{
    k_EStoveViewTypeKind_Invalid = -1,
    k_EStoveViewTypeKind_SetPopupDisallowedParam = 1500,
    // ... See the table of enumerated values below
    k_EStoveViewTypeKind_Max = 0x7fffffff
}

Enum Values

Example

// The C# interface creates and uses each struct (such as IStovePopupParam) directly, and
// Do not pass this enumeration value directly to an API call.
var popupParam = new IStovePopupParam
{
    WebViewMode = EStoveWebViewMode.k_EStoveWebViewMode_Internal
};

Notes

• 1500–1503 correspond to the parameter structures created by the caller and passed to the API, while 1504 corresponds to the structure returned by the SDK as a callback.
• The type used for the View popup parameter varies by API. Stove_AutoPopup/Stove_NewsPopup/Stove_CouponPopup use IStovePopupParam, Stove_ManualPopup uses IStoveManualPopupParam, and Stove_VerifyIdentificationPopup uses IStoveVerifyIdentificationPopupParam.

See Also

• IStoveSetPopupDisallowedParam
• IStovePopupParam
• IStoveManualPopupParam
• IStoveVerifyIdentificationPopupParam

EStoveWebViewMode

Kind Enum · Module Base · Version 3.5.0

Description

This setting in the View SDK and IAP SDK determines whether a web view opens as an external pop-up (the system's default browser) or an internal pop-up (the SDK's built-in web view).

Declaration

public enum EStoveWebViewMode
{
    k_EStoveWebViewMode_Invalid = -1,

    k_EStoveWebViewMode_External = 0,
    k_EStoveWebViewMode_Internal = 1,

    k_EStoveWebViewMode_Max = 0x7fffffff
}

Enum Values

Example

EStoveWebViewMode webViewMode = EStoveWebViewMode.k_EStoveWebViewMode_Internal;

Notes

• This value is used to specify how pop-ups are displayed in the payment feature. There is no function in the SDK's own API that directly accepts this value.
• In the previous version, there was no underscore in the value name (k_EStoveWebViewModeInvalid). In the current source, an underscore is inserted between the enumeration name and the value name, as in k_EStoveWebViewMode_Invalid.

Changelog

See Also

• None

IStoveAccessToken

Kind Struct · Module Base · Version 3.5.0

Description

This is the token structure of the callback passed when Stove_AccessTokenRenewed() is registered.

Contains the AccessToken value and its remaining validity time. Since it is readonly struct (value type), the garbage collector handles it, so there is no need to release it separately.

Declaration

public readonly struct IStoveAccessToken
{
    public string AccessToken { get; }
    public int ExpireIn { get; }
}

Members

Example

using static Stove.PCSDK.V3.Base;

void OnAccessTokenRenewedCallback(IStoveCallbackResult callbackResult, IStoveAccessToken token)
{
    if (callbackResult.Result.IsSuccessful)
    {
        string accessToken = token.AccessToken;
        int expireIn = token.ExpireIn;
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Stove_AccessTokenRenewed(OnAccessTokenRenewedCallback);

Notes

• After registering Stove_AccessTokenRenewed(), this callback is called whenever the AccessToken is automatically renewed within the SDK.
• In the previous version, this type was named IStoveToken. In the current source (BaseTypesV2.cs), IStoveToken does not exist and is defined only as IStoveAccessToken.

See Also

• Stove_AccessTokenRenewed
• Stove_GetAccessToken
• IStoveCallbackResult

IStoveCallbackResult

Kind Struct · Module Base · Version 3.5.0

Description

This is the result passed to the asynchronous callback. It wraps IStoveResult and contains both the detailed error message and the external error value.

It is passed as the first callback argument to callback-based asynchronous APIs such as Stove_AccessTokenRenewed() and Stove_OverImmersionNotification(). Since readonly struct is a value type, it is handled by the garbage collector and does not need to be manually released.

The values passed along with Result are valid only at the time the callback is invoked.

Declaration

public readonly struct IStoveCallbackResult
{
    public IStoveResult Result { get; }
    public string ErrorMessage { get; }
    public int ExternalError { get; }
}

Members

Example

using static Stove.PCSDK.V3.Base;

void OnAccessTokenRenewedCallback(IStoveCallbackResult callbackResult, IStoveAccessToken token)
{
    if (callbackResult.Result.IsSuccessful)
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Stove_AccessTokenRenewed(OnAccessTokenRenewedCallback);

Notes

• It is passed as the first argument to all SDK asynchronous callbacks (OnAccessTokenRenewedCallback, OnOverImmersionNotificationCallback, etc.).
• The callback runs in the thread that called Stove_RunCallback().
• In the new flat C interface, IStoveCallbackResult contains a field that returns the userData(void*) passed at the time of the call, but the C# version does not have a corresponding field. Since the C# callback uses a delegate to capture the context as a closure, a separate userData pointer is not required.
• WithManagedExceptionMsgAndCode() is an internal helper method used by the C# wrapper to convert exceptions that occur during callback marshaling and other operations into the MANAGED_EXCEPTION (254) result. Game code will rarely need to call this method directly.

See Also

• Stove_RunCallback
• IStoveResult

IStoveChargeInfo

Kind Struct · Module IAP · Version 3.5.0

Description

Represents a single payment method (Stove Cash, Points, PG, etc.) used for a single purchase. It is passed as an array containing both ChargeInfos from IStoveConfirmPurchaseOutcome (the result of Stove_ConfirmPurchase) and ChargeInfos from IStoveStartPurchaseOutcome (the result of Stove_StartPurchase).

This is a read-only struct (readonly struct) that the SDK populates with values and passes to the callback. The caller does not create it directly. Since it is a value type, the values can be copied and retained for use even after the callback has finished, and there is no need to free them separately.

Declaration

public readonly struct IStoveChargeInfo
{
    public double ChargeDeductVal { get; }
    public double ChargeDisplayDeductVal { get; }
    public int ChargeType { get; }
    public string ChargeTypeName { get; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

void OnConfirmPurchaseCallback(IStoveCallbackResult callbackResult, IStoveConfirmPurchaseOutcome outcome)
{
    if (callbackResult.Result.IsSuccessful && outcome.IsConfirmed)
    {
        foreach (var chargeInfo in outcome.ChargeInfos)
        {
            double deductVal = chargeInfo.ChargeDeductVal;
            string typeName = chargeInfo.ChargeTypeName;

            // Please configure the receipt screen using only the necessary values.
        }
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Notes

• It is passed from both ChargeInfos of IStoveConfirmPurchaseOutcome and ChargeInfos of IStoveStartPurchaseOutcome.
• If multiple payment methods are used in a single purchase, the items are organized into an array, separated by payment method.

See Also

• Stove_ConfirmPurchase
• IStoveConfirmPurchaseOutcome
• IStoveStartPurchaseOutcome
• IStovePurchasedProduct

IStoveConfirmPurchaseOutcome

Kind Struct · Module IAP · Version 3.5.0

Description

The result of the Stove_ConfirmPurchase call is passed to the OnConfirmPurchaseCallback callback.

This is a read-only struct (readonly struct) that the SDK populates with values and passes to the callback. The caller does not create it directly. Since it is a value type, the values can be copied and retained for use even after the callback has finished, and there is no need to free them separately.

Declaration

public readonly struct IStoveConfirmPurchaseOutcome
{
    public bool IsConfirmed { get; }
    public IStovePurchasedProduct[] PurchasedProducts { get; }
    public IStoveChargeInfo[] ChargeInfos { get; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

void OnConfirmPurchaseCallback(IStoveCallbackResult callbackResult, IStoveConfirmPurchaseOutcome outcome)
{
    if (callbackResult.Result.IsSuccessful && outcome.IsConfirmed)
    {
        foreach (var product in outcome.PurchasedProducts)
        {
            // Please deliver the purchased items.
        }
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Notes

• It is passed only as the output of Stove_ConfirmPurchase.
• If IsConfirmed is false, then PurchasedProducts / ChargeInfos may be empty.

See Also

• Stove_ConfirmPurchase
• Stove_StartPurchase
• IStoveStartPurchaseOutcome

IStoveConfirmPurchaseParam

Kind Struct · Module IAP · Version 3.5.0

Description

This is the input parameter passed when calling Stove_ConfirmPurchase. It is used to confirm the purchase with the transaction master number received from IStoveStartPurchaseOutcome.

This is a standard C# struct (struct) that does not use a constructor. The game code creates it directly in the form of new IStoveConfirmPurchaseParam { ... }, populates it with values, and then passes it to the call. Since it is a value type, it does not need to be explicitly released.

Declaration

public struct IStoveConfirmPurchaseParam
{
    public long TxnMasterNo { get; set; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

var confirmParam = new IStoveConfirmPurchaseParam
{
    TxnMasterNo = txnMasterNo
};

Stove_ConfirmPurchase(confirmParam, OnConfirmPurchaseCallback);

Notes

• For TxnMasterNo, please use the TxnMasterNo value from IStoveStartPurchaseOutcome, which is the result of Stove_StartPurchase, as is.
• Purchases that begin with Operation == Default or WithWebView must be finalized using this API after completing the payment in the payment window.

See Also

• Stove_ConfirmPurchase
• Stove_StartPurchase
• IStoveStartPurchaseOutcome

IStoveFetchProductsParam

Kind Struct · Module IAP · Version 3.5.0

Description

These are the input parameters passed when calling Stove_FetchProducts. They specify the category and page range to query.

This is a standard C# struct (struct) that does not use a constructor. The game code directly creates it in the form of new IStoveFetchProductsParam { ... }, populates it with values, and then passes it to the call. Since it is a value type, there is no need to explicitly free it.

Declaration

public struct IStoveFetchProductsParam
{
    public string CategoryId { get; set; }
    public uint PageIndex { get; set; }
    public uint PageSize { get; set; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

var fetchProductsParam = new IStoveFetchProductsParam
{
    CategoryId = "",
    PageIndex = 1,
    PageSize = 20
};

Stove_FetchProducts(fetchProductsParam, OnFetchProductsCallback);

Notes

• CategoryId passes the value obtained from IStoveShopCategory.CategoryId.

See Also

• Stove_FetchProducts
• IStoveShopCategory
• IStoveProduct

IStoveFetchTermsAgreementParam

Kind Struct · Module IAP · Version 3.5.0

Description

These are the input parameters passed when calling Stove_FetchTermsAgreement. The WebView* field applies only when Operation is not Default.

This is a standard C# struct (struct) that does not use a constructor. The game code creates it directly in the form of new IStoveFetchTermsAgreementParam { ... }, fills it with values, and then passes it to the call. Since it is a value type, there is no need to explicitly free it.

Declaration

public struct IStoveFetchTermsAgreementParam
{
    public EStoveTermsOperation Operation { get; set; }
    public EStoveWebViewMode WebViewMode { get; set; }
    public int WebViewPosX { get; set; }
    public int WebViewPosY { get; set; }
    public int WebViewWidth { get; set; }
    public int WebViewHeight { get; set; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

var termsParam = new IStoveFetchTermsAgreementParam
{
    Operation = EStoveTermsOperation.k_EStoveTermsOperation_WithWebView
};

Stove_FetchTermsAgreement(termsParam, OnFetchTermsAgreementCallback, null);

Notes

• Operation If this is Default, the WebView* field is ignored.

See Also

• Stove_FetchTermsAgreement
• IStoveTermsAgreementOutcome
• EStoveTermsOperation

IStoveGds

Kind Struct · Module Base · Version 3.5.0

Description

This is the structure for country, regulation, time zone, and language information passed as the ref parameter when making a Stove_GetGds() call.

The country code based on the logged-in user's IP address is provided by default; if the country cannot be determined from the IP address, it is replaced with the default country code (separated by IsDefault). Since it is readonly struct (value type), it is handled by GC and does not need to be manually cleared.

Declaration

public readonly struct IStoveGds
{
    public bool IsDefault { get; }
    public string Nation { get; }
    public string Regulation { get; }
    public string Timezone { get; }
    public int UtcOffset { get; }
    public string Lang { get; }
}

Members

Example

using static Stove.PCSDK.V3.Base;

IStoveGds gds = default;
IStoveResult result = Stove_GetGds(ref gds);

if (result.IsSuccessful)
{
    string nation = gds.Nation;
    string timezone = gds.Timezone;
    // Please implement the logic for a successful outcome.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• You must call this after initialization with Stove_Initialize() to receive a valid value.
• Stove_GetGds(ref IStoveGds gds) returns a value via the ref parameter, and the return value is IStoveResult.

See Also

• Stove_GetGds
• IStoveUser
• IStoveSignin

IStoveInitializeParam

Kind Struct · Module Base · Version 3.5.0

Description

Stove_Initialize(IStoveInitializeParam) These are the parameters used to call the Overload. It has only two fields, ShopKey and MainWndHandle, and exists to initialize both the View and IAP modules simultaneously with the SDK initialization following a single binary integration.

It is a general struct (value type), and each field is exposed as a get/set property. Unlike the new flat C interface, the game code creates it directly in new IStoveInitializeParam { ... } format without a constructor and populates its values.

MainWndHandle If this value is not 0, the View module is initialized; if ShopKey is not empty and MainWndHandle is not 0, the IAP module is also initialized (both conditions must be met for the IAP module to be initialized). MainWndHandle is a valid value only after the game’s main window has actually been created.

Declaration

public struct IStoveInitializeParam
{
    public string ShopKey { get; set; }
    public IntPtr MainWndHandle { get; set; }
}

Members

Example

using static Stove.PCSDK.V3.Base;

IStoveInitializeParam initParam = new IStoveInitializeParam
{
    ShopKey = "YOUR_SHOP_KEY",
    MainWndHandle = hWnd,
};

IStoveResult result = Stove_Initialize(initParam);

if (result.IsSuccessful)
{
    // Please implement the logic for the success case.
}
else
{
    // Please implement the logic for when an error occurs.
}

Notes

• In the previous version, the Environment / GameId / AppKey fields were included in this structure. In the current source (BaseTypesV2.cs), these three fields have been removed and moved to IStoveRestartAppIfNecessaryParam. The SDK reuses the value cached in Stove_RestartAppIfNecessary() in Stove_Initialize().
• The parameterless Stove_Initialize() overload initializes only the SDK; it does not initialize View or IAP.
• Although the new flat C interface must be created using Stove_CreateParam(k_EStoveBaseTypeKind_InitializeParam) and released using Destroy(), in C# this structure is created and initialized directly as a value type, without calling the creation or release functions.

See Also

• Stove_Initialize
• Stove_RestartAppIfNecessary
• IStoveRestartAppIfNecessaryParam

IStoveInventoryItem

Kind Struct · Module IAP · Version 3.5.0

Description

Represents a single entry in the user's purchase history. It is passed to the OnFetchInventoryCallback callback as IStoveInventoryList as a result of the Stove_FetchInventory call.

This is a read-only struct (readonly struct) that the SDK populates with values and passes to the callback. The caller does not create it directly. Since it is a value type, the values can be copied and retained for use even after the callback has finished, and there is no need to free them separately.

Declaration

public readonly struct IStoveInventoryItem
{
    public long TxnMasterNo { get; }
    public long TxnDetailNo { get; }
    public long ProductId { get; }
    public string InserviceItemId { get; }
    public string ProductName { get; }
    public int Quantity { get; }
    public string ThumbnailUrl { get; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

void OnFetchInventoryCallback(IStoveCallbackResult callbackResult, IStoveInventoryList list)
{
    if (callbackResult.Result.IsSuccessful)
    {
        foreach (var item in list)
        {
            long productId = item.ProductId;
            int quantity = item.Quantity;

            // Please build the screen using only the necessary values.
        }
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Notes

• It is passed only as the output of Stove_FetchInventory.
• When verifying whether game items have been awarded, you must prevent duplicate processing based on TxnDetailNo.

See Also

• Stove_FetchInventory
• IStoveInventoryList
• IStoveProduct

IStoveInventoryList

Kind Struct · Module IAP · Version 3.5.0

Description

This is a list wrapper IStoveInventoryItem that is passed to the OnFetchInventoryCallback callback as a result of the Stove_FetchInventory call. You can implement IReadOnlyList<IStoveInventoryItem> to iterate through foreach.

This is a read-only structure (readonly struct) owned by the SDK, and it is valid only while the callback is running. It is not created directly by the caller. To preserve it outside the callback, you must copy the item's value.

Since it is a readonly struct (value type), the garbage collector handles it, so there is no need to manually free it.

Declaration

public readonly struct IStoveInventoryList : IReadOnlyList<IStoveInventoryItem>
{
    // Please refer to the member list below for the members.
}

Members

Example

using static Stove.PCSDK.V3.IAP;

void OnFetchInventoryCallback(IStoveCallbackResult callbackResult, IStoveInventoryList list)
{
    if (callbackResult.Result.IsSuccessful)
    {
        foreach (var item in list)
        {
            long productId = item.ProductId;
            // Please build the screen using only the necessary values.
        }
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Notes

• It is passed only as the output of Stove_FetchInventory.
• Since the callback is invalidated once it ends, you must copy any values you need to continue using outside the callback in advance.
• Using an unboxed enumerator (StoveReadOnlyArrayEnumerator<T>) prevents heap allocation even when foreach is used.

See Also

• Stove_FetchInventory
• IStoveInventoryItem

IStoveManualPopupParam

Kind Struct · Module View · Version 3.5.0

Description

These are the parameters passed when calling Stove_ManualPopup. They specify the WebView display mode and the resource key used to select the popup content to be displayed.

The caller creates it and passes it as a value to the API. There is no need to explicitly release it (since it is a value type).

Declaration

public struct IStoveManualPopupParam
{
    public EStoveWebViewMode WebViewMode { get; set; }
    public string ResourceKey { get; set; }
}

Members

Example

using static Stove.PCSDK.V3.View;

void OnViewPopupCallback(IStoveCallbackResult callbackResult)
{
    if (callbackResult.Result.IsSuccessful)
    {
        // Please implement the logic for a successful outcome.
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

void OnViewPopupDestroyCallback(IStoveCallbackResult callbackResult)
{
    // This is called when the popup's native resources are released.
}

var manualPopupParam = new IStoveManualPopupParam
{
    WebViewMode = EStoveWebViewMode.k_EStoveWebViewMode_Internal,
    ResourceKey = "YOUR_RESOURCE_KEY"
};
Stove_ManualPopup(manualPopupParam, OnViewPopupCallback, OnViewPopupDestroyCallback);

Notes

• The Auto/News/Coupon pop-up uses IStovePopupParam instead of this type (no ResourceKey).

See Also

• Stove_ManualPopup
• IStovePopupParam

IStoveOrderProductParam

Kind Struct · Module IAP · Version 3.5.0

Description

These are the order items for each product, stored in an array of size IStoveStartPurchaseParam with Products elements. One item is created for each product to be purchased and passed as an array.

This is a standard C# struct (struct) that does not use a constructor. The game code creates it directly in the form of new IStoveOrderProductParam { ... }, populates it with values, and then uses it. Since it is a value type, there is no need to explicitly free it.

Declaration

public struct IStoveOrderProductParam
{
    public long ProductId { get; set; }
    public double SalePrice { get; set; }
    public int Quantity { get; set; }
}

Members

Example

using static Stove.PCSDK.V3.IAP;

var orderProduct = new IStoveOrderProductParam
{
    ProductId = productId,
    SalePrice = salePrice,
    Quantity = 1
};

var startPurchaseParam = new IStoveStartPurchaseParam
{
    Products = new[] { orderProduct },
    // Please refer to the IStoveStartPurchaseParam documentation for information on how to populate the remaining fields, such as PurchaseParam.
};

Stove_StartPurchase(startPurchaseParam, OnStartPurchaseCallback, null);

Notes

• For SalePrice, please use the same SalePrice value as IStoveProduct. If the values differ, the server may treat this as a price discrepancy.

See Also

• Stove_StartPurchase
• IStoveStartPurchaseParam
• IStoveProduct

IStoveOverImmersionInfo

Kind Struct · Module Base · Version 3.5.0

Description

Stove_OverImmersionNotification() is the structure for the anti-excessive-use notification passed via callback. This API is available exclusively in South Korea.

It contains warning messages, cumulative game playtime, and message display time. Since it is readonly struct (value type), it is handled by the garbage collector and does not need to be manually released.

Declaration

public readonly struct IStoveOverImmersionInfo
{
    public string Msg { get; }
    public int ElapsedHours { get; }
    public int ExposureTime { get; }
}

Members

Example

using static Stove.PCSDK.V3.Base;

void OnOverImmersionNotificationCallback(IStoveCallbackResult callbackResult, IStoveOverImmersionInfo overImmersion)
{
    if (callbackResult.Result.IsSuccessful)
    {
        string msg = overImmersion.Msg;
        int exposureTime = overImmersion.ExposureTime;
        // Please implement the logic for the success case. (Display `msg` for `exposureTime` seconds.)
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

Stove_OverImmersionNotification(OnOverImmersionNotificationCallback);

Notes

• This API is for use in Korea only and must be called after rendering is complete.
• ElapsedHours is the unit of time (hour). Be careful not to confuse it with IStoveVietnamOverimmersionInfo.ElapsedMinutes, which are units of minutes.
• In the previous version, this type was named IStoveOverImmersion and the time field was named ElapsedTime. In the current source (BaseTypesV2.cs), the type name has been changed to IStoveOverImmersionInfo and the field name to ElapsedHours.

See Also

• Stove_OverImmersionNotification
• IStoveShutdownInfo
• IStoveVietnamOverimmersionInfo

IStovePCBangBenefitInfo

Kind Struct · Module PCBang · Version 3.5.0

Description

This is the updated benefits information that is periodically sent to the onRefreshBenefit callback after a successful login by Stove_PCBangLogin.

This is a value generated by the SDK and passed to the callback. The caller does not create it directly. Since it is a managed value, it can be retained and used even after the callback has finished.

It is called repeatedly every 4 minutes. Since this is not a one-time callback, you must implement the callback with the understanding that it will run every 4 minutes after registration.

Declaration

public readonly struct IStovePCBangBenefitInfo
{
    public EStovePCBangPremium PremiumCheck { get; }
    public int RemainTime { get; }
}

Members

Example

using static Stove.PCSDK.V3.PCBang;

void OnPCBangLoginCallback(IStoveCallbackResult callbackResult, IStovePCBangLoginOutcome loginOutcome)
{
    // This is called once when the user logs in for the first time.
}

void OnRefreshPCBangBenefitCallback(IStoveCallbackResult callbackResult, IStovePCBangBenefitInfo benefitInfo)
{
    if (callbackResult.Result.IsSuccessful)
    {
        // Please implement the logic for a successful outcome.
        int remainTime = benefitInfo.RemainTime;
    }
    else
    {
        // Please implement the logic for when a failure occurs.
    }
}

Stove_PCBangLogin(OnPCBangLoginCallback, OnRefreshPCBangBenefitCallback);

Notes

• The old (v1) name is StovePCRefreshUserBenefits.
• This callback is called every 4 minutes and is triggered regardless of whether the account is in Premium or Free status. It is not called only when the account is in Premium status.
• Calling Stove_PCBangLogout will unregister this callback.

See Also

• IStovePCBangLoginOutcome
• EStovePCBangPremium
• Stove_PCBangLogin
• Stove_PCBangLogout

IStovePCBangLoginOutcome

Kind Struct · Module PCBang · Version 3.5.0

Description

This is the value passed to the onUserLogin callback when the first login for Stove_PCBangLogin is completed.

This is a value generated by the SDK and passed via a callback. It is not created directly by the caller.

Since it is a readonly struct (value type), it is handled by the garbage collector, so there is no need to free it separately. You can keep the value and use it even after the callback has finished.

Declaration

public readonly struct IStovePCBangLoginOutcome
{
    public EStovePCBangPremium PremiumCheck { get; }
    public int Psn { get; }
    public int RemainTime { get; }
}

Members

Example

using static Stove.PCSDK.V3.PCBang;

void OnPCBangLoginCallback(IStoveCallbackResult callbackResult, IStovePCBangLoginOutcome loginOutcome)
{
    if (callbackResult.Result.IsSuccessful)
    {
        // Please implement the logic for a successful outcome.
        int remainTime = loginOutcome.RemainTime;
    }
    else
    {
        // Please implement the logic for when an error occurs.
    }
}

void OnRefreshPCBangBenefitCallback(IStoveCallbackResult callbackResult, IStovePCBangBenefitInfo benefitInfo)
{
    // It is called repeatedly every 4 minutes.
}

Stove_PCBangLogin(OnPCBangLoginCallback, OnRefreshPCBangBenefitCallback);

Notes

• The old (v1) name is StovePCBangUserLogin.
• After the initial login, this value is replaced by IStovePCBangBenefitInfo, which is updated and returned every 4 minutes.

See Also

• IStovePCBangBenefitInfo
• EStovePCBangPremium
• Stove_PCBangLogin

IStovePCBangStatus

Kind Struct · Module PCBang · Version 3.5.0

Description

This is information about the current PC Bang status and the entitlements available to the user, which is returned as the result of the Stove_PCBangCheckStatus call.

This is a value generated by the SDK and passed via a callback. It is not created directly by the caller.

Since it is a readonly struct (value type), the garbage collector handles it, so there is no need to manually free it. You can keep the value and use it even after the callback has finished.

Declaration

public readonly struct IStovePCBangStatus
{
    public EStovePCBangPremium PremiumCheck { get; }
    public int Psn { get; }
    public int ProductCode { get; }
}