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

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

Contents

Base_AccessTokenRenewed

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

Description

Base_AccessTokenRenewed 는 액세스 토큰이 갱신될 때마다 호출될 콜백을 등록하는 함수예요. 한 번 등록해 두면 토큰이 갱신되는 시점마다 콜백이 반복 호출돼요.

onFinished 를 다시 호출하면 이전에 등록된 같은 타입의 콜백은 새 콜백으로 교체돼요.

Declaration

public static void Base_AccessTokenRenewed(OnRenewTokenFinished onFinished);

Parameters

Returns

Callback

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

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

Error Codes

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

Example

using static Stove.PCSDK.Base;

void OnRenewTokenFinished(CallbackResult callbackResult, StovePCToken token)
{
    if (callbackResult.result.IsSuccessful())
    {
        // token.accessToken 을 사용하는 로직을 구현해 주세요.
    }
}

Base_AccessTokenRenewed(OnRenewTokenFinished);

Notes

• 반복 호출되는 알림형 콜백이에요. Base_RestartAppIfNecessaryAsync 등 1회성 비동기 API 의 콜백과 성격이 달라요.

See Also

• Base_GetAccessToken
• StovePCToken

Base_GetAccessToken

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

Description

Base_GetAccessToken 은 현재 액세스 토큰을 accessToken 에 채워 돌려주는 함수예요. 초기화 후 호출해야 해요.

Declaration

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

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

