GDevelop 5

https://wiki.gdevelop.io/gdevelop5/
Admin
GDevelop 5 is a free, open-source game engine that allows developers to create 2D and 3D games...
Tokens:311,100
Snippets:4,603
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Game

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Initializes the start of the game.

```APIDOC
## Start Game

### Description
Start Game.
```

--------------------------------

### Log tutorial start

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Logs the start of a tutorial.

```APIDOC
## Log tutorial start

### Parameters
- **Name** (String) - The name of the tutorial.
```

--------------------------------

### Gameplay started

Source: https://wiki.gdevelop.io/gdevelop5/extensions/poki-games-sdkhtml

Inform the Poki SDK that gameplay has started.

```APIDOC
## Gameplay started

### Description
Inform Poki that gameplay has started.
```

--------------------------------

### Install Cordova CLI

Source: https://wiki.gdevelop.io/gdevelop5/publishing/android_and_ios_with_cordova

Global installation of the Cordova command-line interface using npm.

```bash
npm install -g cordova
```

--------------------------------

### Log level start

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Logs the start of a level.

```APIDOC
## Log level start

### Parameters
- **Level** (String) - The name of the level.
```

--------------------------------

### Start a tracer

Source: https://wiki.gdevelop.io/gdevelop5/all-features/firebase/reference

Starts measuring performance for a specific tracer.

```APIDOC
## Start a tracer

### Description
Starts performance measurement for the specified tracer.

### Parameters
- **Parameter 0** (String) - Required - The name of the tracker.
```

--------------------------------

### Get entry point asynchronously

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Get entry point that the game was launched from asynchronously.

```APIDOC
## Get entry point asynchronously

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

### Parameters
- **Parameter 1** (Any variable) - Required - String variable callback
```

--------------------------------

### Example Submission Checklist

Source: https://wiki.gdevelop.io/gdevelop5/community/guide-for-submitting-an-example

A checklist of requirements to be completed and marked with an 'x' before submitting a game example via GitHub.

```markdown
- [ ] My Game has a proper name in the game properties.
- [ ] My Game package name begins with 'com.examples'.
- [ ] My Game has all events unfolded.
- [ ] I've added myself as the author in the game properties.
- [ ] I've included a file called 'README.md' with a description in proper English, explaining what this example is doing.
- [ ] I confirm that this game and all its resources can be integrated to this Github repository, distributed and MIT licensed.
- [ ] I've cleaned unused resources in the project.
```

--------------------------------

### Retrieve Player Starting Position

Source: https://wiki.gdevelop.io/gdevelop5/tutorials/platformer/part-8

Use these expressions to get the initial coordinates of the player object at the start of the scene.

```GDevelop
Player.X()
Player.Y()
```

--------------------------------

### Get catalog async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets the catalog of available products the player can purchase.

```APIDOC
## Get catalog async

### Description
Gets the catalog of available products the player can purchase.

### Parameters
- **Parameter 1** (Any variable) - Required - Array of product structure variable callback
```

--------------------------------

### Loading started

Source: https://wiki.gdevelop.io/gdevelop5/extensions/crazy-games-ad-api

Notifies the CrazyGames API that loading has started.

```APIDOC
## Loading started

### Description
Let CrazyGames know loading started.

### Parameters
None.
```

--------------------------------

### Gameplay started

Source: https://wiki.gdevelop.io/gdevelop5/extensions/crazy-games-ad-api

Notifies the CrazyGames API that gameplay has started.

```APIDOC
## Gameplay started

### Description
Let CrazyGames know gameplay started.

### Parameters
None.
```

--------------------------------

### Using Function Arguments

Source: https://wiki.gdevelop.io/gdevelop5/all-features/expressions

Examples of passing single and multiple arguments to functions.

```text
ToNumber(42)
```

```text
RandomInRange(3, 10)
```

--------------------------------

### Get purchased products async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets purchased products.

```APIDOC
## Get purchased products async

### Description
Gets purchased products.

### Parameters
- **callback** (Any variable) - Required - Array of purchased products structure variable callback.
```

--------------------------------

### Build with Electron Builder options

Source: https://wiki.gdevelop.io/gdevelop5/publishing/windows-macos-linux-with-electron

Examples of using command-line flags to target specific platforms and packaging formats.

