win8_livetile_badge_notification

Create a badge on the game's live tile.

Syntax:

win8_livetile_badge_notification(id);


Argument Description
id This is the badge id and can either be a number or an icon from the badge catalogue.


Returns: N/A


Description

This function will "push" a badge onto the Live Tile of your game. The badge is a small square are on the bottom right of your games Live Tile and can show either a number from 0 to 99 (any value over 99 will be shown as "+99"), or a badge icon. Icons are decided based on the icon string that you pass through the function, which can be any of the following:



NOTE: The background colour for these icons will depend on what you have defined in the "Logos" part of the General section of the Windows 8 tab in the Global Game Settings.

Icon String Badge Catalogue Image
none
No Badge Shown

activity

alert

available

away

busy

unavailable

newMessage

paused

playing

error


attention


Example:

if keyboard_check_pressed(ord("P"))
   {
   if global.Pause
      {
      global.Pause = false;
      win8_livetile_badge_clear();
      }
   else
      {
      global.Pause = true;
      win8_livetile_badge_notification("paused");
      }
   }

The above code will check for the key "P" being pressed and if it is detected, it will toggle the global variable "Paused" to true or false and push a badge onto the Live Tile (or remove it again) based on the value of this variable.


Back: Windows 8
Next: win8_livetile_badge_clear
© Copyright YoYo Games Ltd. 2018 All Rights Reserved