if (result.IsSuccessful())
{
    // accessToken 을 사용하는 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 토큰이 갱신될 때 알림을 받으려면 Base_AccessTokenRenewed 를 사용해야 해요.
• 조회한 토큰을 게임에서 따로 보관해 두고 다시 쓰지 마세요. SDK 가 토큰을 주기적으로 갱신하므로 보관해 둔 값은 만료될 수 있어요. 토큰이 필요할 때마다 이 함수를 호출해 그때의 유효한 값을 받아 쓰세요.

See Also

• Base_AccessTokenRenewed

Base_GetGds

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

Description

Base_GetGds 는 유저의 GDS 정보를 StovePCGds 에 채워 돌려주는 함수예요. 초기화 후 호출해야 해요.

Declaration

public static Result Base_GetGds(ref StovePCGds gds);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

if (result.IsSuccessful())
{
    // gds.nation, gds.regulation 등을 사용하는 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 실패 시 gds 는 기본값(default)으로 유지돼요.

See Also

• StovePCGds

Base_GetSignin

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

Description

Base_GetSignin 은 유저의 로그인 정보를 StovePCSignin 에 채워 돌려주는 함수예요. 초기화 후 호출해야 해요.

Declaration

public static Result Base_GetSignin(ref StovePCSignin signin);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

if (result.IsSuccessful())
{
    // signin.personVerify, signin.nationality 등을 사용하는 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 실패 시 signin 은 기본값(default)으로 유지돼요.

See Also

• StovePCSignin

Base_GetTraceHint

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

Description

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

Base_GetTraceHint 는 로그 추적용 세션 힌트 정보를 StovePCTraceHint 에 채워 돌려주는 함수예요. 초기화 후 호출해야 해요.

Declaration

public static Result Base_GetTraceHint(ref StovePCTraceHint traceHint);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

if (result.IsSuccessful())
{
    // traceHint.sessionId 등을 로그에 남기는 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 실패 시 traceHint 는 기본값(default)으로 유지돼요.
• 이 함수와 StovePCTraceHint 는 향후 버전에서 제거될 예정이에요.

See Also

• StovePCTraceHint

Base_GetUser

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

Description

Base_GetUser 는 로그인한 유저 정보를 StovePCUser 에 채워 돌려주는 함수예요. 초기화 후 호출해야 해요.

Declaration

public static Result Base_GetUser(ref StovePCUser user);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

if (result.IsSuccessful())
{
    // user.nickname, user.gameUserId 를 사용하는 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 실패 시 user 는 기본값(default)으로 유지돼요.

See Also

• StovePCUser

Base_GetVersion

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

Description

Base_GetVersion 은 SDK 의 버전 문자열을 version 에 채워 돌려주는 함수예요.

Declaration

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

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

if (result.IsSuccessful())
{
    // version 을 사용하는 로직을 구현해 주세요.
}
else
{
    // 실패 시 로직을 구현해 주세요.
}

Notes

• 없음

See Also

• 없음

Base_Initialize

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

Description

Base_Initialize 는 StovePCInitializeParam 을 받아 SDK 를 초기화하는 비동기 함수예요. 결과는 onFinished 콜백으로 전달돼요.

이 함수를 호출하기 전에는 다른 SDK API 를 호출할 수 없어요. 초기화 파라미터 없이 호출하려면 Base_InitializeEx 를 사용해야 해요.

이 함수를 호출하기 전에 Base_RestartAppIfNecessary 계열 함수(Base_RestartAppIfNecessary, Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx 등)를 먼저 호출해 런처를 통해 실행되었는지 확인해야 해요. 먼저 호출하지 않으면 NEED_STOVE_LAUNCHER(84)로 실패해요.

Declaration

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

Parameters

Returns

Callback

public delegate void OnInitializeFinished(CallbackResult result);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 이 호출 1건에 대해 1회 실행돼요.

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

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

Base_Initialize(initParam, OnInitializeFinished);

// 게임 루프에서 반복 호출해 콜백을 처리해 주세요.
while (isRunning)
{
    Base_RunCallback();
}

Notes

• 콜백을 받으려면 게임 루프에서 Base_RunCallback 을 반복 호출해야 해요. 이 함수는 while(true) 형태로 별도 호출하는 것이 아니라 게임 루프 안에서 매 프레임 호출해야 해요.
• 종료 시에는 Base_UnInitialize 를 호출해야 해요.

See Also

• Base_InitializeEx
• Base_UnInitialize
• Base_RunCallback

Base_InitializeEx

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

Description

Base_InitializeEx 는 Base_Initialize 와 달리 StovePCInitializeParam 을 받지 않고 콜백만 받아요. 초기화 결과는 동일하게 onFinished 콜백으로 전달돼요.

이 함수는 Base_RestartAppIfNecessary 계열 함수(Base_RestartAppIfNecessary, Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx2 등)가 캐시한 초기화 파라미터를 재사용해요. 이 함수를 호출하기 전에 반드시 Base_RestartAppIfNecessary 계열 함수를 먼저 호출해야 하며, 먼저 호출하지 않으면 NEED_STOVE_LAUNCHER(84)로 실패해요.

Declaration

public static void Base_InitializeEx(OnInitializeFinished onFinished);

Parameters

Returns

Callback

public delegate void OnInitializeFinished(CallbackResult result);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 이 호출 1건에 대해 1회 실행돼요.

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

Base_InitializeEx(OnInitializeFinished);

Notes

• Base_Initialize 와의 시그니처 차이는 StovePCInitializeParam 매개변수가 없다는 점뿐이에요.
• 콜백을 받으려면 게임 루프에서 Base_RunCallback 을 반복 호출해야 해요.

See Also

• Base_Initialize
• Base_UnInitialize

Base_OpenExternalUrl

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

Description

Base_OpenExternalUrl 은 지정한 URL 을 외부에서 여는 비동기 함수예요. 결과는 onFinished 콜백으로 전달돼요.

Declaration

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

Parameters

Returns

Callback

public delegate void OnOpenExternalUrlFinished(CallbackResult result);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 이 호출 1건에 대해 1회 실행돼요.

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

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

Notes

• onFinished 는 필수예요. 넘기지 않으면 INVALID_PARAM 으로 처리돼요.
• 기본 브라우저에서 지정한 주소를 열어요. 게임 창은 그대로 유지돼요.
• 콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요.

See Also

• 없음

Base_OverImmersionNotification

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

Description

Base_OverImmersionNotification 은 과몰입 경고가 발생할 때 호출될 콜백을 등록하는 함수예요. onFinished 를 다시 호출하면 이전에 등록된 같은 타입의 콜백은 새 콜백으로 교체돼요.

Declaration

public static void Base_OverImmersionNotification(OnOverImmersionFinished onFinished);

Parameters

Returns

Callback

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

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 과몰입 경고가 발생할 때마다 호출돼요.

Error Codes

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

Example

using static Stove.PCSDK.Base;

void OnOverImmersionFinished(CallbackResult callbackResult, StovePCOverImmersion overImmersion)
{
    if (callbackResult.result.IsSuccessful())
    {
        // overImmersion.warningMessage 등으로 경고를 표시하는 로직을 구현해 주세요.
    }
}

Base_OverImmersionNotification(OnOverImmersionFinished);

Notes

• PCBANG_FREE 상태에서도 이 알림은 계속 동작할 수 있어요. 상태와 무관하게 콜백 등록을 유지해야 해요.

See Also

• StovePCOverImmersion
• Base_ShutdownNotification

Base_RestartAppIfNecessary

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

Description

Base_RestartAppIfNecessary 는 StovePCInitializeParam 을 넘겨 필요한 경우 앱을 재시작시키는 동기 함수예요. 콜백 없이 즉시 bool 값을 돌려줘요.

비동기로 처리하려면 Base_RestartAppIfNecessaryAsync 계열을 사용해야 해요.

Declaration

public static bool Base_RestartAppIfNecessary(StovePCInitializeParam initParam);

Parameters

Returns

Error Codes

없음. 이 함수는 Result/CallbackResult 를 반환하지 않으며, 내부에서 예외가 발생하면 C# 예외가 그대로 다시 던져져요(rethrow).

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

• 이 함수는 동기 함수이며 콜백을 받지 않아요. 비동기로 재시작을 처리하려면 Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx, Base_RestartAppIfNecessaryAsyncEx2 를 사용해야 해요.
• 예외 발생 시 Result 로 감싸지 않고 C# 예외가 그대로 다시 던져지므로, 호출부에서 예외 처리를 고려해야 해요.

See Also

• Base_RestartAppIfNecessaryAsync
• StovePCInitializeParam

Base_RestartAppIfNecessaryAsync

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

Description

Base_RestartAppIfNecessaryAsync 는 StovePCInitializeParam 과 대기 시간(waitTimeMillisec)을 받아, 필요한 경우 앱을 비동기로 재시작하고 결과를 콜백으로 알려줘요.

런처 실행 여부를 별도로 지정해야 하면 Base_RestartAppIfNecessaryAsyncEx 를, 확장 초기화 파라미터를 한 구조체로 넘기려면 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);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 이 호출 1건에 대해 1회 실행돼요.

Error Codes

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

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

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

Example

using static Stove.PCSDK.Base;

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

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

Base_RestartAppIfNecessaryAsync(initParam, 3000, OnRestartAppIfNecessaryAsyncFinished);

Notes

• onFinished 를 null 로 넘기면 콜백 없이 재시작만 처리돼요.
• 콜백을 받으려면 게임 루프에서 Base_RunCallback 을 반복 호출해야 해요.

See Also

• Base_RestartAppIfNecessaryAsyncEx
• Base_RestartAppIfNecessaryAsyncEx2
• Base_RunCallback

Base_RestartAppIfNecessaryAsyncEx

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

Description

Base_RestartAppIfNecessaryAsyncEx 는 Base_RestartAppIfNecessaryAsync 에 launchLauncher 매개변수가 추가된 버전이에요. 런처를 함께 실행할지를 호출자가 직접 지정할 수 있어요.

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);

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 이 호출 1건에 대해 1회 실행돼요.

Error Codes

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

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

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

Example

using static Stove.PCSDK.Base;

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

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

Base_RestartAppIfNecessaryAsyncEx(initParam, 3000, true, OnRestartAppIfNecessaryAsyncFinished);

Notes

• 백그라운드 스레드에서 발생한 예외도 UNMANAGED_EXCEPTION(253) 또는 MANAGED_EXCEPTION(254) 으로 콜백에 전달돼요.
• Base_RestartAppIfNecessaryAsync 와 시그니처가 다른 점은 launchLauncher 매개변수 하나뿐이에요.

See Also

• Base_RestartAppIfNecessaryAsync
• Base_RestartAppIfNecessaryAsyncEx2

Base_RestartAppIfNecessaryAsyncEx2

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

Description

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

Base_RestartAppIfNecessaryAsyncEx2 는 Base_RestartAppIfNecessaryAsyncEx 의 initParam, waitTimeMillisec, launchLauncher 를 하나의 StovePCInitializeParamEx2 구조체로 통합한 버전이에요. platformName 과 예약 필드도 이 구조체를 통해 함께 전달해요.

Declaration

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

Parameters

Returns

Callback

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

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 이 호출 1건에 대해 1회 실행돼요.

Error Codes

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

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

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

Example

using static Stove.PCSDK.Base;

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

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

• 백그라운드 스레드에서 발생한 예외도 UNMANAGED_EXCEPTION(253) 또는 MANAGED_EXCEPTION(254) 으로 콜백에 전달돼요.
• Base_RestartAppIfNecessaryAsync, Base_RestartAppIfNecessaryAsyncEx 와 달리 별도 매개변수 없이 StovePCInitializeParamEx2 하나만 받아요.

See Also

• Base_RestartAppIfNecessaryAsyncEx
• StovePCInitializeParamEx2

Base_RunCallback

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

Description

Base_RunCallback 은 대기 중인 비동기 API 콜백을 현재 호출 스레드에서 실행시키는 함수예요. 모든 SDK 비동기 API(예: Base_Initialize)의 콜백은 SDK 내부 스레드가 아니라, 이 함수를 호출한 스레드에서 실행돼요.

게임 루프에서 매 프레임(또는 주기적으로) 호출해야 대기 중인 콜백이 처리돼요.

Declaration

public static void Base_RunCallback();

Parameters

없음

Returns

Error Codes

없음. 이 함수는 Result/CallbackResult 를 반환하지 않으며, 내부에서 예외가 발생하면 C# 예외가 그대로 다시 던져져요(rethrow).

Example

using static Stove.PCSDK.Base;

// 게임 루프 안에서 매 프레임 호출해 주세요.
void Update()
{
    Base_RunCallback();
}

Notes

• while(true) 형태로 별도 호출하는 함수가 아니라, 게임 루프 안에서 반복 호출해야 하는 함수예요.
• 대기 시간을 지정하려면 Base_RunCallbackWithTimeout 을 사용해야 해요.

See Also

• Base_RunCallbackWithTimeout
• Base_Initialize

Base_RunCallbackWithTimeout

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

Description

Base_RunCallbackWithTimeout 은 Base_RunCallback 과 같은 역할을 하되, timeoutMillisec 로 대기 시간을 지정할 수 있는 함수예요. 콜백은 이 함수를 호출한 스레드에서 실행돼요.

Declaration

public static void Base_RunCallbackWithTimeout(uint timeoutMillisec);

Parameters

Returns

Error Codes

없음. 이 함수는 Result/CallbackResult 를 반환하지 않으며, 내부에서 예외가 발생하면 C# 예외가 그대로 다시 던져져요(rethrow).

Example

using static Stove.PCSDK.Base;

Base_RunCallbackWithTimeout(100);

Notes

• Base_RunCallback 과 마찬가지로 게임 루프에서 반복 호출해야 해요.

See Also

• Base_RunCallback

Base_SetGameProfile

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

Description

Base_SetGameProfile 은 StovePCGameProfile 을 SDK 에 전달하는 동기 함수예요.

Declaration

public static Result Base_SetGameProfile(StovePCGameProfile gameProfile);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

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

Result result = Base_SetGameProfile(gameProfile);

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

Notes

• 없음

See Also

• StovePCGameProfile

Base_SetLanguage

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

Description

Base_SetLanguage 는 StoveLanguage 열거형 값으로 SDK 언어를 설정하는 동기 함수예요.

이 열거형에 없는 언어를 설정해야 하면 Base_SetLanguageEx 를 사용해야 해요.

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

Declaration

public static Result Base_SetLanguage(StoveLanguage language);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

Result result = Base_SetLanguage(StoveLanguage.ko);

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

Notes

• Base_SetLanguageEx 는 StoveLanguage 열거형 대신 문자열을 받아요.

See Also

• Base_SetLanguageEx
• StoveLanguage

Base_SetLanguageEx

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

Description

Base_SetLanguageEx 는 Base_SetLanguage 와 달리 StoveLanguage 열거형이 아니라 문자열로 언어를 설정하는 동기 함수예요. StoveLanguage 에 없는 언어 값을 설정해야 할 때 사용해요.

Declaration

public static Result Base_SetLanguageEx(string language);

Parameters

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

Result result = Base_SetLanguageEx("ko");

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

Notes

• Base_SetLanguage 와의 시그니처 차이는 매개변수 타입이 StoveLanguage 열거형이 아니라 string 이라는 점뿐이에요.

See Also

• Base_SetLanguage

Base_ShutdownNotification

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

Description

Base_ShutdownNotification 은 셧다운 대상 유저에게 셧다운 안내가 발생할 때 호출될 콜백을 등록하는 함수예요. onFinished 를 다시 호출하면 이전에 등록된 같은 타입의 콜백은 새 콜백으로 교체돼요.

Declaration

public static void Base_ShutdownNotification(OnShutdownFinished onFinished);

Parameters

Returns

Callback

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

콜백은 Base_RunCallback() 을 호출한 스레드에서 실행돼요. 셧다운 안내가 발생할 때마다 호출돼요.

Error Codes

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

Example

using static Stove.PCSDK.Base;

void OnShutdownFinished(CallbackResult callbackResult, StovePCShutdown shutdown)
{
    if (callbackResult.result.IsSuccessful())
    {
        // shutdown.shutdownMessage 등으로 안내를 표시하는 로직을 구현해 주세요.
    }
}

Base_ShutdownNotification(OnShutdownFinished);

Notes

• ShutdownNotification 은 한국 전용 기능이 아니에요. 셧다운이 적용된 계정이면 해외에서도 이 콜백이 호출돼요.

See Also

• StovePCShutdown
• Base_OverImmersionNotification

Base_UnInitialize

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

Description

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

Base_UnInitialize 는 SDK 를 종료하는 동기 함수예요. 대기 중인 콜백 큐를 폐기 모드로 비운 뒤(등록된 사용자 delegate 는 이 과정에서 호출되지 않음) 콜백 컨테이너를 정리하고 네이티브 종료를 수행해요.

Declaration

public static Result Base_UnInitialize();

Parameters

없음

Returns

Error Codes

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

Example

using static Stove.PCSDK.Base;

Result result = Base_UnInitialize();

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

Notes

• 종료 처리 중에는 이미 등록된 콜백이 폐기 모드로 처리되어 사용자 delegate 가 호출되지 않아요. 즉, 종료 직전에 등록한 비동기 API 의 콜백을 기대해서는 안 돼요.
• 초기화는 Base_Initialize 또는 Base_InitializeEx 와 짝을 이뤄요.
• 게임 종료 경로가 여러 개라면(정상 종료 · 예외 종료 · 강제 종료 처리) 모든 경로에서 이 함수를 거치도록 두세요. 이용 시간 집계가 이 시점에 정리돼요.

See Also

• Base_Initialize
• Base_InitializeEx

Base_VietnamAgeRatingNotification

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

Description

Base_VietnamAgeRatingNotification 은 베트남 연령등급 오버레이 표시가 필요할 때 호출될 콜백을 등록하는 함수예요.

이 콜백은 1회성이며, 렌더링이 가능한 시점 이후에 등록해야 해요.

Declaration

public static void Base_VietnamAgeRatingNotification(OnVietnamAgeRatingFinished onFinished);

Parameters

Returns

Callback

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

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

Error Codes

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

Example

using static Stove.PCSDK.Base;

void OnVietnamAgeRatingFinished(CallbackResult callbackResult, StovePCVietnamAgeRatingInfo vietnamAgeRatingInfo)
{
    if (callbackResult.result.IsSuccessful())
    {
        // vietnamAgeRatingInfo 로 오버레이를 그리는 로직을 구현해 주세요.
    }
}

Base_VietnamAgeRatingNotification(OnVietnamAgeRatingFinished);

Notes

• 이 콜백은 렌더링이 가능한 시점 이후에 등록해야 해요. 초기화 직후처럼 렌더링 준비가 되지 않은 시점에 등록하면 오버레이가 정상적으로 표시되지 않을 수 있어요.
• 과몰입 알림은 Base_VietnamOverimmersionNotification 로 별도 등록해야 해요.

See Also

• StovePCVietnamAgeRatingInfo
• Base_VietnamOverimmersionNotification

Base_VietnamOverimmersionNotification

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

Description

Base_VietnamOverimmersionNotification 은 베트남 과몰입 오버레이 표시가 필요할 때 호출될 콜백을 등록하는 함수예요. onFinished 를 다시 호출하면 이전에 등록된 같은 타입의 콜백은 새 콜백으로 교체돼요.

이 콜백은 1회성이며, 렌더링이 가능한 시점 이후에 등록해야 해요.

Declaration

public static void Base_VietnamOverimmersionNotification(OnVietnamOverimmersionFinished onFinished);

Parameters

Returns

Callback

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

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

Error Codes

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

Example

using static Stove.PCSDK.Base;

void OnVietnamOverimmersionFinished(CallbackResult callbackResult, StovePCVietnamOverimmersionInfo vietnamOverimmersionInfo)
{
    if (callbackResult.result.IsSuccessful())
    {
        // vietnamOverimmersionInfo 로 오버레이를 그리는 로직을 구현해 주세요.
    }
}

Base_VietnamOverimmersionNotification(OnVietnamOverimmersionFinished);

Notes

• 이 콜백은 렌더링이 가능한 시점 이후에 등록해야 해요.
• 연령등급 알림은 Base_VietnamAgeRatingNotification 로 별도 등록해야 해요.

See Also

• StovePCVietnamOverimmersionInfo
• Base_VietnamAgeRatingNotification

BaseSDKMethod

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

Description

BaseSDKMethod 는 Result.methodCode 와 CallbackResult 안 result.methodCode 에 담기는 값이에요. C# 래퍼가 관리 예외를 Result / CallbackResult 로 변환할 때 어느 API 호출에서 발생했는지 표시하는 용도로 써요.

값은 성격별로 다음과 같이 나뉘어요.

• 생명주기: 초기화 · 종료 · 버전 조회
• 인증/토큰: 액세스 토큰 조회 · 갱신
• 사용자/게임 정보: 유저 · GDS · 로그인 정보 조회
• 언어
• 알림/규제: 과몰입 · 셧다운 · 베트남 규제 알림
• 로그/진단: 로그 전송, 트레이스 힌트, 게임 프로필
• 앱 재시작/외부 연결: 런처 재시작, 외부 URL

이 중 INTERNAL_ 접두사가 붙은 값은 SDK 내부 전용이며, 아래 표에서 제외했어요.

INTERNAL_ 접두사가 붙은 값은 내부 전용이므로 아래 표에서 제외했어요. 이 값들은 게임 코드에서 직접 다룰 일이 없어요.

Declaration

public enum BaseSDKMethod
{
    INITIALIZE = 1,
    UNINITIALIZE = 2,
    // ... 이하 Values 표 참조
    GET_TRANSLATE_LANGUAGE = 119,
};

Enum 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, 총 18개)은 표에서 제외했어요.

Example

using static Stove.PCSDK.Base;

// Result.methodCode 는 이 열거형의 값을 uint 로 담고 있습니다.
void CheckMethod(Result result)
{
    if (result.methodCode == Convert.ToUInt32(BaseSDKMethod.INITIALIZE))
    {
        // Base_Initialize / 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 는 이름에 INTERNAL 이 없지만, BaseAPI.cs 안에서 이 값을 사용하는 공개 Base_ API 가 확인되지 않아요. C++ 원본 헤더(BaseSDKResult.h)의 값 112~119 는 모두 주석으로 "Internal method"라고 명시되어 있어, 대응하는 공개 API 없이 SDK 내부 전용으로 쓰는 값임이 확인돼요.
• LOG_ADD(70) 도 대응하는 공개 API 가 없어요. C++ 원본 헤더에는 Base_LogAdd (deprecated)로 주석이 남아 있으나, 현재 공개된 헤더 어디에도 Base_LogAdd 함수 선언이 없어요. 하위 호환을 위해 코드 값만 남은 폐기된 API 예요.

See Also

• Result
• CallbackResult

BaseSDKResultCode

종류 결과코드 · 모듈 Base · 버전 3.0.0.4

Description

BaseSDKResultCode 는 Result.resultCode 에 담기는 값이에요. 0(SUCCESS)이 성공이며, 그 외 값은 실패 원인을 나타내요. Result.IsSuccessful() 은 resultCode == 0 인지를 검사해요.

C# 래퍼 내부에서 예외가 발생하면(마샬링 오류 등) 항상 MANAGED_EXCEPTION(254) 로 채워진 Result 를 돌려줘요.

Declaration

public enum BaseSDKResultCode
{
    SUCCESS = 0,
    FAIL = 1,
    // ... 이하 Values 표 참조
    IPC_TIMEOUT = 89,
}

Enum Values

성공/일반 오류

초기화 상태

인증/토큰

응답/통신

81Plug 연동

국가/규제

내부 정리 전용

언어/GDS

런처 연동

C# 래퍼 전용

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

• 19 INVALID_ACCESS_TOKEN — 로그인 세션이 만료되어 게임을 종료하고 다시 실행해야 해요
• 84 NEED_STOVE_LAUNCHER — 게임 종료 후 재실행이 필요해요
• 87 IPC_CONNECT_FAILED — 게임 종료 후 재실행이 필요해요
• 88 IPC_AES_KEY_NOT_RECEIVED — 게임 종료 후 재실행이 필요해요
• 89 IPC_TIMEOUT — 게임 종료 후 재실행이 필요해요

스토브 PC 클라이언트 없이 게임 실행 파일을 직접 실행하면 87(IPC_CONNECT_FAILED) 또는 89(IPC_TIMEOUT)가 발생해요. 이 경우 게임을 종료해야 하며, 종료되면 스토브 런처가 자동 실행돼요.

Example

using static Stove.PCSDK.Base;

Result result = Base_SetGameProfile(gameProfile);

if (result.IsSuccessful())
{
    // 성공 시 로직을 구현해 주세요.
}
else if (result.resultCode == Convert.ToUInt32(BaseSDKResultCode.BASE_NOT_INITIALIZED))
{
    // 초기화 선행 호출 로직을 구현해 주세요.
}
else
{
    // 그 외 실패 시 로직을 구현해 주세요.
}

Notes

• POPUP_NOT_CREATED(33)은 SDK Legacy API 자체보다는 팝업의 내부 정리 경로에서 쓰이며, 사용자 콜백에는 전달되지 않아요.

See Also

• Result
• CallbackResult

CallbackResult

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

Description

CallbackResult 는 Base_Initialize, Base_RestartAppIfNecessaryAsync 등 콜백을 받는 SDK Legacy API 가 콜백 첫 번째 인자로 전달하는 구조체예요. 실제 성공 · 실패 여부는 내부의 result 필드로 판정해요.

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())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• 결과 확인은 callbackResult.result.IsSuccessful() 이에요. result 는 소문자 필드이며, IsSuccessful() 은 메서드예요.
• 신규 C# 인터페이스(Stove.PCSDK.V3)의 IStoveCallbackResult 는 Result 프로퍼티(대문자 시작)를 쓰므로 구 인터페이스와 표기가 달라요.

See Also

• Result

DiscountType

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

Description

StovePCProduct.discountType / StovePCProductEx.discountType 필드에 담겨, 상품이 할인 중일 때(isDiscount == true) 할인 방식이 정률(비율)인지 정액(고정 금액)인지를 나타내요.

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)
    {
        // 정률 할인 표시 로직을 구현해 주세요. discountTypeValue 가 할인율입니다.
    }
}

Notes

• discountTypeValue 필드와 함께 사용돼요. FIXED_RATE이면 비율(%), FLAT_RATE이면 고정 금액을 의미해요.

See Also

• StovePCProduct
• StovePCProductEx

IAP_CloseAllPopups

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

Description

결제 기능이 띄운 웹뷰 팝업(구매, 결제, 약관 동의, 게임 탈퇴 등)이 열려 있다면 모두 닫아요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static Result IAP_CloseAllPopups()

Parameters

없음

Returns

Error Codes

Result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.CLOSE_ALL_POPUPS)이에요.

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

