Heatmaps

Following are the steps to use heatmaps:

‍

Step 1

1. Create a game map id in player portal for a game, and copy the game map id

‍

2. Create a heat map id in player portal for a game, and copy the heatmap id

‍

Step 2

‍

Scenario: Let’s say, in this case, we want to keep track of locations where a player dies.

In the game screen below, whenever the player collides with any of the 4 green bricks, we want to create a heatmap with the locations where the player dies.

‍

In any script where you want to register the heatmap, in this case, a script sitting on 4 green cubes called DeathPoint, do the following:

‍

1. Create a variable of type GG_Heatmap in the script where you want to register the heatmap..
2. Grab reference to GG_Heatmap using FindObjectOfType<>.
3. Use the method variableName.MakeHeatmap() to register the heatmap
4. This function takes in the following parameters:

1. Heatmap action id: Get this id from the player portal where you created the heatmap action earlier.
2. Game map id: Get this id from the player portal where you created the game map id earlier.
3. X coordinate: Get the player’s X position 
4. Y coordinate: Get the player’s Y position‍

‍

In the above example, whenever the player enters any of the green cubes, we get the player’s position in OnTriggerEnter, extract the X and Z coordinates, and pass them in the Heatmap() function.

Step 3

‍

To visualize the heatmap, go back to the player portal, and under reports, select heatmap.

‍

You’ll be presented with the screen below as shown below. 

‍

From here, select your 

1. Game
2. Your Game Map
3. Your Heatmap Action

2. Once done, press Get Report, and you will see a heatmap similar like this one: 

‍

If we consider the scenario above, we can see that the green cubes were indeed placed in a shape like shown by the markers in the heatmap above. They were indeed in the (N,E,S,W) points of the actual game map!