```bash
# Build for windows only:
yarn build -w
# Build a windows portable executable:
yarn build -w portable
# Build for windows and linux:
yarn build -wl
# Build portable builds for windows and linux
yarn build -w portable -l AppImage
# Build for all platforms:
yarn build -wlm
```

--------------------------------

### Example CLI test output

Source: https://wiki.gdevelop.io/gdevelop5/interface/gameplay-tests/command-line

Sample console output showing test results and the path to the generated JSON report.

```text
[CLI] PASSED (passed): Player flaps upward when pressing Space (34 frames, 1370ms)
[CLI] FAILED (failed): Collecting a coin increases the score (240 frames, 2100ms) - Assertion failed: The score increased after touching the coin
[CLI] Full test results written to: /path/to/gameplay-test-results.json
[CLI] 1/2 gameplay tests passed.
```

--------------------------------

### Start dialogue from branch

Source: https://wiki.gdevelop.io/gdevelop5/all-features/dialogue-tree/reference

Initiates the dialogue starting from a specific branch.

```APIDOC
## Start dialogue from branch

### Description
Initiates the dialogue from a specified branch.

### Parameters
- **Dialogue branch** (String) - Required - The name of the branch to start from.
```

--------------------------------

### Build the Electron project

Source: https://wiki.gdevelop.io/gdevelop5/publishing/windows-macos-linux-with-electron

Commands to install dependencies and trigger the build process for the exported project.

```bash
yarn && yarn build
```

```bash
yarn add -D electron-builder && yarn electron-builder
```

--------------------------------

### Example Reproduction Steps

Source: https://wiki.gdevelop.io/gdevelop5/community/guide-to-reporting-a-bug

A bulleted list format for documenting the sequence of actions that trigger a bug.

```text
* Go to Scene events
* Right click on an event
* Click edit
* The window should now be going crazy
```

--------------------------------

### Get entry point data

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get entry point data

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

### Parameters
- **Parameter 1** (Any variable) - Required - Structure variable callback to set the result
```

--------------------------------

### CI script integration example

Source: https://wiki.gdevelop.io/gdevelop5/interface/gameplay-tests/command-line

A minimal CI step that executes tests and handles failure exit codes.

```bash
xvfb-run -a gdevelop game.json --run-command RUN_ALL_TESTS || {
  echo "Some gameplay tests failed - see gameplay-test-results.json";
  exit 1;
}
```

--------------------------------

### List iOS Simulators

Source: https://wiki.gdevelop.io/gdevelop5/publishing/android_and_ios_with_cordova

Displays all iOS simulators currently installed on the Mac.

```bash
cordova emulate ios --list
```

--------------------------------

### Initialize rich presence

Source: https://wiki.gdevelop.io/gdevelop5/extensions/discord-rich-presence

Attempts to connect to the Discord client if it is installed and initializes the rich presence session.

```APIDOC
## Initialize rich presence

### Description
Attempts to connect to the Discord client if it is installed and initializes the rich presence session.

### Parameters
- **client_id** (String) - Required - The Discord client ID.
```

--------------------------------

### A new touch has started

Source: https://wiki.gdevelop.io/gdevelop5/all-features/mouse-touch/reference

Check if a touch has just started or the mouse left button has been pressed on this frame.

```APIDOC
## Condition: A new touch has started

### Description
Check if a touch has just started or the mouse left button has been pressed on this frame. The touch identifiers can be accessed using StartedTouchOrMouseId() and StartedTouchOrMouseCount().
```

--------------------------------

### Start listening

Source: https://wiki.gdevelop.io/gdevelop5/extensions/voice-recognition

Initiates the voice recognition process using the browser microphone.

```APIDOC
## Action: Start listening

### Description
Starts listening for speech input from the user's microphone.

### Parameters
- **Language** (String) - Optional - The language code for recognition (e.g., "en-US", "fr-FR"). Defaults to the browser's language setting if not provided.
```

--------------------------------

### Player installed an application

Source: https://wiki.gdevelop.io/gdevelop5/all-features/steamworks/reference

Checks if the current user has a Steam application currently installed.

```APIDOC
## Steamworks::HasPlayerInstalledApp

### Description
Checks if the current user has a Steam application currently installed.