Example

using static Stove.PCSDK.IAP;

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

Notes

• 이 함수는 동기 함수이며 콜백을 받지 않아요.
• 게임 종료 등으로 열려 있는 팝업을 한 번에 정리해야 할 때 사용해요.

See Also

• IAP_StartPurchase
• IAP_StartPayment
• IAP_WithdrawGame

IAP_ConfirmPurchase

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

Description

transactionMasterNo로 지정한 거래의 구매를 확인 처리해요. IAP_StartPurchase / IAP_StartPurchaseEx의 콜백으로 전달받은 StovePCPurchaseResult.transactionMasterNumber를 전달해요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static void IAP_ConfirmPurchase(long transactionMasterNo, OnConfirmPurchaseFinished onFinished)

Parameters

Returns

없음

Callback

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

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

Error Codes

CallbackResult.result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.CONFIRM_PURCHASE)예요.

전체 목록은 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())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• transactionMasterNo는 IAP_StartPurchase 계열 API의 콜백 결과에서 얻어요.
• Base_RunCallback()을 게임 루프에서 반복 호출해야 콜백이 전달돼요.

See Also

• IAP_StartPurchase
• StovePCPurchasedProduct
• StovePCChargeInfo

IAP_FetchInventory

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

Description

사용자가 보유한 인벤토리 아이템 목록을 조회해요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static void IAP_FetchInventory(OnFetchInventoryFinished onFinished)

