Wortal SDK

Wortal SDK for GDevelop 5.

Authors and contributors to this community extension: (not specified).

Warning

This is an extension made by a community member — but not reviewed by the GDevelop extension team. As such, we can't guarantee it meets all the quality standards of official extensions. In case of doubt, contact the author to know more about what the extension does or inspect its content before using it.

Allow developer to use one SDK to deliver their games everywhere. To learn more about Wortal please visit our to Official site and our SDK Documentation.

Actions

Can subscribe to bot asynchronously
Checks if the current user can subscribe to the game's bot.

Cancel all notifications async
Cancel all scheduled notifications.

Cancel notification async
Cancel a notification async.

Choose context async
Opens a context selection dialog for the player. If the player selects an available context, the client will attempt to switch into that context, and resolve if successful. Otherwise, if the player exits the menu or the client fails to switch into the new context, this function will reject.

Consume purchase async
Consumes a specific purchase belonging to the current player.

Create context async
Attempts to create a context between the current player and a specified player or a list of players.

Create a tournament async
Opens the tournament creation dialog if the player is not currently in a tournament session.

Flush data asynchronously
Flushes any unsaved data to the platform's storage. This function is expensive, and should primarily be used for critical changes where persistence needs to be immediate and known by the game. Non-critical changes should rely on the platform to persist them in the background.

Start the gameplay session
Tracks the start of a gameplay session.

Stop the gameplay session
Tracks the end of a gameplay session.

Get ASID asynchronously
A unique identifier for the player. This is the standard Facebook Application-Scoped ID which is used for all Graph API calls. If your game shares an AppID with a native game this is the ID you will see in the native game too.

Get achievements async
Gets a player's achievements. This method returns all achievements, regardless of whether they are unlocked or not.

Get all tournaments async
Returns a list of eligible tournaments that can be surfaced in-game.

Get catalog async
Gets the catalog of available products the player can purchase.

Get connected players async
Gets ConnectedPlayers containing information about active players that are connected to the current player.

Get connected players entries
Retrieves the leaderboard score entries of the current player's connected players (including the current player), ordered by local rank within the set of connected players.

Get current player leaderboard entry async
Retrieves the leaderboard's entry for the current player, or null if the player has not set one yet.

Get current tournament async
Fetch the tournament out of the current context the user is playing.

Get player data async
Retrieve data from the designated cloud storage of the current player.

Get entry point asynchronously
Get entry point that the game was launched from asynchronously.

Get entry point data
Get any data object associated with the entry point that the game was launched from.

Get leaderboard async
Fetch a specific leaderboard belonging to this game.

Get leaderboard entries
Retrieves a set of leaderboard entries, ordered by score ranking in the leaderboard.

Get leaderboard entry count async
Gets the total number of entries in the leaderboard.

Get notification history async
Gets the history of scheduled notifications for the past 30 days.

Get players async
Gets an array of ConnectedPlayer objects containing information about active players in the current context (people who played the game in the current context in the last 90 days).

Get purchased products async
Gets purchased products.

Get signed ASID async
A unique identifier for the player. This is the standard Facebook Application-Scoped ID which is used for all Graph API calls. If your game shares an AppID with a native game this is the ID you will see in the native game too.

Get stats async
Gets a player's stats.

Get traffic source
Gets the traffic source info for the game. This is useful for tracking where players are coming from.

Invite Async
This invokes a dialog to let the user invite one or more people to the game.

Join tournament async
Request a switch into a specific tournament context.

Log game choice
Logs a choice the player made in the game. This can be a powerful tool for balancing the game and understanding what content the players are interacting with the most.

Log level end
Logs the end of a level. To ensure the level timer is recorded the level name must match the name passed into the previous logLevelStart call. If it does not match then the timer will be logged at 0.

Log level start
Logs the start of a level.

Log level up
Logs the player achieving a new level.

Log score
Logs the player's score.