### Parameters
- **Name** (String) - Required - The Steam App ID of the application
```

--------------------------------

### Register Gamejolt game

Source: https://wiki.gdevelop.io/gdevelop5/extensions/gamejolt-api

Setup a game before using the Gamejolt API.

```APIDOC
## Register Gamejolt game

### Description
Setup a game before using the Gamejolt API.

### Parameters
- **Gamejolt game identifier** (String) - Required
- **Gamejolt game secret key** (String) - Required
```

--------------------------------

### SVG path data example

Source: https://wiki.gdevelop.io/gdevelop5/extensions/curved-movement/details

An example of an Optimized SVG path string that can be used with the Create a path from a SVG action.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<svg width="800" height="600" version="1.1" viewBox="0 0 800 600" xml:space="preserve" xmlns="http://www.w3.org/2000/svg"><path d="m645 199c-108 53.9-15.5-103-101-123s-94.9 70-168 71.7c-72.8 1.74-65.1-118-193-75.8-128 42.5-180 180-114 237 66 57.3 115-56 197-57.6 81.5-1.6 88.6 218 221 166 133-52 54.1-176-20.2-178-74.3-2.09-160 189-109 263s240 59.4 306-32.3c65.6-91.7 88.6-325-19.2-271z" fill="none" stroke="#000" stroke-width="1px"/></svg>
```

--------------------------------

### Get stats async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets a player's stats.

```APIDOC
## Get stats async

### Description
Gets a player's stats.

### Parameters
- **level** (String) - Required - Level.
- **period** (String) - Required - Period of stat (one of: "alltime", "daily", "monthly", "weekly").
- **callback** (Any variable) - Required - Variable to save the result (Array).
```

--------------------------------

### Get traffic source

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets the traffic source info for the game.

```APIDOC
## Get traffic source

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

### Parameters
- **callback** (Any variable) - Required - Structure variable to set traffic source.
```

--------------------------------

### Steam Build Configuration File

Source: https://wiki.gdevelop.io/gdevelop5/publishing/publish-to-steam

Example VDF configuration file for defining app ID, content paths, and depot file mappings for steamcmd.

```vdf
"AppBuild"
{
    "AppID" "1234560" // your AppID
    "Desc" "Script to upload files" // internal description for this build

    "ContentRoot" "." // root content folder, relative to location of this file
    "BuildOutput" "./output" // build output folder for build logs and build cache files

    "Depots"
    {
        "1234562" // macOS DepotID
        {
            "FileMapping"
            {
                "LocalPath" "mac/*" // all files from contentroot folder
                "DepotPath" "." // mapped into the root of the depot
                "recursive" "1" // include all subfolders
            }
        }
    }
}
```

--------------------------------

### Silent Windows Installation via PowerShell

Source: https://wiki.gdevelop.io/gdevelop5/getting_started/batch-install-gdevelop-company-university

Use this command to perform a system-wide silent installation of GDevelop on Windows machines.

```powershell
Start-Process -Wait -FilePath "$PSScriptRoot\GDevelop 5 Setup 5.X.XXX.exe" -ArgumentList "/ALLUSERS /S"
```

--------------------------------

### Get leaderboard entry count async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets the total number of entries in the leaderboard.

```APIDOC
## Get leaderboard entry count async

### Description
Gets the total number of entries in the leaderboard.

### Parameters
- **name** (String) - Required - The name of the leaderboard.
- **callback** (Any variable) - Required - Entry count variable callback.
```

--------------------------------

### Example Document Data Structure

Source: https://wiki.gdevelop.io/gdevelop5/all-features/firebase/firestore

Represents the initial state of documents before applying an order by filter.

```json
{ price: 69, name: "Lamp oil"},
{ price: 42, name: "Rope"},
{ price: 420, name: "Bombs"}
```

--------------------------------

### Get all tournaments async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get all tournaments async

### Description
Returns a list of eligible tournaments that can be surfaced in-game.

### Parameters
- **Parameter 1** (Any variable) - Required - Array of tournament structure variable callback
```

--------------------------------

### Started a spindash

Source: https://wiki.gdevelop.io/gdevelop5/extensions/hedgehog-platformer

Check if the character has just started a spindash.

```APIDOC
## Started a spindash

### Description
Check if the character has just started a spindash.