Parameters

Returns

없음

Callback

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

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

Error Codes

CallbackResult.result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.FETCH_INVENTORY)예요.

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

Example

using static Stove.PCSDK.IAP;

IAP_FetchInventory(OnFetchInventoryFinished);

void OnFetchInventoryFinished(CallbackResult callbackResult, StovePCInventoryItem[] inventoryItems)
{
    if (callbackResult.result.IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• Base_RunCallback()을 게임 루프에서 반복 호출해야 콜백이 전달돼요.

See Also

• StovePCInventoryItem

IAP_FetchProducts

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

Description

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

productParam으로 지정한 카테고리·페이지 범위의 상품 목록을 조회해요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static void IAP_FetchProducts(StovePCFetchProductParam productParam, OnFetchProductsFinished onFinished)

Parameters

Returns

없음

Callback

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

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

Error Codes

CallbackResult.result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.FETCH_PRODUCTS)이에요.

전체 목록은 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())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• 실제 연동에는 항상 IAP_FetchProductsEx를 사용하세요. 구매 가능 여부 코드(purchaseAvailabilityCode)도 Ex 변형에서만 받을 수 있어요.
• Base_RunCallback()을 게임 루프에서 반복 호출해야 콜백이 전달돼요.

See Also

• IAP_FetchProductsEx
• StovePCFetchProductParam
• StovePCProduct
• IAP_FetchShopCategories

