コンテンツにスキップ

Wortal SDK Core - v1.6

目次

変数 (Variables)

機能

変数 (Variables)

ads

• Const ads: ads = _ads

広告 API

analytics

• Const analytics: analytics = _analytics

アナリティクス API

context

• Const context: context = _context

コンテキスト API

iap

• Const iap: iap = _iap

アプリ内課金 API

leaderboard

• Const leaderboard: leaderboard = _leaderboard

リーダーボード API

notifications

• Const notifications: notifications = _notifications

通知 API

player

• Const player: player = _player

プレイヤー API

session

• Const session: session = _session

セッション API

isInitialized

• isInitialized: boolean

SDK Coreが初期化されている場合、 [ True ] を返します。

機能

getSupportedAPIs

▸ getSupportedAPIs(): string[]

現在のプラットフォームでサポートされているAPIを取得します。

例

const supportedAPIs = Wortal.getSupportedAPIs();
if (supportedAPIs.includes("context.shareAsync")) {
   shareWithFriendsDialog.show();
}

Returns

string[]

サポートされているAPIの配列。

initializeAsync

▸ initializeAsync(): Promise<void>

SDKを初期化します。こちらは、他のSDKの機能の前に呼び出す必要があります。初期化にかかる時間を短縮するために、スクリプトが読み込まれたら速やかにこちらを呼び出すことをお勧めします。

注：こちらは、手動初期化オプションが true に設定されている場合にのみ使用できます。そうでない場合、SDKは自動的に初期化が行われます。

例

Wortal.initializeAsync().then(() => {
   // SDK is ready to use, wait for game to finish loading.
   Wortal.setLoadingProgress(100);
   Wortal.startGameAsync();
});

Returns

Promise<void>

SDKが正常に初期化されたときに解決される Promise。

Throws

  • INITIALIZATION_ERROR
  • NOT_SUPPORTED

onPause

▸ onPause(callback): void

アプリがバックグラウンドの表示になったときに呼び出されるコールバックを設定します。

パラメーター

名前 タイプ 内容説明
callback () => void 呼び出すためのコールバック。

Returns

void

onResume

▸ onResume(callback): void

アプリがフォアグラウンドの表示になったときに呼び出されるコールバックを設定します。

パラメーター

名前 タイプ 内容説明
callback () => void 呼び出すためのコールバック。

Returns

void

performHapticFeedbackAsync

▸ performHapticFeedbackAsync(): Promise<void>

サポートされているデバイスにハプティックフィードバックを要求し、実行する。

Returns

Promise<void>

ハプティックフィードバックが正常に要求されたときに解決する Promise。

Throws

  • NOT_SUPPORTED
  • CLIENT_UNSUPPORTED_OPERATION
  • INVALID_OPERATION

setLoadingProgress

▸ setLoadingProgress(value): void

ゲームの読み込みが終わるまでの進捗状況の値を設定します。こちらの設定は、一部のプラットフォームでのみ必要です。ゲームが完全にロードされた状態の値である、「100％」で呼び出さないと、ゲームが正常に起動しません。

例

onGameLoadProgress(percent) {
    Wortal.setLoadingProgress(percent);
}

onGameLoaded() {
    Wortal.setLoadingProgress(100);
}

パラメーター

名前 タイプ 内容説明
value number 読み込みが完了するまでのパーセントの表示。範囲は0〜100です。

Returns

void

startGameAsync

▸ startGameAsync(): Promise<void>

こちらはゲームの初期の読み込みが完了し、準備が整ったことを示します。返された Promise が解決された際、コンテキスト情報が更新されます。こちらの呼び出しの際、以下の条件を満たした後、ロード画面が削除されます：

  • initializeAsync が呼び出され、解決した時
  • setLoadingProgress が 100 の値で呼び出した時

注：こちらは、手動初期化オプションが “true” に設定されている場合にのみ使用できます。そうでない場合、ゲームは自動的に開始されます。

Example

Wortal.startGameAsync().then(() => {
   // Game is rendered to player.
});

Returns

Promise<void>

ゲームが正常に開始されたときに解決する Promise。

Throws

  • INITIALIZATION_ERROR
  • NOT_SUPPORTED

authenticateAsync

▸ authenticateAsync(): Promise<AuthResponse>

プレーヤーの認証プロセスを開始します。現在のプラットフォームに独自の認証プロンプトがある場合、それが表示されます。

注：ページのリダイレクトやリフレッシュを行う可能性があるため、ゲーム開始前に呼び出す必要があります。

例

Wortal.authenticateAsync().then(response => console.log(response));

Returns

Promise<AuthResponse>

認証プロセスからのレスポンスで解決する Promise。

Throws

  • AUTH_IN_PROGRESS
  • USER_ALREADY_AUTHENTICATED
  • USER_INPUT
  • NOT_SUPPORTED