### Parameters
- **Object** (👾) - Required - The object to check.
- **Behavior** (🧩) - Required - The Hedgehog Character Rolling behavior.
```

--------------------------------

### Get leaderboard async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Fetch a specific leaderboard belonging to this game.

```APIDOC
## Get leaderboard async

### Description
Fetch a specific leaderboard belonging to this game.

### Parameters
- **name** (String) - Required - The name of the leaderboard. Each leaderboard for a game must have its own distinct name.
- **callback** (Any variable) - Required - Leaderboard structure variable callback.
```

--------------------------------

### Get the URL for buying a product

Source: https://wiki.gdevelop.io/gdevelop5/all-features/shopify/reference

Retrieves a checkout URL for a specific product and stores it in a scene variable for later use.

```APIDOC
## Get the URL for buying a product

### Description
Get the URL for buying a product from a shop. The URL will be stored in the scene variable that you specify.

### Parameters
- **Shop name** (String) - Required - The shop name initialized previously.
- **Product id** (String) - Required - The ID of the product.
- **Quantity** (Number) - Required - The number of items to purchase.
- **Variant** (Number) - Optional - The product variant (0 by default).
- **Scene variable (URL)** (Scene variable) - Required - Variable where the checkout URL will be stored.
- **Scene variable (Error)** (Scene variable) - Required - Variable where error information will be stored if the request fails.
```

--------------------------------

### Get current tournament async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get current tournament async

### Description
Fetch the tournament out of the current context the user is playing.

### Parameters
- **Parameter 1** (Any variable) - Required - Tournament structure variable callback
```

--------------------------------

### Get player data async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get player data async

### Description
Retrieve data from the designated cloud storage of the current player.

### Parameters
- **Parameter 1** (String) - Required - String of data keys (separated them with comma for multiple data points)
- **Parameter 2** (Any variable) - Required - Variable to save data received from server
```

--------------------------------

### Log tutorial end

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Logs the end of a tutorial. The tutorial name must match the name passed into the previous logTutorialStart call to record the timer.

```APIDOC
## Log tutorial end

### Parameters
- **Name** (String) - The name of the tutorial.
- **Completed** (String) - Was the tutorial completed ("compeleted" or "not compeleted").
```

--------------------------------

### Load SDK

Source: https://wiki.gdevelop.io/gdevelop5/extensions/crazy-games-ad-api

Initializes the CrazyGames SDK.

```APIDOC
## Load SDK
### Action
`CrazyGamesAdApi::LoadSDK`
```

--------------------------------

### Initialize a shop

Source: https://wiki.gdevelop.io/gdevelop5/all-features/shopify/reference

Initializes the connection to a Shopify shop using provided credentials. This action must be called before any other Shopify actions.

```APIDOC
## Initialize a shop

### Description
Initializes a shop with your credentials. Call this action first, and then use the shop name in the other actions to interact with products.

### Parameters
- **Shop name** (String) - Required - The identifier for the shop.
- **Domain** (String) - Required - The shop domain (e.g., xxx.myshopify.com).
- **App Id** (String) - Required - The Shopify App ID.
- **Access Token** (String) - Required - The access token for authentication.
```

--------------------------------

### Tile Identifier Calculation Example

Source: https://wiki.gdevelop.io/gdevelop5/objects/simple_tilemap

Visual representation of how tile IDs are assigned based on a 32x128 pixel atlas with 16x16 pixel tiles.

```text
0 │ 1
──┼──
2 │ 3
──┼──
4 │ 5
──┼──
6 │ 7
```

--------------------------------

### InitSDK

Source: https://wiki.gdevelop.io/gdevelop5/extensions/ygame-sdk

Initializes the Yandex Games SDK with display and orientation settings.

```APIDOC
## InitSDK

### Description
Initializes the Yandex Games SDK environment.

### Parameters
- **Fullscreen** (Yes/No) - Required - Enable or disable fullscreen mode.
- **Screen orientation** (String) - Required - Set to "portrait" or "landscape".
- **Lock screen** (Yes/No) - Required - Enable or disable screen locking.
```

--------------------------------

### Collision started

Source: https://wiki.gdevelop.io/gdevelop5/all-features/physics2/reference

Checks if two objects just started colliding during the current frame.

```APIDOC
## Condition: Collision started

### Description
Check if two objects just started colliding during this frame.