IAP_FetchProductsEx

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

Description

IAP_FetchProducts와 입력 파라미터(productParam)는 동일하지만, 조회 결과로 purchaseAvailabilityCode 필드가 추가된 StovePCProductEx[]를 돌려줘요. StovePCProduct[]를 돌려주는 IAP_FetchProducts와는 반환 타입만 달라요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static void IAP_FetchProductsEx(StovePCFetchProductParam productParam, OnFetchProductsExFinished onFinished)

Parameters

Returns

없음

Callback

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

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

Error Codes

CallbackResult.result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.FETCH_PRODUCTS)이에요.

전체 목록은 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())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• purchaseAvailabilityCode가 필요하지 않다면 IAP_FetchProducts를 사용해요.
• Base_RunCallback()을 게임 루프에서 반복 호출해야 콜백이 전달돼요.

See Also

• IAP_FetchProducts
• StovePCProductEx
• StovePCFetchProductParam

IAP_FetchShopCategories

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

Description

상점에 등록된 카테고리 목록을 조회해요. 조회한 카테고리 ID는 IAP_FetchProducts / IAP_FetchProductsEx의 StovePCFetchProductParam.categoryId에 사용해요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static void IAP_FetchShopCategories(OnFetchShopCategoriesFinished onFinished)

Parameters

