WebPortal¶

C++ type: WebPortal (static) · Header: WebPortal.h

Description¶

The SDK of a web game portal, behind one API: ads, gameplay and loading events, and cloud saves. A web export builds in the portal chosen with Game Portal in the project's Web settings: CrazyGames, Poki, GameDistribution, Yandex Games or YouTube Playables. Without one, and on every other platform, the calls do nothing and ads and saves report errors.

Results arrive as events at the start of a frame. The engine pauses while an ad plays or the portal pauses the game, and resumes after. See Monetization → Web portals for the flow, what each portal supports, and how to test locally.

REGISTER_EVENT(WebPortal::onAdFinished, onAdFinished);
WebPortal::initialize();
WebPortal::loadingStop();

void Game::onAdFinished(WebPortalAdType type) {
    if (type == WebPortalAdType::REWARDED) lives++;
}

RegisterEvent(self, WebPortal.onAdFinished, "onAdFinished")
WebPortal.initialize()
WebPortal.loadingStop()

function Game:onAdFinished(adType)
    if adType == WebPortalAdType.REWARDED then
        self.lives = self.lives + 1
    end
end

Methods¶

Callback events¶

Method details¶

getPortal¶

• static WebPortalType getPortal()

The portal this build includes, or NONE. It reflects the build, not where the page runs: see getEnvironment() for that.

initialize¶

• static void initialize()

Loads the portal's SDK and starts it. Call it once at startup, as some portals pause or mute the game from the start. onInitialized(environment) reports where the game runs.

Calls made after initialize() wait for the SDK to start. Calls made before it are dropped: ads report unavailable and saves fail.

getEnvironment / isAvailable¶

• static WebPortalEnvironment getEnvironment()
• static bool isAvailable()

Where the game runs, known once onInitialized fired. isAvailable() is true for LOCAL and PORTAL, when the SDK works.

requestAd¶

• static void requestAd(WebPortalAdType type)

Asks the portal for an ad: MIDGAME at a natural break, or REWARDED when the player chose to watch one for a reward. onAdStarted and onAdFinished report an ad that played, and onAdError(type, code, message) one that did not. Grant a reward only in onAdFinished.

Portals decide when a midgame ad really plays, so a request may show none and report the code unfilled. The engine pauses while the ad plays. See ad error codes.

gameplayStart / gameplayStop¶

• static void gameplayStart()
• static void gameplayStop()

Tell the portal when the player is playing: start at play and on resume, stop at every break, such as menus, pauses, and the end of a level. Portals use it to time their ads. CrazyGames, Poki and Yandex Games use it; the others ignore it.

loadingStart / loadingStop¶

• static void loadingStart()
• static void loadingStop()

Bracket loading screens. Call loadingStop() once the game can be played: Yandex Games and YouTube Playables require it. CrazyGames and Poki also use loadingStart().

happytime¶

• static void happytime()

Marks a happy moment, like a level completed or a record beaten. CrazyGames and Poki use it.

loadData / saveData¶

• static void loadData()
• static void saveData(const std::string& data)

The cloud save of YouTube Playables, kept in the player's account as one string. loadData() reports onDataLoaded(data), with an empty string when nothing was saved yet, or onDataLoadFailed(message). saveData() reports only failures, through onDataSaveFailed(message). YouTube refuses saves made before a loadData().

The other portals have no cloud save: loadData() and saveData() report a failure.

Events¶

Each event is a static FunctionSubscribe member; subscribe with REGISTER_EVENT in C++ or RegisterEvent in Lua (see Events). C++ handlers take the parameters by value, exactly as listed.

onAdError codes:

Enumerations¶

WebPortalType¶

• NONE — No portal in this build.
• CRAZYGAMES — CrazyGames, SDK v3.
• POKI — Poki, SDK v2.
• GAMEDISTRIBUTION — GameDistribution. Needs the Portal Game ID project setting.
• YANDEX — Yandex Games.
• YOUTUBE — YouTube Playables.

WebPortalAdType¶

• MIDGAME — An ad at a break in the game: CrazyGames' midgame ad, Poki's commercial break, an interstitial or fullscreen ad elsewhere.
• REWARDED — An ad the player chose to watch for a reward.

WebPortalEnvironment¶

• UNINITIALIZED — initialize() has not finished.
• DISABLED — No portal in this build, its SDK failed to load, or the portal does not run on this host. Calls do nothing.
• LOCAL — localhost, 127.0.0.1 or [::1], where most portals show test ads.
• PORTAL — Any other host, normally the portal's.

See also¶

• Monetization → Web portals — setup, portal differences, and local testing
• AdMob and InAppPurchase
• Building for HTML5