GDK Extension API

Back To Top

GDK Extension API

This is a collection of GameMaker Studio functions for interacting with the GDK Extension API. This API is comprised of modules that will allow you to access multiple Xbox Live features such as profile information, stats, leaderboards, achievements, storage and Microsoft Store add-ons (also known as In-App Purchases).

Management

Using the GDK Extension requires the developer to manually manage it. The following functions are provided for managing the extension:

• gdk_init
• gdk_update
• gdk_quit

Modules

Please look at the following sections for information on the different modules present in this library:

• Base Module (User)
• Storage Module (Save & Load)
• Xbox Live Module (Stats & Achievements)
• IAP Module (In-App Purchases)

---

Back To Top

gdk_init

This function must be called before any other GDK extension function. It is recommended to use a persistent controller/manager object that is created or placed in the first room and to then call this function in its Create Event.

Syntax:

gdk_init(scid);

Argument	Type	Description
scid	string	The service configuration ID (found under Game setup on the Partner Center).

Returns:

N/A

Example:

gdk_init("00000000-0000-0000-0000-000060ddb039");

The code above initialises the GDK Extension with the provided SCID string. This value can be acquired from your MicrosoftGame.Config file (that needs to be placed in the included files) or from the Partner Center.

---

Back To Top

gdk_update

This should be called each frame while GDK extension is active, recommend using a Controller persistent object that is created or placed in the first room and this call is in the Step Event.

Syntax:

gdk_update();

Returns:

N/A

Example:

gdk_update();

In the code above we are ticking the update logic of the GDK extension, faling to call this function will make the extension stop working.

---

Back To Top

gdk_quit

This should be called on close down and no GDK extension functions should be called after it, recommend using a Controller (persistent) object that is created or placed in the first room and this call is in its Destroy Event.

Syntax:

gdk_quit();

Returns:

N/A

Example:

gdk_quit();

In the code above will terminate the GDK extension and no GDK extension functions should be called after it.

---