Log social invite
Logs the player's social invite.

Log social share
Logs the player's social share.

Log tutorial end
Logs the end of a tutorial. To ensure the level timer is recorded the tutorial name must match the name passed into the previous logTutorialStart call. If it does not match then the timer will be logged at 0.

Log turotial start
Logs the start of a tutorial.

Make purchase async
Make purchase for specified product.

Post stats async
Posts a player's stats.

Post tournament score async
Posts a player's score. This API should only be called within a tournament context at the end of an activity (example: when the player doesn't have "lives" to continue the game).

Schedule notification async
Schedule a notification to be delivered to the player at a later time. Limit of 5 pending scheduled notifications per recipient.

Send leaderboard entry async
Updates the player's score. If the player has an existing score, the old score will only be replaced if the new score is better than it.

Save data async
Set data to be saved to the designated cloud storage of the current player.

Set Wortal loading progress
Set the loading progress of your game.

Set session data
Set the data associated with the individual gameplay session for the current context.

Share async
This invokes a dialog to let the user share specified content, as a post on the user's timeline.

Share link async
This invokes a dialog that contains a custom game link that users can copy to their clipboard, or share.

Share tournament async
Opens the share tournament dialog if the player is currently in a tournament session.

Show auth prompt async
Shows the authentication prompt to the player. This allows the player to log in or register for an account. If the player successfully logs in or registers, the player API will be updated with the new player information.

Show banner ad
Shows a banner ad.

Show happy time
Can be called on various player achievements (beating a boss, reaching a high score, etc.). It makes the website celebrate (for example by launching some confetti).

Show interstitial ad
Shows an interstitial ad. These can be shown at various points in the game such as a level end, restart or a timed interval in games with longer levels.

Show link account prompt async
Shows the link account prompt to the player. This allows the player to link their account to a different platform.

Show rewarded ad
Shows a rewarded ad. These are longer, optional ads that the player can earn a reward for watching. The player must be notified of the ad and give permission to show before it can be shown.

Start Game
Start Game.

Subscribe bot async
Request that the player subscribe the bot associated to the game. The API will reject if the subscription fails - else, the player will subscribe the game bot.

Swith context async
Request a switch into a specific context.

Switch game async
Switch to another game. The API will reject if the switch fails - else, the client will load the new game.

Unlock achivement
Unlocks an achievement for the player. This method will only unlock the achievement if it has not already been unlocked.

Update context async
Posts an update to the current context.

Conditions

Ad has just finished showing
Check if ad just finished showing.

Ad is blocked
Returns whether ads are blocked for the current session.

Ad is enabled
Returns whether ads are enabled for the current session.

Ad is showing
Check if ad is showing.

Audio is enabled
Returns whether the audio is enabled for the player.

Player is playing for first time
Checks whether this is the first time the player has played this game.

IAP is enabled
Checks whether IAP is enabled in this session.

Wortal SDK is ready
Check if Wortal SDK is ready.

Player should be rewarded
To check if should reward player after showing rewarded ad.

Expressions

Expression	Description
`WortalSDK::ContextID()`	Get current context id.
`WortalSDK::ContextType()`	Gets the type of the current context.
`WortalSDK::Device()`	Get user device.
`WortalSDK::Locale()`	Get user locale in BCP47 format.
`WortalSDK::Orientation()`	Get the orientation of the device the player is using.
`WortalSDK::Platform()`	Get the platform the game is running on. This is useful for platform specific code. For example, if you want to show a different social share asset on Facebook than on Link.
`WortalSDK::PlayerID()`	Gets the player's ID from the platform.
`WortalSDK::PlayerName()`	Gets the player's name on the platform.
`WortalSDK::PlayerPhotoURL()`	Gets the player's photo from the platform.

This page is an auto-generated reference page about the Wortal SDK extension, made by the community of GDevelop, the open-source, cross-platform game engine designed for everyone. Learn more about all GDevelop community-made extensions here.