### Parameters
- **Object** (Object) - Required - The first object.
- **Behavior** (Behavior) - Required - The physics behavior instance.
- **Object** (Object) - Required - The second object to check collision against.
```

--------------------------------

### Player installed DLC

Source: https://wiki.gdevelop.io/gdevelop5/all-features/steamworks/reference

Checks if the current user has installed a piece of DLC.

```APIDOC
## Steamworks::HasPlayerInstalledDLC

### Description
Checks if the current user has installed a piece of DLC.

### Parameters
- **Name** (String) - Required - The Steam App ID of the DLC
```

--------------------------------

### Make purchase async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Make purchase for a specified product.

```APIDOC
## Make purchase async

### Parameters
- **ID** (String) - The ID of the product.
- **Callback** (Any variable) - Purchase result structure variable callback.
```

--------------------------------

### Get current player leaderboard entry async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get current player leaderboard entry async

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

### Parameters
- **Parameter 1** (String) - Required - The name of the leaderboard
- **Parameter 2** (Any variable) - Required - Leaderboard entry structure variable callback
```

--------------------------------

### Get notification history async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets the history of scheduled notifications for the past 30 days.

```APIDOC
## Get notification history async

### Description
Gets the history of scheduled notifications for the past 30 days.

### Parameters
- **callback** (Any variable) - Required - Variable callback to save the notification.
```

--------------------------------

### Build Cordova Project

Source: https://wiki.gdevelop.io/gdevelop5/publishing/android_and_ios_with_cordova

Commands to build the project for all platforms or specific targets.

```bash
cordova build
```

```bash
cordova build ios
```

```bash
cordova build android
```

--------------------------------

### Get signed ASID async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets a unique identifier for the player (Facebook Application-Scoped ID).

```APIDOC
## Get signed ASID async

### Description
A unique identifier for the player. This is the standard Facebook Application-Scoped ID which is used for all Graph API calls.

### Parameters
- **callback** (Any variable) - Required - Signed ASID Structure variable callback.
```

--------------------------------

### Swith context async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Requests a switch into a specific game context.

```APIDOC
## Swith context async

### Description
Request a switch into a specific context.

### Parameters
- **ID of context** (String) - Required
```

--------------------------------

### Create an Audio Context

Source: https://wiki.gdevelop.io/gdevelop5/extensions/audio-context

Initializes a new audio context for sound processing.

```APIDOC
## Create an Audio Context

### Description
Create a new audio context (In most cases you only need one context and reuse it with the name).

### Parameters
- **Context name** (String) - Required
```

--------------------------------

### Get achievements async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get achievements async

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

### Parameters
- **Parameter 1** (Any variable) - Required - Array of Achivement structure variable callback
```

--------------------------------

### Order a product

Source: https://wiki.gdevelop.io/gdevelop5/extensions/in-app-purchase

Opens the purchase menu to allow the user to buy a product.

```APIDOC
## Order a product

### Description
Opens the purchase menu to let the user buy a product. Ensure the store is ready and the product ID has been registered and finalized before calling this action.

### Parameters
- **product_id** (String) - Required - The id of the product to buy
```

--------------------------------

### Get connected players async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

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

```APIDOC
## Get connected players async

### Description
Gets ConnectedPlayers containing information about active players that are connected to the current player.

### Parameters
- **Parameter 1** (Any variable) - Required - Payload variable with structure type
- **Parameter 2** (Any variable) - Required - Array of connected player
```

--------------------------------

### Get players async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Gets an array of ConnectedPlayer objects containing information about active players in the current context.

```APIDOC
## Get players async

### Description
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).

### Parameters
- **callback** (Any variable) - Required - Variable to save the result of connected players of current context.
```

--------------------------------

### Run all gameplay tests via CLI

Source: https://wiki.gdevelop.io/gdevelop5/interface/gameplay-tests/command-line

Executes all gameplay tests for a specified project file.

```bash
gdevelop /path/to/game.json --run-command RUN_ALL_TESTS
```

--------------------------------

### Show auth prompt async

Source: https://wiki.gdevelop.io/gdevelop5/extensions/wortal-sdk

Shows the authentication prompt to the player. This allows the player to log in or register for an account.

```APIDOC
## Show auth prompt async

### Description
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.
```
Tokens:
Raw