Returns

없음

Callback

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

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

Error Codes

CallbackResult.result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.FETCH_SHOP_CATEGORIES)이에요.

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

Example

using static Stove.PCSDK.IAP;

IAP_FetchShopCategories(OnFetchShopCategoriesFinished);

void OnFetchShopCategoriesFinished(CallbackResult callbackResult, StovePCShopCategory[] shopCategories)
{
    if (callbackResult.result.IsSuccessful())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• Base_RunCallback()을 게임 루프에서 반복 호출해야 콜백이 전달돼요.

See Also

• StovePCShopCategory
• IAP_FetchProducts

IAP_FetchTermsAgreement

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

Description

사용자의 약관 동의 여부를 조회해요. option의 동작 방식에 따라 약관 동의 웹뷰 팝업이 표시될 수 있어요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

public static void IAP_FetchTermsAgreement(StovePCTermsOption option, OnFetchTermsAgreementFinished onFinished)

Parameters

Returns

없음

Callback

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

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

Error Codes

CallbackResult.result.methodCode 값은 Convert.ToUInt32(IAPSDKMethod.FETCH_TERMS_AGREEMENT)예요.

전체 목록은 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())
    {
        // 성공 시 로직을 구현해 주세요.
    }
    else
    {
        // 실패 시 로직을 구현해 주세요.
    }
}

Notes

• 팝업이 닫힐 때(destroy)를 별도로 감지해야 한다면 IAP_FetchTermsAgreementEx를 사용해요.
• Base_RunCallback()을 게임 루프에서 반복 호출해야 콜백이 전달돼요.

See Also

• IAP_FetchTermsAgreementEx
• StovePCTermsOption

IAP_FetchTermsAgreementEx

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

Description

IAP_FetchTermsAgreement와 동일하게 약관 동의 여부를 조회하지만, 약관 동의 팝업이 닫힐 때 호출되는 onDestroy 콜백을 추가로 받아요. 나머지 파라미터와 결과 콜백(onFinished)은 IAP_FetchTermsAgreement와 동일해요.

IAP_Initialize 이후에 호출해야 해요.

Declaration

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

Parameters

Returns

없음

Callback