Back To Top

This module contains general GX.games functionality. These include general purpose functions and also structs that are reused across multiple modules.

This asset contains the following general functions:

• gxc_get_query_param

This asset contains the following general structs:

• Pagination

Back To Top

When your game is played on GX.games, some extra parameters are passed into the URL of the game so they can be retrieved in-game. This function will return the value of the parameter specified in the first argument as a string. The following parameter keys can be specified in the key argument:

Note that if the specified parameter is not present in the URL, this function will return undefined.

Syntax:

gxc_get_query_param(key);

Returns:

String (or undefined)

Example:

var _current_challenge = gxc_get_query_param("challenge");
var _highscore_challenge = "34esa3a1-e41e-4a9f-aaaa-4da7bd24ada2";

if (_current_challenge == _highscore_challenge)
{
    gxc_challenge_submit_score(global.highscore);
}

The above code retrieves the ID of the currently active challenge and checks whether it's equal to a specific challenge ID (meaning that challenge is active). In that case, it submits the current highscore as a new score to the challenge. Here is an example where the profile data is retrieved and drawn in-game:

// Create event
username = gxc_get_query_param("username");

var _avatar_url = gxc_get_query_param("avatarUrl");

user_sprite = sprite_add(_avatar_url, 0, 0, 0, 0, 0);

// Draw event
if (sprite_exists(user_sprite))
{
    draw_sprite(user_sprite, 0, x, y);
    draw_text(x + 100, y, username);
}

The "Create event" code above retrieves the username and avatar URL for the current user, then uses sprite_add() to download the avatar image through the given URL and stores its new ID in a variable. In the Draw event, it checks whether the user sprite exists (which will be true after it has been downloaded) and if it does, draws the sprite along with the username.

NOTE : Due to CORS, you will not be able to load the avatar image when the game is running locally. For it to work you are required to have uploaded your game to GXC and run it from there.

Back To Top

The Pagination struct is returned by all the functions that query data from the server as shown in the list below:

• gxc_challenge_get_challenges

• gxc_challenge_get_global_scores

• gxc_challenge_get_user_scores

  This struct will contain the following variables: