GamePush

https://docs.gamepush.com/docs
Admin
GamePush is a unified SDK and backend platform for HTML5 games that simplifies integration with...
Tokens:557,120
Snippets:3,562
Trust Score:6.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Show Fullscreen Ad with Callbacks (Unity C#)

Source: https://docs.gamepush.com/docs/advertising

Unity C# example for showing a fullscreen ad with callbacks for start and close events. The close callback receives a success boolean.

```csharp
// Show fullscreen  
public void ShowFullscreen() => GP_Ads.ShowFullscreen(OnFullscreenStart, OnFullscreenClose);  
  
// Showing started  
private void OnFullscreenStart() => Debug.Log("ON FULLSCREEN START");  
// Showing ended  
private void OnFullscreenClose(bool success) => Debug.Log("ON FULLSCREEN CLOSE");  

```

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

### Get scheduler information (Construct 3 basic)

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Construct 3 visual scripting example for picking a scheduler by ID or tag using the GamePush plugin.

```Construct 3
GamePush
Schedulers: Pick **"DAILY_30"**
pick scheduler by ID or tag
Add action
LegendGamePush
  * GamePush›GamePush plugin

```

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

### Get scheduler information with details (Construct 3)

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Construct 3 visual scripting example for picking a scheduler by ID or tag and displaying its properties, including today day, active days stats, registration status, and claimed days.

```Construct 3
GamePush
Schedulers: Pick **"123"**
pick by ID
Add action
GamePush
Schedulers: Pick **"DAILY_30"**
scheduler ID
Text
Set text to **"ID: " & GamePush.SchedulersCurID**
today day
Text
Set text to **"Today: " & GamePush.SchedulersCurTodayDay**
active days stats
Text
Set text to **"Active: " & GamePush.SchedulersCurPlayerStatsActiveDays**
Add action
GamePush
Schedulers: Is registered in current scheduler
player is registered
Add action
GamePush
Schedulers: For each day claimed
claimed day number
Text
Set text to **"Claimed: " & GamePush.SchedulersCurDayDayNumber**
Add action
LegendGamePushText
  * GamePush›GamePush plugin
  * Text — Object Text (Text)

```

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

### Unity example placeholder

Source: https://docs.gamepush.com/docs/authorization/secret-code

Placeholder example for Unity, indicating that the Unity example is not yet available.

```javascript
// Example coming soon  
```

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

### gp.ads.on('fullscreen:start')

Source: https://docs.gamepush.com/docs/advertising

Event emitted when the fullscreen advertisement starts showing.

```APIDOC
## [EVENT] fullscreen:start

### Description
Event emitted when the fullscreen advertisement starts showing.

### Event Name
fullscreen:start

### Callback Parameters
None

### Example
```javascript
gp.ads.on('fullscreen:start', () => {});
```
```

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

### Multiplayer ▸ Start auto-sync

Source: https://docs.gamepush.com/docs/multiplayer/construct-3

Builds schemas from registered objects and starts automatic synchronization. Must be the last action in the setup block on layout start.

```APIDOC
## Multiplayer ▸ Start auto-sync

### Description
Build schemas from registered objects and start automatic sync.

### Usage Example
The last action in the setup block on layout start.

### Important Notes
- New `Register ...` calls after the start won't make it into the schema.
```

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

### Construct 3: GP_Game.GameplayStart() and GP_Game.GameplayStop()

Source: https://docs.gamepush.com/docs/get-start/common-features

Call GP_Game.GameplayStart() immediately before gameplay begins and GP_Game.GameplayStop() immediately after it ends. Required for platforms like POKI and CrazyGames.

```construct3
// Notify when gameplay starts  
GP_Game.GameplayStart();  
  
// Notify when finished  
GP_Game.GameplayStop();  
```

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

### Example usage of experiments map

Source: https://docs.gamepush.com/docs/experiments/experiments-api

Example usage of the experiments map to get the cohort for EASY_LEVEL, falling back to 'default' if not present.

```JavaScript
const difficult = gp.experiments.map.EASY_LEVEL || 'default';  
```

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

### Purchase with Promises (Construct 3)

Source: https://docs.gamepush.com/docs/purchases/payments

Construct 3 example showing how to await GamePush actions and check success, then set text with product details.

```Construct 3
→Button
On clicked
GamePush
Payments: Purchase **"17541"** product
System
Wait for previous actions
Add action
GamePush
Is Last Action Success
purchased product ID (from result.product)
Text
Set text to **"ID: " & GamePush.PaymentsPurchasedProductID**
purchased product tag (from result.product)
Text
Set text to **"Tag: " & GamePush.PaymentsPurchasedProductTag**
purchase date for this product
Text
Set text to **"Date: " & GamePush.PaymentsPurchaseDate("17541")**
Add action
LegendButtonGamePushSystemText
  * Button — Object Button (Button)
  * GamePush›GamePush plugin
  * System›Construct 3 System object
  * Text — Object Text (Text)
```

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

### Get achievement progress (gp.achievements.getProgress / GP_Achievements.GetProgress)

Source: https://docs.gamepush.com/docs/achievements

Check the progress of an achievement by ID or tag. The JavaScript example uses gp.achievements.getProgress('WIN_FIRST_BATTLE') and the Unity example uses GP_Achievements.GetProgress("LEVEL_50"). The Construct 3 example is not shown as code.

```JavaScript
const progress = gp.achievements.getProgress('WIN_FIRST_BATTLE');  
```

```C#
Debug.Log("PROGRESS: " + GP_Achievements.GetProgress("LEVEL_50"));  
```

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

### Unity: Connect and configure after host selection

Source: https://docs.gamepush.com/docs/multiplayer/player-state

Connects to a channel and then calls ConfigurePlayerInitialization to handle the case where the role has already been selected. This is needed because host selection is asynchronous.

```csharp
await GP_Multiplayer.connect(new MultiplayerChannelQuery { channelId = channelId });  
ConfigurePlayerInitialization();  

```

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

### Unity: Fetch player purchases with GP_Payments

Source: https://docs.gamepush.com/docs/purchases/payments

Unity C# example showing how to subscribe to the OnFetchPlayerPurchases event, fetch purchases, and log each purchase's details.

```csharp
// Subscribe to event  
private void OnEnable()  
{  
    GP_Payments.OnFetchPlayerPurchases += OnFetchPlayerPurchases;  
}  
  
// Unsubscribe from event  
private void OnDisable()  
{  
    GP_Payments.OnFetchPlayerPurchases -= OnFetchPlayerPurchases;  
}  
  
// Fetch the list of the player's purchases through   
public void FetchPlayerPurchases() => GP_Payments.Fetch();\  
  
// Successfully received  
private void OnFetchPlayerPurchases(List<FetchPlayerPurchases> purcahses)  
{  
    for (int i = 0; i < purcahses.Count; i++)  
    {  
        Debug.Log("PLAYER PURCHASES: PRODUCT TAG: " + purcahses[i].tag);  
        Debug.Log("PLAYER PURCHASES: PRODUCT ID: " + purcahses[i].productId);  
        Debug.Log("PLAYER PURCHASES: PAYLOAD: " + purcahses[i].payload);  
        Debug.Log("PLAYER PURCHASES: CREATED AT: " + purcahses[i].createdAt);  
        Debug.Log("PLAYER PURCHASES: EXPIRED AT: " + purcahses[i].expiredAt);  
        Debug.Log("PLAYER PURCHASES: GIFT: " + purcahses[i].gift);  
        Debug.Log("PLAYER PURCHASES: SUBSCRIBED: " + purcahses[i].subscribed);  
    }  
}  
```

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

### Get server time with GP_Server.Time()

Source: https://docs.gamepush.com/docs/get-start/common-features

Get the current server time in ISO 8601 format using GP_Server.Time() and compare it with a stored date to award a score. The example shows a typical usage pattern for time-based logic.

```csharp
// Current server time in format ISO 8601  
GP_Server.Time();  
  
// Usage example  
DateTime dt = GP_Server.Time();  
  
if (dt > lastDate)  
{  
    GP_Player.AddScore(250);  
}  

```

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

### JavaScript: Connect and configure after host selection

Source: https://docs.gamepush.com/docs/multiplayer/player-state

Connects to a channel and then calls configurePlayerInitialization to handle the case where the role has already been selected. This is needed because host selection is asynchronous.

```javascript
await gp.multiplayer.connect({ channelId });  
await configurePlayerInitialization();  

```

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

### Get scheduler information (Unity C# basic)

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Unity C# example calling GP_Schedulers.GetScheduler(string idOrTag) to retrieve scheduler information.

```C#
GP_Schedulers.GetScheduler(string idOrTag);  

```

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

### Construct 3: Sync with selected storage using GP_Player.Sync

Source: https://docs.gamepush.com/docs/player/player-manager

Use GP_Player.Sync with SyncStorageType to choose storage. Options: preferred, cloud, platform, local. This is the Construct 3 equivalent of the JavaScript example.

```Construct 3
// By default, synchronize with the storage specified in the control panel  
GP_Player.Sync(SyncStorageType.preferred);  
  
// Sync with GamePush cloud  
GP_Player.Sync(SyncStorageType.cloud);  
  
// Sync with platform's cloud  
GP_Player.Sync(SyncStorageType.platform);  
  
// Sync with local storage  
GP_Player.Sync(SyncStorageType.local);  

```

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

### GET gp.schedulers.list

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Retrieves the full list of schedulers available when the game starts. Each scheduler object contains its ID, tag, type, days, repeat flag, and triggers.

```APIDOC
## [GET] gp.schedulers.list

### Description
Returns the entire list of schedulers available when the game starts.

### Method
GET

### Endpoint
gp.schedulers.list

### Response
#### Success Response (200)
- **scheduler.id** (number) - The unique identifier of the scheduler.
- **scheduler.tag** (string) - The tag of the scheduler.
- **scheduler.type** (string) - The type of the scheduler.
- **scheduler.days** (number) - The total number of days in the scheduler.
- **scheduler.isRepeat** (boolean) - Whether the scheduler is repeatable.
- **scheduler.triggers** (array) - The list of triggers associated with the scheduler.

#### Response Example
```json
{
  "schedulers": [
    {
      "id": 123,
      "tag": "DAILY_30",
      "type": "daily",
      "days": 30,
      "isRepeat": true,
      "triggers": []
    }
  ]
}
```
```

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

### Unity initialization note

Source: https://docs.gamepush.com/docs/player/player-manager

Unity player initialization happens automatically before the game starts, so no explicit wait is needed.

```text
Initialization in Unity occurs before the game starts  

```

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

### Fetch products and purchases in Unity

Source: https://docs.gamepush.com/docs/purchases/payments

Unity C# example for fetching products and player purchases. Subscribe to events in OnEnable and unsubscribe in OnDisable. The Fetch method triggers the fetch, and the callbacks log product and purchase details.

```csharp
//Subscribe to events
private void OnEnable()
{
    GP_Payments.OnFetchProducts += OnFetchProducts;
    GP_Payments.OnFetchProductsError += OnFetchProductsError;
    GP_Payments.OnFetchPlayerPurchases += OnFetchPlayerPurchases;
}

//Unsubscribe from events
private void OnDisable()
{
    GP_Payments.OnFetchProducts -= OnFetchProducts;
    GP_Payments.OnFetchProductsError -= OnFetchProductsError;
    GP_Payments.OnFetchPlayerPurchases -= OnFetchPlayerPurchases;
}

public void Fetch() => GP_Payments.Fetch();

// Successfully received
private void OnFetchProducts(List<FetchProducts> products)
{
    for (int i = 0; i < products.Count; i++)
    {
        Debug.Log("PRODUCT: ID: " + products[i].id);
        Debug.Log("PRODUCT: TAG: " + products[i].tag);
        Debug.Log("PRODUCT: NAME: " + products[i].name);
        Debug.Log("PRODUCT: DESCRIPTION: " + products[i].description);
        Debug.Log("PRODUCT: ICON: " + products[i].icon);
        Debug.Log("PRODUCT: ICON SMALL: " + products[i].iconSmall);
        Debug.Log("PRODUCT: PRICE: " + products[i].price);
        Debug.Log("PRODUCT: CURRENCY: " + products[i].currency);
        Debug.Log("PRODUCT: CURRENCY SYMBOL: " + products[i].currencySymbol);
        Debug.Log("PRODUCT: IS SUBSCRIPTION: " + products[i].isSubscription);
        Debug.Log("PRODUCT: PERIOD: " + products[i].period);
        Debug.Log("PRODUCT: TRIAL PERIOD: " + products[i].trialPeriod);
    }
}

// Errors by getting
private void OnFetchProductsError() => Debug.Log("FETCH PRODUCTS: ERROR");

private void OnFetchPlayerPurchases(List<FetchPlayerPurchases> purcahses)
{
    for (int i = 0; i < purcahses.Count; i++)
    {
        Debug.Log("PLAYER PURCHASES: PRODUCT TAG: " + purcahses[i].tag);
        Debug.Log("PLAYER PURCHASES: PRODUCT ID: " + purcahses[i].productId);
        Debug.Log("PLAYER PURCHASES: PAYLOAD: " + purcahses[i].payload);
        Debug.Log("PLAYER PURCHASES: CREATED AT: " + purcahses[i].createdAt);
        Debug.Log("PLAYER PURCHASES: EXPIRED AT: " + purcahses[i].expiredAt);
        Debug.Log("PLAYER PURCHASES: GIFT: " + purcahses[i].gift);
        Debug.Log("PLAYER PURCHASES: SUBSCRIBED: " + purcahses[i].subscribed);
    }
}
```

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

### Get and iterate event list (JavaScript, Unity)

Source: https://docs.gamepush.com/docs/events/events-api

Lists all events accessible at game start. JavaScript iterates over gp.events.list; Unity calls GP_Events.List() and prints event fields including triggers.

```JavaScript
gp.events.list.forEach((event) => {  
    // event.id  
    // event.tag  
    // event.name  
    // event.description  
    // event.icon  
    // event.isAutoJoin  
    // event.dateStart  
    // event.dateEnd  
    // event.timeLeft  
    // event.triggers  
});  

```

```C#
EventData[] eventsData = GP_Events.List();  
foreach (EventData data in eventsData)  
{  
    Debug.Log("ID: " + data.id);  
    Debug.Log("Tag: " + data.tag);  
    Debug.Log("Name: " + data.name);  
    Debug.Log("Description: " + data.description);  
    Debug.Log("Icon: " + data.icon);  
    Debug.Log("Icon small: " + data.iconSmall);  
    Debug.Log("Date Start: " + data.dateStart);  
    Debug.Log("Date End: " + data.dateEnd);  
    Debug.Log("Is Active: " + data.isActive);  
    Debug.Log("Time left: " + data.timeLeft);  
    Debug.Log("Is Auto join: " + data.isAutoJoin);  
  
    foreach (TriggerData trigger in data.triggers)  
    {  
        Debug.Log("Trigger: " + JsonUtility.ToJson(trigger));  
    }  
}  

```

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

### Initialize GamePush SDK and wait for player sync

Source: https://docs.gamepush.com/docs/get-start/getting-started

After SDK initialization, onGPInit is called with a ready-to-use SDK instance. Use await gp.player.ready to wait for player synchronization, then show the ad preloader and sticky banner before starting the game.

```html
// place the code before the closing body tag  
<script>  
window.onGPInit = async (gp) => {  
    // Wait while the player syncs with the server  
    await gp.player.ready;  
    // Show the ad preloader and wait until it ends  
    await gp.ads.showPreloader();  
    // Show the sticky banner (then it will update itself)  
    gp.ads.showSticky();  
  
    // You can start the game :)  
};  
((s,c,o,r,e)=>{var f=0,t={},p=0,m=r.length,w=[],j=u=>{if(f||t[u])return;f=1;t[u]=1;var d=c.createElement(o);d.async=1;d.src=u+e;d.onerror=()=>{f=0;n()};var a=c.getElementsByTagName(o)[0];a.parentNode.insertBefore(d,a)},n=()=>{for(var k=0;k<w.length;k++)if(!t[w[k]])return j(w[k])},q=()=>{++p>=m&&!f&&n()};r.forEach(u=>s.fetch(u,{method:"HEAD"}).then(x=>{x&&x.ok?(w.push(u),j(u)):q()}).catch(q));s.setTimeout(()=>{f||n()},5000)})(window,document,"script",atob("aHR0cHM6Ly9ncy5lcG9uZXNoLmNvbS9zZGsvZ2FtZS1zY29yZS5qcyxodHRwczovL3MzLmdhbWVwdXNoLmNvbS9maWxlcy9ncy9zZGsvZ2FtZS1zY29yZS5qcyxodHRwczovL3MzLWV1LmdhbWVwdXNoLmNvbS9zZGsvZ2FtZS1zY29yZS5qcyxodHRwczovL2dhbWVwdXNoLmNvbS9zZGsvZ2FtZS1zY29yZS5qcw==").split(","),"?projectId=4&publicToken=xT3RpsJMXpKWHPrTWkv3VBeHJKvCBccT&callback=onGPInit");  
</script>  
```

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

### Fetch products in Unity C#

Source: https://docs.gamepush.com/docs/purchases/payments

Unity C# example for fetching products using GP_Payments.Fetch(). Subscribe to OnFetchProducts and OnFetchProductsError events in OnEnable and unsubscribe in OnDisable. The success callback logs product details including ID, tag, name, price, currency, and subscription info.

```csharp
// Subscribe to events  
private void OnEnable()  
{  
    GP_Payments.OnFetchProducts += OnFetchProducts;  
    GP_Payments.OnFetchProductsError += OnFetchProductsError;  
}  
  
// Unsubscribe from events  
private void OnDisable()  
{  
    GP_Payments.OnFetchProducts -= OnFetchProducts;  
    GP_Payments.OnFetchProductsError -= OnFetchProductsError;  
}  
  
// Fetch the list of products through  
public void FetchProducts() => GP_Payments.Fetch()  
  
// Successfully received  
private void OnFetchProducts(List<FetchProducts> products)  
{  
    for (int i = 0; i < products.Count; i++)  
    {  
        Debug.Log("PRODUCT: ID: " + products[i].id);  
        Debug.Log("PRODUCT: TAG: " + products[i].tag);  
        Debug.Log("PRODUCT: NAME: " + products[i].name);  
        Debug.Log("PRODUCT: DESCRIPTION: " + products[i].description);  
        Debug.Log("PRODUCT: ICON: " + products[i].icon);  
        Debug.Log("PRODUCT: ICON SMALL: " + products[i].iconSmall);  
        Debug.Log("PRODUCT: PRICE: " + products[i].price);  
        Debug.Log("PRODUCT: CURRENCY: " + products[i].currency);  
        Debug.Log("PRODUCT: CURRENCY SYMBOL: " + products[i].currencySymbol);  
        Debug.Log("PRODUCT: IS SUBSCRIPTION: " + products[i].isSubscription);  
        Debug.Log("PRODUCT: PERIOD: " + products[i].period);  
        Debug.Log("PRODUCT: TRIAL PERIOD: " + products[i].trialPeriod);  
    }  
}  
  
// Errors by getting  
private void OnFetchProductsError() => Debug.Log("FETCH PRODUCTS: ERROR");
```

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

### Get unique value by tag

Source: https://docs.gamepush.com/docs/uniques

Retrieves a unique value by tag. The JavaScript version returns a string; the Unity version returns a string. The Construct 3 example is shown as a visual action sequence.

```javascript
// Get  
const value = gp.uniques.get('login'); // string  

```

```csharp
// Get  
string value = GP_Uniques.Get("login");  

```

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

### Construct 3: Connect and configure after host selection

Source: https://docs.gamepush.com/docs/multiplayer/player-state

Construct 3 event sheet actions to connect to a channel and then configure player initialization after the connection succeeds. Uses GP_Channels and GamePush plugins.

```construct3
→System
On start of layout
GP_Channels
Multiplayer: Connect to channel **123**
System
Wait for previous actions
Add action
GamePush
Is Last Action Success
configure player initialization after connect
Add action
LegendSystemGP_ChannelsGamePush
  * System›Construct 3 System object
  * GP_Channels›GamePush Channels plugin
  * GamePush›GamePush plugin
```

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

### Get time until full energy restoration (Unity C#)

Source: https://docs.gamepush.com/docs/player/energy

Unity C# example that retrieves the seconds until full energy restoration via GP_Player.GetInt("energy:secondsLeftTotal") and formats it using FormatTime.

```C#
// Time until full restoration in a human-readable format like 05:47  
public string GetSecondsLeftTotalHuman()  
{  
    int secondsLeftTotal = GP_Player.GetInt("energy:secondsLeftTotal");  
    // Return in a human-readable format  
    return FormatTime(secondsLeftTotal);  
}  
```

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

### Freeze Loyalty Decrease with Subscription (JavaScript)

Source: https://docs.gamepush.com/docs/player/energy

JavaScript example for freezing loyalty decrease via a subscription. Uses gp.payments.subscribe, gp.player.set, and gp.player.sync. On game start, checks subscription and loyalty state to freeze or unfreeze.

```javascript
// Buy a loyalty pass  
async function buyLoyaltyPass() {  
    // Subscribe to the loyalty pass  
    await gp.payments.subscribe({ tag: 'LOYALTY_PASS' });  
    // Freeze the decrease of loyalty points  
    gp.player.set('loyalty:incrementValue', 0);  
    // Save  
    gp.player.sync();  
}  
  
// Upon game start  
async function onGameStart() {  
    // Check if the decrease of loyalty points is frozen  
    const isLoyaltyFrozen = gp.player.get('loyalty');  
  
    // Check for the presence of a subscription  
    if (gp.payments.has('LOYALTY_PASS')) {  
        // Subscription exists, but loyalty is not frozen  
        // There may have been issues with processing the purchase  
        if (!isLoyaltyFrozen) {  
            // Freeze the decrease of loyalty points  
            gp.player.set('loyalty:incrementValue', 0);  
            // Save  
            await gp.player.sync();  
        }  
    } else if (isLoyaltyFrozen) {  
        // Subscription expired but loyalty is still frozen  
  
        // Unfreeze the decrease of loyalty points  
        gp.player.set('loyalty:incrementValue', -100);  
        // Save  
        await gp.player.sync();  
    }  
}  

```

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

### Initialize global state on host (JavaScript)

Source: https://docs.gamepush.com/docs/multiplayer/global-state

Sets up host state and calls setGlobalState() when becoming host. Clears state when becoming peer. Uses gp.multiplayer.globalState with fallback object.

```JavaScript
let hostState = null;  
  
function startHostLogic() {  
    hostState = gp.multiplayer.globalState ?? {  
        enemies: [],  
        items: [],  
        round: {  
            number: 1,  
            timeLeft: 60,  
            status: 'playing',  
        },  
    };  
  
    gp.multiplayer.setGlobalState(hostState);  
}  
  
function stopHostLogic() {  
    hostState = null;  
}  
  
gp.multiplayer.on('becameHost', startHostLogic);  
gp.multiplayer.on('becamePeer', stopHostLogic);  

```

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

### Connect to a room with lifecycle events (Unity)

Source: https://docs.gamepush.com/docs/multiplayer/connection

C# example for Unity: subscribes to 'connect' and 'disconnect' events, then connects to a channel using GP_Multiplayer.connect with a MultiplayerChannelQuery. Note: calling connect() while already connected throws an error.

```csharp
const int channelId = 123;  
  
void OnConnect(GP_Data data)  
{  
    Debug.Log("Connected: " + data.Data);  
}  
  
void OnDisconnect(GP_Data data)  
{  
    Debug.Log("Disconnected: " + data.Data);  
}  
  
async void ConnectToRoom()  
{  
    GP_Multiplayer.on("connect", OnConnect);  
    GP_Multiplayer.on("disconnect", OnDisconnect);  
  
    await GP_Multiplayer.connect(new MultiplayerChannelQuery  
    {  
        channelId = channelId  
    });  
}  

```

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

### Freeze Loyalty Decrease with Subscription (Unity C#)

Source: https://docs.gamepush.com/docs/player/energy

Unity C# example for freezing loyalty decrease via a subscription. Uses GP_Payments.Subscribe, GP_Player.Set, and GP_Player.Sync. On game start, checks subscription and loyalty state to freeze or unfreeze.

```csharp
// Buy a loyalty pass  
public void BuyLoyaltyPass() {  
    // Subscribe to the loyalty pass  
    GP_Payments.Subscribe("LOYALTY_PASS", OnSubscribeSuccess);  
}  
  
// The player has subscribed  
private void OnSubscribeSuccess(string idOrTag){  
    if(idOrTag == "LOYALTY_PASS"){  
        GP_Player.Set("LOYALTY_PASS", true);  
        // Freeze the decrease of loyalty points  
        GP_Player.Set("loyalty:incrementValue", 0);  
        GP_Player.Set("loyaltyFrozen", true);  
        // Save  
        GP_Player.Sync();  
    }  
}  
  
// Upon game start  
async function onGameStart() {  
    // Check if the decrease of loyalty points is frozen  
    const isLoyaltyFrozen = gp.player.get('loyalty');  
  
    // Check for the presence of a subscription  
    if (GP_Player.Has("LOYALTY_PASS")) {  
        // Subscription exists, but loyalty is not frozen  
        // There may have been issues with processing the purchase  
        if (!isLoyaltyFrozen) {  
            // Freeze the decrease of loyalty points  
            GP_Player.Set("loyalty:incrementValue", 0);  
            // Save  
            GP_Player.Sync();  
        }  
    } else if (isLoyaltyFrozen) {  
        // Subscription expired but loyalty is still frozen  
  
        // Unfreeze the decrease of loyalty points  
        GP_Player.Set("loyalty:incrementValue", -100);  
        // Save  
        GP_Player.Sync();  
    }  
}  

```

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

### Get time until next energy restoration (Unity C#)

Source: https://docs.gamepush.com/docs/player/energy

Unity C# example that retrieves the seconds until the next energy restoration via GP_Player.GetInt("energy:secondsLeft") and formats it as mm:ss using FormatTime and Pad.

```C#
// Time until the next energy restoration in a human-readable format like 05:47  
public string GetSecondsLeftHuman()  
{  
    int secondsLeft = GP_Player.GetInt("energy:secondsLeft");  
    return FormatTime(secondsLeft);  
}  
  
// Format into a human-readable format like 00:00  
private string FormatTime(int seconds)  
{  
    int minutes = Mathf.FloorToInt((seconds % 3600) / 60);  
    int remainingSeconds = seconds % 60;  
    return $"{Pad(minutes)}:{Pad(remainingSeconds)}";  
}  
  
// Add leading zeros  
private string Pad(int num)  
{  
    return num.ToString("D2");  
}  
```

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

### JavaScript: gp.gameplayStart() and gp.gameplayStop()

Source: https://docs.gamepush.com/docs/get-start/common-features

Call gp.gameplayStart() immediately before gameplay begins and gp.gameplayStop() immediately after it ends. Required for platforms like POKI and CrazyGames.

```javascript
// Notify when gameplay starts  
gp.gameplayStart();  
  
// Notify when finished  
gp.gameplayStop();  
```

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

### Get server time with gp.serverTime

Source: https://docs.gamepush.com/docs/get-start/common-features

Retrieve the read-only server time in ISO 8601 format and use it to implement a reward cooldown. The example checks if an hour has passed since the last reward and updates the player's stored time.

```javascript
// Read-only current server time in ISO 8601 format  
gp.serverTime;  
  
// Example of using  
// One hour in milliseconds  
const HOUR = 60 * 60 * 1000;  
// Current time  
const currentDate = new Date(gp.serverTime);  
// Previous reward time  
const lastDate = new Date(  
  gp.player.get("lastRewardTime") || currentDate - HOUR  
);  
  
// If an hour of playing time has passed, we give a reward  
// And update the time of last reward  
if (currentDate - lastDate > HOUR) {  
  gp.player.add("gold", 5000);  
  gp.player.set("lastRewardTime", currentDate.toISOString());  
}  

```

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

### List all schedulers (Unity C#)

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Unity C# example using GP_Schedulers.List() to retrieve all schedulers and log their ID, tag, and days.

```C#
SchedulerData[] schedulerData = GP_Schedulers.List();  
            
foreach (SchedulerData data in schedulerData)  
{  
    Debug.Log("ID: " + data.id);  
    Debug.Log("Tag: " + data.tag);  
    Debug.Log("Days: " + data.days);  
}  

```

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

### Get GamePush SDK and Native SDK in Construct 3

Source: https://docs.gamepush.com/docs/platforms

Use this snippet in Construct 3 to access the GamePush SDK and native platform SDK through the runtime. It is intended for use on the start of layout via the JS runtime, without ACE.

```javascript
// Our implementation
runtime.GamePush.platform.getSDK();

// Native platform SDK
runtime.GamePush.platform.getNativeSDK();
```

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

### Get scheduler information with details (Unity C#)

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Unity C# example using GP_Schedulers.GetScheduler("DAILY_30") to retrieve scheduler info and log its properties, including current day, active days, days claimed, and registration status.

```C#
SchedulerInfo data = GP_Schedulers.GetScheduler("DAILY_30");  
  
Debug.Log("ID: " + data.scheduler.id);  
Debug.Log("Type: " + data.scheduler.type);  
Debug.Log("Current Day: " + data.currentDay);  
Debug.Log("Active Days: " + data.stats.activeDays);  
Debug.Log("Days claimed: " + string.Join(",", data.daysClaimed));  
Debug.Log("Is Registered: " + data.isRegistered);  

```

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

### For Each Product in Construct 3

Source: https://docs.gamepush.com/docs/purchases/payments

Construct 3 event sheet setup to iterate over products and display their properties using the GamePush plugin. Requires a Text object and the GamePush plugin.

```construct3
On start of layout
Add action
GamePush
Payments: For Each Product
product ID
Text
Set text to "ID: " & GamePush.PaymentsCurProductID
product tag
Text
Set text to "Tag: " & GamePush.PaymentsCurProductTag
name in the player's language
Text
Set text to "Name: " & GamePush.PaymentsCurProductName
description in the player's language
Text
Set text to "Description: " & GamePush.PaymentsCurProductDescription
icon URL 256x256
Text
Set text to "Icon: " & GamePush.PaymentsCurProductIcon
icon URL 64x64
Text
Set text to "Icon small: " & GamePush.PaymentsCurProductIconSmall
price
Text
Set text to "Price: " & GamePush.PaymentsCurProductPrice
currency code
Text
Set text to "Currency: " & GamePush.PaymentsCurProductCurrency
currency symbol
Text
Set text to "Symbol: " & GamePush.PaymentsCurProductCurrencySymbol
how many times the player purchased this product
Text
Set text to "Purchases: " & GamePush.PaymentsCurProductPurchases
Add action
LegendSystemGamePushText
```

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

### List all schedulers (Construct 3)

Source: https://docs.gamepush.com/docs/schedulers/schedulers-api

Construct 3 visual scripting example for iterating over all schedulers. Uses GamePush plugin actions and text objects to display scheduler properties.

```Construct 3
GamePush
Schedulers: For each scheduler
scheduler ID
Text
Set text to **"ID: " & GamePush.SchedulersCurID**
scheduler tag
Text
Set text to **"Tag: " & GamePush.SchedulersCurTag**
scheduler type
Text
Set text to **"Type: " & GamePush.SchedulersCurType**
days total
Text
Set text to **"Days: " & GamePush.SchedulersCurDays**
Add action
GamePush
Schedulers: Is current scheduler repeatable
scheduler.isRepeat
Add action
GamePush
Schedulers: For each scheduler triggers
trigger tag (shared TriggersCur* after setTriggerInfo)
Text
Set text to **"Trigger: " & GamePush.TriggersCurTag**
trigger ID
Text
Set text to **"Trigger ID: " & GamePush.TriggersCurID**
Add action
LegendGamePushText
  * GamePush›GamePush plugin
  * Text — Object Text (Text)

```

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

### Choose a file in Construct 3 with GamePush Files

Source: https://docs.gamepush.com/docs/files

Construct 3 event sheet for choosing a file. Use the GamePush plugin's Files: Choose action with "*" for any file or ".txt, .mp4" for a filtered picker. After the action, check Is Last Action Success and set a Text object to GamePush.FilesTempFileUrl to display the temporary blob URL.

```Construct 3
→Button
On clicked
choose any file
GamePush
Files: Choose **"*"** file
System
Wait for previous actions
Add action
GamePush
Is Last Action Success
temporary blob URL
Text
Set text to **GamePush.FilesTempFileUrl**
Add action
→Button
On clicked
choose .txt or .mp4
GamePush
Files: Choose **".txt, .mp4"** file
Add action
LegendButtonGamePushSystemText
  * Button — Object Button (Button)
  * GamePush›GamePush plugin
  * System›Construct 3 System object
  * Text — Object Text (Text)
```

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

### Get current player's local state (JavaScript and Unity)

Source: https://docs.gamepush.com/docs/multiplayer/player-state

Access the current player's local state. In JavaScript, gp.multiplayer.myState returns the state object. In Unity, GP_Multiplayer.myState returns a GP_Data object; the example logs its Data property.

```JavaScript
const myState = gp.multiplayer.myState;  
```

```C#
GP_Data myState = GP_Multiplayer.myState;  
Debug.Log(myState.Data);  
```

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

### Fetch platform variables with client parameters (Unity)

Source: https://docs.gamepush.com/docs/game-variables

Build a `Dictionary<string, string>` with client parameters and pass it to `GP_Variables.FetchPlatformVariables`.

```C#
Dictionary<string, string> dict = new Dictionary<string, string>();  
  
dict.Add("gold", "1000");  
dict.Add("class", "warrior");  
   
GP_Variables.FetchPlatformVariables(dict, OnPlatformFetchSuccess, OnPlatformFetchError);  

```

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

### Get and set field min/max values (Construct 3)

Source: https://docs.gamepush.com/docs/player/player-state

In Construct 3, use the GamePush plugin actions to set the minimum and maximum values of a field, and the PlayerGet expression to read them. The example shows setting 'energy:min' to 0 and 'energy:max' to 100.

```text
→System
On start of layout
minimum value of the field (key:min)
Text
Set text to **"Min: " & GamePush.PlayerGet("energy:min")**
set minimum
GamePush
Player: Set **"energy:min"** to **0**
maximum value of the field (key:max)
Text
Set text to **"Max: " & GamePush.PlayerGet("energy:max")**
set maximum
GamePush
Player: Set **"energy:max"** to **100**
Add action
LegendSystemTextGamePush
  * System›Construct 3 System object
  * Text — Object Text (Text)
  * GamePush›GamePush plugin
```

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

### Unity C#: Instant Open with Gems

Source: https://docs.gamepush.com/docs/player/energy

Unity C# implementation for exchanging gems to instantly open a box. Uses GP_Player.Get and GP_Player.GetInt to read remaining seconds and gems, calculates cost with Mathf.CailToInt, and calls GP_Player.Add and GP_Player.Sync to deduct gems and add the box.

```C#
// Get the cost of instant opening  
private int GetOpenCost() {  
    // Exchange rate of gems to seconds of opening  
    // 1 crystal = 3 minutes (180 seconds)  
    float gemsRate = 1 / 180;  
    // Remaining seconds until opening  
    int secondsLeft = GP_Player.Get("common-boxes:secondsLeft");  
    // Calculate the opening cost  
    return Mathf.CailToInt(secondsLeft * gemsRate);  
}  
  
// When "Open for gems" button is clicked  
public void ButtonInstantOpen() {  
    // Get the opening cost  
    int price = GetOpenCost();  
  
    // Opening time has come, box is already available  
    if (price == 0) {  
        // Hide the button  
        HideInstantOpenButton();  
        return;  
    }  
  
    // Insufficient gems  
    if (GP_Player.GetInt("gems") < price) {  
        ShowModalNotEnoughGems();  
        return;  
    }  
  
    // Deduct the cost from the player's gems  
    GP_Player.Add("gems", - price);  
    // Add the box  
    GP_Player.Add("common-boxes", 1);  
    // Save the player  
    GP_Player.Sync();  
}  

```

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

### JavaScript: fetchPlayerRating with orderBy, order, includeFields, showNearest

Source: https://docs.gamepush.com/docs/leaderboards/player-rating

Use gp.leaderboard.fetchPlayerRating to get the player's position in the rating. The example sorts by 'level' and 'gold' in DESC order, includes 'rank' field, and shows 5 nearest players above and below. The response provides player data, fields, and above/below player lists.

```JavaScript
const result = await gp.leaderboard.fetchPlayerRating({  
    // Sorting by fields from left to right  
    orderBy: ['level', 'gold'],  
    // DESC sorting – big values first, ASC sorting – small values first  
    order: 'DESC',  
    // Include the field list to display in the leaderboard, in addition to orderBy  
    includeFields: ['rank'],  
    // Get N nearest players above and below, maximum 10  
    showNearest: 5,  
});  
  
// Response result  
const { player, fields, abovePlayers, belowPlayers } = result;  
// Player position  
player.position;  
// Player name  
player.name;  
// Player avatar  
player.avatar;  
// Player variables  
player.level;  
player.gold;  
player.myVariable;  
```

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

### Add shortcut (Unity C#)

Source: https://docs.gamepush.com/docs/application/shortcut

Unity C# example using GP_App.AddShortcut with a callback that receives the boolean success result.

```csharp
public void AppShortcut()  
{  
    GP_App.AddShortcut(OnAddShortcut);  
    Debug.Log("Send add shortcut request");  
}  
  
// success: true / false  
private void OnAddShortcut(bool success)  
{  
    Debug.Log("Shortcut result: " + success);  
}  
```

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

### Event on getting value in JavaScript (gp.storage.on('get'))

Source: https://docs.gamepush.com/docs/storage

Subscribes to the 'get' event to receive a callback with the key and value after a value is retrieved.

```JavaScript
// Value retrieved  
gp.storage.on('get', ({ key, value }) => {});  
```

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

### GET GP_Player.GetFieldName

Source: https://docs.gamepush.com/docs/player/player-state

Gets the translated field name by key.

```APIDOC
## [GET] GP_Player.GetFieldName

### Description
Gets the translated field name by key.

### Method
GET

### Endpoint
GP_Player.GetFieldName

### Parameters
#### Query Parameters
- **key** (string) - Required - The key of the field.

### Request Example
```csharp
GP_Player.GetFieldName("score");
```

### Response
#### Success Response (200)
- **name** (string) - The translated field name.

#### Response Example
```json
{
  "name": "Score"
}
```
```

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

### Download and set image in Unity with GP_Images.FormatToPng

Source: https://docs.gamepush.com/docs/images

Downloads an image from a URL and sets it on a UI Image object in Unity. Uses GP_Images.FormatToPng to convert the link to PNG format and GP_Utility.DownloadImageAsync to fetch and assign the image.

```csharp
// UI image object  
Image imageUI;  
// image link  
string imageUrl = "https://cdn.eponesh.com/static/images/97d/ddb/97dddbe1cde68de40bf637349b31f44a.webp";  
  
public async void SetImage()  
{  
    // format link to png  
    string url = GP_Images.FormatToPng(_inputUrl.text);  
    // download and set image   
    await GP_Utility.DownloadImageAsync(url, imageUI);  
}  

```

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

### GET gp.player.getField

Source: https://docs.gamepush.com/docs/player/player-state

Gets the value of a player field by its key.

```APIDOC
## [GET] gp.player.getField

### Description
Gets the value of a player field by its key.

### Method
GET

### Endpoint
gp.player.getField

### Parameters
#### Query Parameters
- **key** (string) - Required - The key of the field to retrieve.

### Request Example
```javascript
gp.player.getField('gold');
```

### Response
#### Success Response (200)
- **value** (any) - The value of the field.

#### Response Example
```json
{
  "value": 100
}
```
```

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

### Initialize global state on host (Unity)

Source: https://docs.gamepush.com/docs/multiplayer/global-state

Unity equivalent of initializing global state. Uses GP_Multiplayer.globalState with a GP_Data fallback and subscribes to becameHost/becamePeer events.

```C#
GP_Data hostState;  
  
void StartHostLogic()  
{  
    hostState = GP_Multiplayer.globalState ?? new GP_Data(@"{  
        ""enemies"": [],  
        ""items"": [],  
        ""round"": {  
            ""number"": 1,  
            ""timeLeft"": 60,  
            ""status"": ""playing""  
        }  
    }");  
  
    GP_Multiplayer.setGlobalState(hostState);  
}  
  
void StopHostLogic() => hostState = null;  
  
GP_Multiplayer.on("becameHost", StartHostLogic);  
GP_Multiplayer.on("becamePeer", StopHostLogic);  

```
Tokens:
Raw