XPG Live

How To: Use Leaderboards on BlackBerry with XPG

Troy (XPG) — Mon, 30 Jan 2012 23:52:33 +0000

This is a continuation of the How To series. This previous post is here.

This article will cover:

Leaderboard types and setup
Accessing leaderboards in game
Posting a score to a leaderboard
Retrieving scores from a leaderboard

Prerequisites

Eclipse with BlackBerry plugin
XPG Live API for BlackBerry
An existing project or XPG Demo Source for BlackBerry

Leaderboard types and setup

In order to setup a leaderboard you’ll need to have a free developer account with XPG and have registered a game in the management app. Assuming you’ve done these things, you can click on the leaderboards tab in the management app and begin defining your leaderboards.

In the above image you can see the leaderboard dialog. As with most display values in the XPG system, the leaderboard name is globalized to help you provide a local experience for the end user. A display image can be defined by clicking the icon in the top right corner. The XPG system allows you to define a game-unique identifier for your leaderboard which is particularly helpful when migrating from another system to XPG, or implementing XPG along side another system. The available score types are Float, Integer, Money, and Time and each can be used with a score order of Ascending or Descending. The score order indicates if the high scores take high ranks (Descending) or if the lower scores take high ranks (Ascending). You can also limit this leaderboard’s availability by game version. Game versions are defined on the Access Keys tab in the Games area of the management app. Each version gets a new access key (or secret key) which positively identifies your game and game version.

Accessing leaderboards in game

As with many things in XPG, accessing leaderboards within your game is very simple. When your game was initialized (discussed in this post) the leaderboards defined in the were loaded in-game. Once these leaderboards were loaded the first page of scores for each of them was also retrieved and loaded.

public ScreenLeaderboard(XPGLeaderboardInfo leaderboard) {
	super(MainScreen.VERTICAL_SCROLL | MainScreen.VERTICAL_SCROLLBAR);

	if (leaderboard == null) {
		close();
	}

	lb = leaderboard;

	grid = new GridFieldManager(20, 1, FIELD_LEFT);
	managerRow1 = new HorizontalFieldManager(FIELD_LEFT);

	labelInfo = new LabelField(lb.getDisplayName());
	managerRow1.add(buttonRefresh);
	managerRow1.add(buttonScoreHigh);
	managerRow1.add(buttonScoreMed);
	managerRow1.add(buttonScoreLow);

	grid.add(labelInfo, FIELD_LEFT);
	grid.add(managerRow1, FIELD_LEFT);
}

Posting a score to a leaderboard

There are overloads provided to work with each of the score types mentioned above. The API will perform local updates of the leaderboard data after posting a score to the server when it detects that no user data from other players has affected the ranking other than the local user. Alternatively, the API will also initiate a full update of the leaderboard local data if it detects that one or more users have affected the leaderboard ranking other than the local user. This is all handled auto-magically in order to conserve bandwidth, processor time, and device battery.

Here is an example of score posting simplicity.

buttonScoreHigh.setCommand(new Command(new CommandHandler() {
	public void execute(ReadOnlyCommandMetadata metadata, Object context) {
		if (userScore != null) {
			XPGAPI.Instance.submitScore(
					lb.getLeaderboardTag(),
					new Double(
							userScore.getUserScore().doubleValue() + 10),
					null);
		} else {
			try {
				XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
						.elementAt(0));
				XPGAPI.Instance.submitScore(
						lb.getLeaderboardTag(),
						new Double(
								score.getUserScore().doubleValue() + 10),
						null);
			} catch (Exception e) {
				XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
						new Double(10), null);
			}
		}
	}
}));

Retrieving scores from a leaderboard

Retrieving scores from XPG is equally simple. The scores are stored locally on the leaderboard instance of the initialized game instance, so there are no collections for you to keep up with and manage on your own. Also, leaderboards support paging, so you are not required to have all the ranked user scores in memory at once.

//Hook event to trigger getting scores
buttonRefresh.setCommand(new Command(new CommandHandler() {
	public void execute(ReadOnlyCommandMetadata metadata, Object context) {
		XPGAPI.Instance.getScores(lb.getLeaderboardTag(), new Long(0),
				null);
	}
}));

//Set GetScores callback
XPGAPI.Instance.setCallbackGetScores(new XPGAPICallbackGetScores() {
	public void gotResponse(XPGAPIResponse response,
			XPGScoresResultInfo body) {
		if (!response.getFailed().booleanValue() && body != null) {
			clearScores();
			scores = body.getScores();
			displayScores();
		}
	}
});

// Clear previously displayed scores
private void clearScores() {
	grid.deleteRange(2, grid.getRowCount() - 2);
}

// Displayed new scores from server
private void displayScores() {
	if (scores != null && scores.size() > 0) {
		for (int i = 0; i < scores.size(); i++) {
			final XPGLeaderboardScoreInfo score = (XPGLeaderboardScoreInfo) scores
					.elementAt(i);
			HorizontalFieldManager hfm = new HorizontalFieldManager(
					FIELD_LEFT);
			LabelField labelUser = new LabelField("User: "
					+ score.getUserNameDisplay());
			labelUser.setMargin(0, 15, 0, 0);
			LabelField labelScore = new LabelField("Score: "
					+ String.valueOf(score.getUserScore()));

			hfm.add(labelUser);
			hfm.add(labelScore);
			grid.add(hfm, Field.FIELD_LEFT);
			if (score.getUserName().equalsIgnoreCase(
					XPGAPI.Instance.getCurrentUser().getUserName())) {
				userScore = score;
			}
		}
	}
}

Full Code

package XPG.Demo.BlackBerry;

import java.util.Vector;

import net.rim.device.api.command.Command;
import net.rim.device.api.command.CommandHandler;
import net.rim.device.api.command.ReadOnlyCommandMetadata;
import net.rim.device.api.ui.Field;
import net.rim.device.api.ui.component.ButtonField;
import net.rim.device.api.ui.component.LabelField;
import net.rim.device.api.ui.container.GridFieldManager;
import net.rim.device.api.ui.container.HorizontalFieldManager;
import net.rim.device.api.ui.container.MainScreen;

import com.xpglive.api.XPGAPI;
import com.xpglive.api.XPGAPICallbackGetScores;
import com.xpglive.api.XPGAPICallbackSubmitScore;
import com.xpglive.api.XPGAPIResponse;
import com.xpglive.api.XPGLeaderboardInfo;
import com.xpglive.api.XPGLeaderboardScoreInfo;
import com.xpglive.api.XPGScoreResultInfo;
import com.xpglive.api.XPGScoresResultInfo;

public class ScreenLeaderboard extends MainScreen {
	private GridFieldManager grid;
	HorizontalFieldManager managerRow1;
	private LabelField labelInfo;
	private ButtonField buttonRefresh = new ButtonField("Refresh");
	private ButtonField buttonScoreHigh = new ButtonField("High");
	private ButtonField buttonScoreMed = new ButtonField("Med");
	private ButtonField buttonScoreLow = new ButtonField("Low");
	private XPGLeaderboardInfo lb;
	private XPGLeaderboardScoreInfo userScore;

	private Vector scores;

	public ScreenLeaderboard(XPGLeaderboardInfo leaderboard) {
		super(MainScreen.VERTICAL_SCROLL | MainScreen.VERTICAL_SCROLLBAR);

		if (leaderboard == null) {
			close();
		}

		lb = leaderboard;

		grid = new GridFieldManager(20, 1, FIELD_LEFT);
		managerRow1 = new HorizontalFieldManager(FIELD_LEFT);

		labelInfo = new LabelField(lb.getDisplayName());
		managerRow1.add(buttonRefresh);
		managerRow1.add(buttonScoreHigh);
		managerRow1.add(buttonScoreMed);
		managerRow1.add(buttonScoreLow);

		grid.add(labelInfo, FIELD_LEFT);
		grid.add(managerRow1, FIELD_LEFT);

		buttonRefresh.setCommand(new Command(new CommandHandler() {
			public void execute(ReadOnlyCommandMetadata metadata, Object context) {
				XPGAPI.Instance.getScores(lb.getLeaderboardTag(), new Long(0),
						null);
			}
		}));

		buttonScoreHigh.setCommand(new Command(new CommandHandler() {
			public void execute(ReadOnlyCommandMetadata metadata, Object context) {
				if (userScore != null) {
					XPGAPI.Instance.submitScore(
							lb.getLeaderboardTag(),
							new Double(
									userScore.getUserScore().doubleValue() + 10),
							null);
				} else {
					try {
						XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
								.elementAt(0));
						XPGAPI.Instance.submitScore(
								lb.getLeaderboardTag(),
								new Double(
										score.getUserScore().doubleValue() + 10),
								null);
					} catch (Exception e) {
						XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
								new Double(10), null);
					}
				}
			}
		}));

		buttonScoreMed.setCommand(new Command(new CommandHandler() {
			public void execute(ReadOnlyCommandMetadata metadata, Object context) {
				if (userScore != null) {
					XPGAPI.Instance.submitScore(
							lb.getLeaderboardTag(),
							new Double(
									userScore.getUserScore().doubleValue() + 5),
							null);
				} else {
					try {
						XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
								.elementAt(0));
						XPGAPI.Instance.submitScore(
								lb.getLeaderboardTag(),
								new Double(
										score.getUserScore().doubleValue() + 5),
								null);
					} catch (Exception e) {
						XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
								new Double(5), null);
					}
				}
			}
		}));

		buttonScoreLow.setCommand(new Command(new CommandHandler() {
			public void execute(ReadOnlyCommandMetadata metadata, Object context) {
				if (userScore != null) {
					XPGAPI.Instance.submitScore(
							lb.getLeaderboardTag(),
							new Double(
									userScore.getUserScore().doubleValue() + 1),
							null);
				} else {
					try {
						XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
								.elementAt(0));
						XPGAPI.Instance.submitScore(
								lb.getLeaderboardTag(),
								new Double(
										score.getUserScore().doubleValue() + 1),
								null);
					} catch (Exception e) {
						XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
								new Double(1), null);
					}
				}
			}
		}));

		XPGAPI.Instance.setCallbackGetScores(new XPGAPICallbackGetScores() {
			public void gotResponse(XPGAPIResponse response,
					XPGScoresResultInfo body) {
				if (!response.getFailed().booleanValue() && body != null) {
					clearScores();
					scores = body.getScores();
					displayScores();
				}
			}
		});

		XPGAPI.Instance.setCallbackSubmitScore(new XPGAPICallbackSubmitScore() {
			public void gotResponse(XPGAPIResponse response,
					XPGScoreResultInfo body) {
				if (!response.getFailed().booleanValue() && body != null) {
					XPGAPI.Instance.getScores(lb.getLeaderboardTag(), new Long(
							0), null);
				}
			}
		});

		add(grid);

		if (lb.getScores() != null && lb.getScores().size() > 0) {
			clearScores();
			scores = lb.getScores();
			displayScores();
		}
	}

	private void clearScores() {
		grid.deleteRange(2, grid.getRowCount() - 2);
	}

	private void displayScores() {
		if (scores != null && scores.size() > 0) {
			for (int i = 0; i < scores.size(); i++) {
				final XPGLeaderboardScoreInfo score = (XPGLeaderboardScoreInfo) scores
						.elementAt(i);
				HorizontalFieldManager hfm = new HorizontalFieldManager(
						FIELD_LEFT);
				LabelField labelUser = new LabelField("User: "
						+ score.getUserNameDisplay());
				labelUser.setMargin(0, 15, 0, 0);
				LabelField labelScore = new LabelField("Score: "
						+ String.valueOf(score.getUserScore()));

				hfm.add(labelUser);
				hfm.add(labelScore);
				grid.add(hfm, Field.FIELD_LEFT);
				if (score.getUserName().equalsIgnoreCase(
						XPGAPI.Instance.getCurrentUser().getUserName())) {
					userScore = score;
				}
			}
		}
	}
}

How To: Use Leaderboards on Android with XPG

Troy (XPG) — Mon, 30 Jan 2012 23:14:43 +0000

This is a continuation of the How To series. This previous post is here.

This article will cover:

Leaderboard types and setup
Accessing leaderboards in game
Posting a score to a leaderboard
Retrieving scores from a leaderboard

Prerequisites

Android SDK
Eclipse or Visual Studio with MonoDroid
XPG Live API for Android or MonoDroid
An existing project or XPG Demo Source for Android or MonoDroid

Leaderboard types and setup

Accessing leaderboards in game

Java Code

@Override
protected void onStart() {
	super.onStart();
	position = this.getIntent().getIntExtra("position", 0);
	lb = XPGAPI.Instance.getCurrentGame().getLeaderboards().get(position);

	if (lb == null) {
		onBackPressed();
	}

	Button refreshButton = (Button) findViewById(R.id.lbview_buttonRefresh);
	refreshButton.setOnClickListener(new OnRefreshClicked());

	Button scoreHighButton = (Button) findViewById(R.id.lbview_scoreHigh);
	scoreHighButton.setOnClickListener(new OnScoreHighClicked());

	Button scoreMedButton = (Button) findViewById(R.id.lbview_scoreMed);
	scoreMedButton.setOnClickListener(new OnScoreMedClicked());

	Button scoreLowButton = (Button) findViewById(R.id.lbview_scoreLow);
	scoreLowButton.setOnClickListener(new OnScoreLowClicked());

	scores = lb.getScores();

	TextView tt = (TextView) findViewById(R.id.lbview_name);
	if (tt != null) {
		tt.setText(lb.getDisplayName());
	}

	if (scores != null && scores.size() > 0) {
		ListView lv = (ListView) findViewById(R.id.lbview_items);
		lv.setAdapter(new AdapterLeaderboardScores(
				ActivityLeaderboard.this, R.layout.lbview_listitem, scores));
	}

	XPGAPI.Instance.setCallbackSubmitScore(new SubmitScoreCompleted());
}

C# Code

protected override void OnStart()
{
	base.OnStart();
	position = this.Intent.GetIntExtra("position", 0);

	try
	{
		lb = XPGAPI.Instance.CurrentGame.Leaderboards[position];
	}
	catch
	{
		OnBackPressed();
	}

	if (lb == null) { OnBackPressed(); }

	scores = lb.Scores.ToList();

	Button refreshButton = FindViewById

Posting a score to a leaderboard

There are overloads in C# and Java provided to work with each of the score types mentioned above. The API will perform local updates of the leaderboard data after posting a score to the server when it detects that no user data from other players has affected the ranking other than the local user. Alternatively, the API will also initiate a full update of the leaderboard local data if it detects that one or more users have affected the leaderboard ranking other than the local user. This is all handled auto-magically in order to conserve bandwidth, processor time, and device battery.

Here is an example of score posting simplicity.

Java Code

private class OnScoreHighClicked implements OnClickListener {
	@Override
	public void onClick(View arg0) {
		if (userScore != null) {
			XPGAPI.Instance.submitScore(lb.getLeaderboardTag(), new Double(
					userScore.getUserScore().doubleValue() + 10), null);
		} else {
			try {
				XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
						.get(0));
				XPGAPI.Instance
						.submitScore(lb.getLeaderboardTag(), new Double(
								score.getUserScore().doubleValue() + 10),
								null);
			} catch (Exception e) {
				XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
						new Double(10), null);
			}
		}
	}
}

C# Code

public void OnScoreHighClicked(object sender, EventArgs e)
{
	if (userScore != null)
	{
		XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, userScore.UserScore + 10, SubmitScoreCompleted);
	}
	else
	{
		try
		{
			XPGLeaderboardScoreInfo score = scores[0];
			XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, score.UserScore + 10, SubmitScoreCompleted);
		}
		catch (Exception ex)
		{
			XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, 10, SubmitScoreCompleted);
		}
	}
}

Retrieving scores from a leaderboard

Java Code

private class OnRefreshClicked implements OnClickListener {
	@Override
	public void onClick(View arg0) {
		XPGAPI.Instance.getScores(lb.getLeaderboardTag(), 0,
				new GetScoresCompleted());
	}
}

private class GetScoresCompleted extends
			XPGAPICallbackGeneric {
	@Override
	public void gotResponse(
			XPGAPIResponseGeneric response) {
		if (!response.getFailed() && response.getBody() != null) {
			lb = XPGAPI.Instance.getCurrentGame().getLeaderboards()
					.get(position);
			scores = lb.getScores();
			ListView lv = (ListView) findViewById(R.id.lbview_items);
			lv.setAdapter(new AdapterLeaderboardScores(
					ActivityLeaderboard.this, R.layout.lbview_listitem,
					scores));
		} else {
			Toast.makeText(ActivityLeaderboard.this,
					"GetScores failed: " + response.getMessage(),
					Toast.LENGTH_LONG).show();
		}
	}
}

C# Code

public void OnRefreshClicked(object sender, EventArgs e)
	{
		XPGAPI.Instance.GetScores(lb.LeaderboardTag, 0, GetScoresCompleted);
	}

public void GetScoresCompleted(XPGAPIResponse response)
	{
		if (!response.Failed)
		{
			if (response.Body != null && response.Body.Scores != null && response.Body.Scores.Count > 0)
			{
				scores = response.Body.Scores.ToList();
				ListView lv = FindViewById(Resource.Id.lbview_items);
				lv.Adapter = new AdapterLeaderboardScores(this, Resource.Layout.lbview_listitem, scores);
			}
		}
		else
		{
			Toast.MakeText(this, "GetScores failed: " + response.Message, ToastLength.Long).Show();
		}
	}

Full Code

Java Code

package XPG.Demo.Android;

import java.util.ArrayList;

import android.app.Activity;
import android.content.Context;
import android.os.Bundle;
import android.view.LayoutInflater;
import android.view.View;
import android.view.View.OnClickListener;
import android.view.ViewGroup;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.ListView;
import android.widget.TextView;
import android.widget.Toast;

import com.xpglive.api.XPGAPI;
import com.xpglive.api.XPGAPICallbackGeneric;
import com.xpglive.api.XPGAPIResponseGeneric;
import com.xpglive.api.XPGLeaderboardInfo;
import com.xpglive.api.XPGLeaderboardScoreInfo;
import com.xpglive.api.XPGScoreResultInfo;
import com.xpglive.api.XPGScoresResultInfo;

public class ActivityLeaderboard extends Activity {
	XPGLeaderboardInfo lb = null;
	private int position;
	private XPGLeaderboardScoreInfo userScore;
	private ArrayList scores;

	@Override
	protected void onStart() {
		super.onStart();
		position = this.getIntent().getIntExtra("position", 0);
		lb = XPGAPI.Instance.getCurrentGame().getLeaderboards().get(position);

		if (lb == null) {
			onBackPressed();
		}

		Button refreshButton = (Button) findViewById(R.id.lbview_buttonRefresh);
		refreshButton.setOnClickListener(new OnRefreshClicked());

		Button scoreHighButton = (Button) findViewById(R.id.lbview_scoreHigh);
		scoreHighButton.setOnClickListener(new OnScoreHighClicked());

		Button scoreMedButton = (Button) findViewById(R.id.lbview_scoreMed);
		scoreMedButton.setOnClickListener(new OnScoreMedClicked());

		Button scoreLowButton = (Button) findViewById(R.id.lbview_scoreLow);
		scoreLowButton.setOnClickListener(new OnScoreLowClicked());

		scores = lb.getScores();

		TextView tt = (TextView) findViewById(R.id.lbview_name);
		if (tt != null) {
			tt.setText(lb.getDisplayName());
		}

		if (scores != null && scores.size() > 0) {
			ListView lv = (ListView) findViewById(R.id.lbview_items);
			lv.setAdapter(new AdapterLeaderboardScores(
					ActivityLeaderboard.this, R.layout.lbview_listitem, scores));
		}

		XPGAPI.Instance.setCallbackSubmitScore(new SubmitScoreCompleted());
	}

	@Override
	public void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.lbview);
	}

	private class OnRefreshClicked implements OnClickListener {
		@Override
		public void onClick(View arg0) {
			XPGAPI.Instance.getScores(lb.getLeaderboardTag(), 0,
					new GetScoresCompleted());
		}
	}

	private class OnScoreHighClicked implements OnClickListener {
		@Override
		public void onClick(View arg0) {
			if (userScore != null) {
				XPGAPI.Instance.submitScore(lb.getLeaderboardTag(), new Double(
						userScore.getUserScore().doubleValue() + 10), null);
			} else {
				try {
					XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
							.get(0));
					XPGAPI.Instance
							.submitScore(lb.getLeaderboardTag(), new Double(
									score.getUserScore().doubleValue() + 10),
									null);
				} catch (Exception e) {
					XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
							new Double(10), null);
				}
			}
		}
	}

	private class OnScoreMedClicked implements OnClickListener {
		@Override
		public void onClick(View arg0) {
			if (userScore != null) {
				XPGAPI.Instance.submitScore(lb.getLeaderboardTag(), new Double(
						userScore.getUserScore().doubleValue() + 5), null);
			} else {
				try {
					XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
							.get(0));
					XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
							new Double(score.getUserScore().doubleValue() + 5),
							null);
				} catch (Exception e) {
					XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
							new Double(5), null);
				}
			}
		}
	}

	private class OnScoreLowClicked implements OnClickListener {
		@Override
		public void onClick(View arg0) {
			if (userScore != null) {
				XPGAPI.Instance.submitScore(lb.getLeaderboardTag(), new Double(
						userScore.getUserScore().doubleValue() + 1), null);
			} else {
				try {
					XPGLeaderboardScoreInfo score = ((XPGLeaderboardScoreInfo) scores
							.get(0));
					XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
							new Double(score.getUserScore().doubleValue() + 1),
							null);
				} catch (Exception e) {
					XPGAPI.Instance.submitScore(lb.getLeaderboardTag(),
							new Double(1), null);
				}
			}
		}
	}

	private class GetScoresCompleted extends
			XPGAPICallbackGeneric {
		@Override
		public void gotResponse(
				XPGAPIResponseGeneric response) {
			if (!response.getFailed() && response.getBody() != null) {
				lb = XPGAPI.Instance.getCurrentGame().getLeaderboards()
						.get(position);
				scores = lb.getScores();
				ListView lv = (ListView) findViewById(R.id.lbview_items);
				lv.setAdapter(new AdapterLeaderboardScores(
						ActivityLeaderboard.this, R.layout.lbview_listitem,
						scores));
			} else {
				Toast.makeText(ActivityLeaderboard.this,
						"GetScores failed: " + response.getMessage(),
						Toast.LENGTH_LONG).show();
			}
		}
	}

	private class SubmitScoreCompleted extends
			XPGAPICallbackGeneric {
		@Override
		public void gotResponse(
				XPGAPIResponseGeneric response) {
			if (!response.getFailed()) {
				lb = XPGAPI.Instance.getCurrentGame().getLeaderboards()
						.get(position);
				scores = lb.getScores();
				ListView lv = (ListView) findViewById(R.id.lbview_items);
				lv.setAdapter(new AdapterLeaderboardScores(
						ActivityLeaderboard.this, R.layout.lbview_listitem,
						scores));
			} else {
				Toast.makeText(ActivityLeaderboard.this,
						"SubmitScore failed: " + response.getMessage(),
						Toast.LENGTH_LONG).show();
			}
		}
	}

	private class AdapterLeaderboardScores extends
			ArrayAdapter {
		private ArrayList items;

		public AdapterLeaderboardScores(Context context,
				int textViewResourceId,
				ArrayList scoreItems) {
			super(context, textViewResourceId, scoreItems);
			this.items = scoreItems;
		}

		@Override
		public View getView(int position, View convertView, ViewGroup parent) {
			if (convertView == null) {
				LayoutInflater vi = (LayoutInflater) getSystemService(Context.LAYOUT_INFLATER_SERVICE);
				convertView = vi.inflate(R.layout.lbview_listitem, null);
			}
			XPGLeaderboardScoreInfo score = items.get(position);
			if (score != null) {
				if (score.getUserName().equalsIgnoreCase(
						XPGAPI.Instance.getCurrentUser().getUserName())) {
					userScore = score;
				}
				TextView name = (TextView) convertView
						.findViewById(R.id.lbview_itemname);
				if (name != null) {
					name.setText("User: " + score.getUserNameDisplay());
				}
				TextView scoreVal = (TextView) convertView
						.findViewById(R.id.lbview_itemscore);
				if (scoreVal != null) {
					scoreVal.setText("Score: " + score.getUserScore());
				}
			}
			return convertView;
		}
	}

}

C# Code

using System;
using System.Collections.Generic;
using System.Linq;
using Android.App;
using Android.Content;
using Android.OS;
using Android.Util;
using Android.Views;
using Android.Widget;
using XPG.Demo.MonoDroid;

namespace XPG.Demo.Android
{
	[Activity(Label = "XPG Demo MonoDroid")]
	public class ActivityLeaderboard : Activity
	{
		private int position;
		XPGLeaderboardInfo lb = null;
		private XPGLeaderboardScoreInfo userScore;
		private List scores;

		protected override void OnStart()
		{
			base.OnStart();
			position = this.Intent.GetIntExtra("position", 0);

			try
			{
				lb = XPGAPI.Instance.CurrentGame.Leaderboards[position];
			}
			catch
			{
				OnBackPressed();
			}

			if (lb == null) { OnBackPressed(); }

			scores = lb.Scores.ToList();

			Button refreshButton = FindViewById

How To: Use leaderboards on iOS (iPhone/iPad) with XPG

Derik (XPG) — Wed, 25 Jan 2012 20:04:00 +0000

This is a continuation of the How To series. This first post is here.

This article will cover:

Leaderboard types and setup
Accessing leaderboards in game
Posting a score to a leaderboard
Retrieving scores from a leaderboard

Prerequisites

XCode 4 and the iOS SDK
MonoFramework, and MonoDevelop with MonoTouch
XPG Live API for iOS or MonoTouch
An existing project or XPG Demo Source for iOS or MonoTouch

Leaderboard types and setup

Accessing leaderboards in game

As with many things in XPG, accessing leaderboards within your game is very simple. When your game was initialized (discussed in this post) the leaderboards defined in the XPG Management App were loaded in-game. Once these leaderboards were loaded the first page of scores for each of them was also retrieved and loaded. All the objects provided in the XPG API for MonoTouch implement the INotifyPropertyChanged interface to provide UI binding assistance and to help simplify your coding effort.

Objective-C Code

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
	static NSString *CellIdentifier = @"Cell";    
	UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:CellIdentifier];
	if (cell == nil) {
		cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:CellIdentifier] autorelease];
	}
    
	XPGLeaderboardScoreInfo* score = [((XPGLeaderboardInfo*)[[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex]).Scores objectAtIndex:indexPath.row];
	NSNumberFormatter* formatter = [[NSNumberFormatter new] autorelease];
	formatter.numberStyle = NSNumberFormatterDecimalStyle;
		
	UILabel* scoreValLabel = [[UILabel alloc] initWithFrame:CGRectMake(350, 7, 150, 36)];
	scoreValLabel.text = [formatter stringFromNumber:[NSNumber numberWithDouble:score.UserScore]];
	scoreValLabel.textAlignment = UITextAlignmentRight;
		
	cell.textLabel.text = [NSString stringWithFormat:@"%d. %@", score.UserRank, score.UserNameDisplay, nil];
	cell.accessoryView = scoreValLabel;
    
	return cell;
}

C# Code

public override UITableViewCell GetCell(UITableView tableView, MonoTouch.Foundation.NSIndexPath indexPath)
{
	string cellIdentifier = string.Format("CellForSection{0}", indexPath.Section);
	var cell = tableView.DequeueReusableCell(cellIdentifier);
	if(cell == null)
	{
		cell = new UITableViewCell(UITableViewCellStyle.Default, cellIdentifier);
	}

	if(indexPath.Section == 0)
	{
		XPGLeaderboardScoreInfo score = XPGAPI.Instance.CurrentGame.Leaderboards[controller.BoardIndex].Scores[indexPath.Row];

		UILabel scoreValLabel = new UILabel(new RectangleF(350f, 7f, 150f, 36f));
		scoreValLabel.Text = score.UserScore.ToString();
		scoreValLabel.TextAlignment = UITextAlignment.Right;
		
		cell.TextLabel.Text = string.Format("{0}. {1}", score.UserRank, score.UserNameDisplay);
		cell.AccessoryView = scoreValLabel;
	}
	else if(indexPath.Section == 1)
	{
		switch(indexPath.Row)
		{
			case 0:				
				cell.TextLabel.Text = "Post High Score";
				break;
			case 1:				
				cell.TextLabel.Text = "Post Medium Score";
				break;
			case 2:				
				cell.TextLabel.Text = "Post Low Score";
				break;
			case 3:				
				cell.TextLabel.Text = "Refresh Scores";
				break;				
			default:
				break;
		}
	}

	return cell;
}

Posting a score to a leaderboard

There are overloads in C# and additional methods in Objective-C provided to work with each of the score types mentioned above. The API will perform local updates of the leaderboard data after posting a score to the server when it detects that no user data from other players has affected the ranking other than the local user. Alternatively, the API will also initiate a full update of the leaderboard local data if it detects that one or more users have affected the leaderboard ranking other than the local user. This is all handled auto-magically in order to conserve bandwidth, processor time, and device battery.

Here is an example of score posting simplicity.

Objective-C Code

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
	if (indexPath.section == 1)
	{
		XPGLeaderboardInfo* leaderboard = [[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex];
		if (leaderboard != nil)
		{
			NSArray* sortedArray;
			NSArray* sortDescriptors;
			NSSortDescriptor* sortDescriptor;
			double scoreLow, scoreHigh;
			
			sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:@"UserScore" ascending:NO] autorelease];
			sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
			sortedArray = [leaderboard.Scores sortedArrayUsingDescriptors:sortDescriptors];
			
			scoreHigh = ((XPGLeaderboardScoreInfo*)[sortedArray objectAtIndex:0]).UserScore;
			
			sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:@"UserScore" ascending:YES] autorelease];
			sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
			sortedArray = [leaderboard.Scores sortedArrayUsingDescriptors:sortDescriptors];
			
			scoreLow = ((XPGLeaderboardScoreInfo*)[sortedArray objectAtIndex:0]).UserScore;
			
			
			switch (indexPath.row)
			{
				case 0:
					[XPGAPI submitScoreFor:leaderboard.LeaderboardTag withLong:(scoreHigh + 10) andCallback:self];
					break;
				case 1:
					[XPGAPI submitScoreFor:leaderboard.LeaderboardTag withLong:(scoreLow + (scoreHigh - scoreLow)) andCallback:self];
					break;
				case 2:
					[XPGAPI submitScoreFor:leaderboard.LeaderboardTag withLong:(scoreHigh - 10) andCallback:self];
					break;			
				default:
					break;
			}
		}
	}
	
    [tableView deselectRowAtIndexPath:indexPath animated:true];
}

C# Code

public override void RowSelected(UITableView tableView, NSIndexPath indexPath)
{
	if(indexPath.Section == 1)
	{
		double lowScore, highScore;
		XPGLeaderboardInfo leaderboard = XPGAPI.Instance.CurrentGame.Leaderboards[controller.BoardIndex];
		if(leaderboard != null)
		{
			lowScore = leaderboard.Scores.Min(x => x.UserScore);
			highScore = leaderboard.Scores.Max(x => x.UserScore);

			switch(indexPath.Row)
			{
				case 0:
					XPGAPI.Instance.SubmitScore(leaderboard.LeaderboardTag, (highScore + 10), HandleScoreSubmitted);
					break;
				case 1:
					XPGAPI.Instance.SubmitScore(leaderboard.LeaderboardTag, (lowScore + (highScore - lowScore)), HandleScoreSubmitted);
					break;
				case 2:
					XPGAPI.Instance.SubmitScore(leaderboard.LeaderboardTag, (highScore - 10), HandleScoreSubmitted);
					break;				
				default:
					break;
			}
		}
	}

	tableView.DeselectRow(indexPath, true);
}

Retrieving scores from a leaderboard

Objective-C Code

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
	if (indexPath.section == 1)
	{
		XPGLeaderboardInfo* leaderboard = [[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex];
		if (leaderboard != nil)
		{
			switch (indexPath.row)
			{
				case 3:
					[XPGAPI getScoresFor:leaderboard.LeaderboardTag atOffset:0 withCallback:self];
					break;			
				default:
					break;
			}
		}
	}
	
    [tableView deselectRowAtIndexPath:indexPath animated:true];
}

C# Code

public override void RowSelected(UITableView tableView, NSIndexPath indexPath)
{
	if(indexPath.Section == 1)
	{
		XPGLeaderboardInfo leaderboard = XPGAPI.Instance.CurrentGame.Leaderboards[controller.BoardIndex];
		if(leaderboard != null)
		{
			switch(indexPath.Row)
			{
				case 3:
					XPGAPI.Instance.GetScores(leaderboard.LeaderboardTag, 0, HandleScoresObtained);
					break;				
				default:
					break;
			}
		}
	}

	tableView.DeselectRow(indexPath, true);
}

The full code

Objective-C Code

#import 
#import 

@interface LeaderboardViewController : UITableViewController  
{
    int boardIndex;
}

@property (nonatomic) int boardIndex;

-(void)reset;

@end

#import "LeaderboardViewController.h"

@implementation LeaderboardViewController

@synthesize boardIndex;

- (id)initWithStyle:(UITableViewStyle)style
{
    self = [super initWithStyle:style];
    if (self) {
        // Custom initialization
    }
    return self;
}

#pragma mark - View lifecycle

- (void)viewWillAppear:(BOOL)animated
{
    [super viewWillAppear:animated];
	
	XPGLeaderboardInfo* leaderboard = (XPGLeaderboardInfo*)[[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex];
	self.title = leaderboard.DisplayName;
}

- (BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)interfaceOrientation
{
    // Return YES for supported orientations
    return (interfaceOrientation == UIInterfaceOrientationPortrait);
}

#pragma mark - Table view data source

- (NSInteger)numberOfSectionsInTableView:(UITableView *)tableView
{
    return 2;
}

- (NSInteger)tableView:(UITableView *)tableView numberOfRowsInSection:(NSInteger)section
{
	NSInteger retVal = 0;
	
	if (section == 0)
	{
		XPGLeaderboardInfo* leaderboard = (XPGLeaderboardInfo*)[[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex];
		retVal = [leaderboard.Scores count];
	}
	else if (section == 1) { retVal = 4; }
	
	return retVal;
}

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
    static NSString *CellIdentifier = @"Cell";    
    UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:CellIdentifier];
    if (cell == nil) {
        cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:CellIdentifier] autorelease];
    }
    
	if (indexPath.section == 0)
	{
		XPGLeaderboardScoreInfo* score = [((XPGLeaderboardInfo*)[[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex]).Scores objectAtIndex:indexPath.row];
		NSNumberFormatter* formatter = [[NSNumberFormatter new] autorelease];
		formatter.numberStyle = NSNumberFormatterDecimalStyle;
		
		UILabel* scoreValLabel = [[UILabel alloc] initWithFrame:CGRectMake(350, 7, 150, 36)];
		scoreValLabel.text = [formatter stringFromNumber:[NSNumber numberWithDouble:score.UserScore]];
		scoreValLabel.textAlignment = UITextAlignmentRight;
		
		cell.textLabel.text = [NSString stringWithFormat:@"%d. %@", score.UserRank, score.UserNameDisplay, nil];
		cell.accessoryView = scoreValLabel;
	}
	else if (indexPath.section == 1)
	{
		switch (indexPath.row)
		{
			case 0:				
				cell.textLabel.text = @"Post High Score";
				break;
			case 1:				
				cell.textLabel.text = @"Post Medium Score";
				break;
			case 2:				
				cell.textLabel.text = @"Post Low Score";
				break;
			case 3:				
				cell.textLabel.text = @"Refresh Scores";
				break;				
			default:
				break;
		}
	}
    
    return cell;
}

#pragma mark - XPG API delegate

-(void)getScoresCompletedWith:(XPGAPIResponse *)response
{
	[self.tableView reloadData];
}

-(void)submitScoreCompletedWith:(XPGAPIResponse *)response
{
	[self.tableView reloadData];
}

-(void)reset
{
}

#pragma mark - Table view delegate

- (void)tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath
{
	if (indexPath.section == 1)
	{
		XPGLeaderboardInfo* leaderboard = [[XPGAPI getCurrentGame].Leaderboards objectAtIndex:boardIndex];
		if (leaderboard != nil)
		{
			NSArray* sortedArray;
			NSArray* sortDescriptors;
			NSSortDescriptor* sortDescriptor;
			double scoreLow, scoreHigh;
			
			sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:@"UserScore" ascending:NO] autorelease];
			sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
			sortedArray = [leaderboard.Scores sortedArrayUsingDescriptors:sortDescriptors];
			
			scoreHigh = ((XPGLeaderboardScoreInfo*)[sortedArray objectAtIndex:0]).UserScore;
			
			sortDescriptor = [[[NSSortDescriptor alloc] initWithKey:@"UserScore" ascending:YES] autorelease];
			sortDescriptors = [NSArray arrayWithObject:sortDescriptor];
			sortedArray = [leaderboard.Scores sortedArrayUsingDescriptors:sortDescriptors];
			
			scoreLow = ((XPGLeaderboardScoreInfo*)[sortedArray objectAtIndex:0]).UserScore;
			
			
			switch (indexPath.row)
			{
				case 0:
					[XPGAPI submitScoreFor:leaderboard.LeaderboardTag withLong:(scoreHigh + 10) andCallback:self];
					break;
				case 1:
					[XPGAPI submitScoreFor:leaderboard.LeaderboardTag withLong:(scoreLow + (scoreHigh - scoreLow)) andCallback:self];
					break;
				case 2:
					[XPGAPI submitScoreFor:leaderboard.LeaderboardTag withLong:(scoreHigh - 10) andCallback:self];
					break;
				case 3:				
					[XPGAPI getScoresFor:leaderboard.LeaderboardTag atOffset:0 withCallback:self];
					break;				
				default:
					break;
			}
		}
	}
	
    [tableView deselectRowAtIndexPath:indexPath animated:true];
}

@end

C# Code

using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using MonoTouch.Foundation;
using MonoTouch.UIKit;
using XPG;

namespace XPG.Demo.MT
{
	public partial class LeaderboardViewController : UITableViewController
	{
		public int BoardIndex { get; set; }

		//loads the LeaderboardViewController.xib file and connects it to this object
		public LeaderboardViewController() : base ("LeaderboardViewController", null)
		{
		}

		public override void ViewDidLoad()
		{
			base.ViewDidLoad();

			this.Title = XPGAPI.Instance.CurrentGame.Leaderboards[BoardIndex].DisplayName;
			this.TableView.Source = new DataSource(this);
		}
		
		public override bool ShouldAutorotateToInterfaceOrientation(UIInterfaceOrientation toInterfaceOrientation)
		{
			return toInterfaceOrientation.Equals(UIInterfaceOrientation.Portrait);
		}

		public override void DidReceiveMemoryWarning()
		{
			base.DidReceiveMemoryWarning();
		}
		
		public override void ViewDidUnload()
		{
			base.ViewDidUnload();
		}
		
		class DataSource : UITableViewSource
		{
			LeaderboardViewController controller;

			public DataSource(LeaderboardViewController controller)
			{
				this.controller = controller;
			}
			
			// Customize the number of sections in the table view.
			public override int NumberOfSections(UITableView tableView)
			{
				return 2;
			}

			public override int RowsInSection(UITableView tableview, int section)
			{
				return (section == 1 ? 4 : XPGAPI.Instance.CurrentGame.Leaderboards[controller.BoardIndex].Scores.Count);
			}

			// Customize the appearance of table view cells.
			public override UITableViewCell GetCell(UITableView tableView, MonoTouch.Foundation.NSIndexPath indexPath)
			{
				string cellIdentifier = string.Format("CellForSection{0}", indexPath.Section);
				var cell = tableView.DequeueReusableCell(cellIdentifier);
				if(cell == null)
				{
					cell = new UITableViewCell(UITableViewCellStyle.Default, cellIdentifier);
				}

				if(indexPath.Section == 0)
				{
					XPGLeaderboardScoreInfo score = XPGAPI.Instance.CurrentGame.Leaderboards[controller.BoardIndex].Scores[indexPath.Row];

					UILabel scoreValLabel = new UILabel(new RectangleF(350f, 7f, 150f, 36f));
					scoreValLabel.Text = score.UserScore.ToString();
					scoreValLabel.TextAlignment = UITextAlignment.Right;
		
					cell.TextLabel.Text = string.Format("{0}. {1}", score.UserRank, score.UserNameDisplay);
					cell.AccessoryView = scoreValLabel;
				}
				else if(indexPath.Section == 1)
				{
					switch(indexPath.Row)
					{
						case 0:				
							cell.TextLabel.Text = "Post High Score";
							break;
						case 1:				
							cell.TextLabel.Text = "Post Medium Score";
							break;
						case 2:				
							cell.TextLabel.Text = "Post Low Score";
							break;
						case 3:				
							cell.TextLabel.Text = "Refresh Scores";
							break;				
						default:
							break;
					}
				}

				return cell;
			}
			
			public override void RowSelected(UITableView tableView, NSIndexPath indexPath)
			{
				if(indexPath.Section == 1)
				{
					double lowScore, highScore;
					XPGLeaderboardInfo leaderboard = XPGAPI.Instance.CurrentGame.Leaderboards[controller.BoardIndex];
					if(leaderboard != null)
					{
						lowScore = leaderboard.Scores.Min(x => x.UserScore);
						highScore = leaderboard.Scores.Max(x => x.UserScore);

						switch(indexPath.Row)
						{
							case 0:
								XPGAPI.Instance.SubmitScore(leaderboard.LeaderboardTag, (highScore + 10), HandleScoreSubmitted);
								break;
							case 1:
								XPGAPI.Instance.SubmitScore(leaderboard.LeaderboardTag, (lowScore + (highScore - lowScore)), HandleScoreSubmitted);
								break;
							case 2:
								XPGAPI.Instance.SubmitScore(leaderboard.LeaderboardTag, (highScore - 10), HandleScoreSubmitted);
								break;
							case 3:
								XPGAPI.Instance.GetScores(leaderboard.LeaderboardTag, 0, HandleScoresObtained);
								break;				
							default:
								break;
						}
					}
				}

				tableView.DeselectRow(indexPath, true);
			}

			private void HandleScoreSubmitted(XPGAPIResponse response)
			{
				controller.TableView.ReloadData();
			}

			private void HandleScoresObtained(XPGAPIResponse response)
			{
				controller.TableView.ReloadData();
			}
		}
	}
}

How To: Use leaderboards on Windows Phone with XPG

Derik (XPG) — Sat, 21 Jan 2012 16:30:24 +0000

This is a continuation of the How To series. This first post is here.

This article will cover:

Leaderboard types and setup
Accessing leaderboards in game
Posting a score to a leaderboard
Retrieving scores from a leaderboard

Prerequisites

Windows Phone SDK 7.1 for Windows Phone
XPG Live API for Windows Phone
An existing project or XPG Demo Source for Windows Phone

Leaderboard types and setup

Accessing leaderboards in game

As with many things in XPG, accessing leaderboards within your game is very simple. When your game was initialized (discussed in this post) the leaderboards defined in the XPG Management App were loaded in-game. Once these leaderboards were loaded the first page of scores for each of them was also retrieved and loaded. All the objects provided in the XPG API for Windows Phone implement the INotifyPropertyChanged interface to provide UI binding support in XAML and to simplify your coding effort.

Here’s an example of binding to the leaderboard specified in a navigation parameter.

#region OnNavigatedTo
/// Handles the page being navigated to.
/// The arguments.
protected override void OnNavigatedTo(System.Windows.Navigation.NavigationEventArgs e)
{
	base.OnNavigatedTo(e);
	string lbTag = NavigationContext.QueryString["lbTag"];
	if (string.IsNullOrWhiteSpace(lbTag)) { NavigationService.GoBack(); }

	if (XPGAPI.Instance.CurrentGame != null && XPGAPI.Instance.CurrentGame.Leaderboards != null)
	{
		lb = XPGAPI.Instance.CurrentGame.Leaderboards.Where(x => x.LeaderboardTag.Equals(lbTag, StringComparison.OrdinalIgnoreCase)).FirstOrDefault();
		if (lb == null) { NavigationService.GoBack(); }

		SetBinding(DataContextProperty, new Binding() { Source = lb });
	}
}
#endregion OnNavigatedTo

Posting a score to a leaderboard

Here is an example of score posting simplicity.

#region mButtonScoreHigh_Click
/// Handles the high score button being clicked.
/// The sender of the event.
/// The arguments of the event.
private void mButtonScoreHigh_Click(object sender, RoutedEventArgs e)
{
	int scoreUpAmount = 10;
	XPGLeaderboardScoreInfo score = lb.Scores.FirstOrDefault();
	if (score != null)
	{
		XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, score.UserScore + scoreUpAmount, SubmitScoreCompleted);
	}
	else
	{
		XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, scoreUpAmount, SubmitScoreCompleted);
	}
}
#endregion mButtonScoreHigh_Click

Retrieving scores from a leaderboard

#region mButtonRefresh_Click
/// Handles the refresh button being clicked.
/// The sender of the event.
/// The arguments of the event.
private void mButtonRefresh_Click(object sender, RoutedEventArgs e)
{
	// On Windows Phone, this will invoke binding events that update the UI
	XPGAPI.Instance.GetScores(lb.LeaderboardTag, 0, GetScoresCompleted);
}
#endregion mButtonRefresh_Click

The full code

using System;
using System.Linq;
using System.Windows;
using System.Windows.Data;
using Microsoft.Phone.Controls;

namespace XPG.Demo.WinPhone
{
	/// The leaderboard detail page.
	public partial class PageLeaderboard : PhoneApplicationPage
	{
		#region Member Variables

		/// The selected leaderboard.
		private XPGLeaderboardInfo lb;

		#endregion Member Variables

		#region Constructors

		/// Creates a new instance of .
		public PageLeaderboard()
		{
			InitializeComponent();
		}

		#endregion Constructors

		#region Event Handlers

		#region mButtonRefresh_Click
		/// Handles the refresh button being clicked.
		/// The sender of the event.
		/// The arguments of the event.
		private void mButtonRefresh_Click(object sender, RoutedEventArgs e)
		{
			XPGAPI.Instance.GetScores(lb.LeaderboardTag, 0, GetScoresCompleted);
		}
		#endregion mButtonRefresh_Click

		#region mButtonScoreHigh_Click
		/// Handles the high score button being clicked.
		/// The sender of the event.
		/// The arguments of the event.
		private void mButtonScoreHigh_Click(object sender, RoutedEventArgs e)
		{
			int scoreUpAmount = 10;
			XPGLeaderboardScoreInfo score = lb.Scores.FirstOrDefault();
			if (score != null)
			{
				XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, score.UserScore + scoreUpAmount, SubmitScoreCompleted);
			}
			else
			{
				XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, scoreUpAmount, SubmitScoreCompleted);
			}
		}
		#endregion mButtonScoreHigh_Click

		#region mButtonScoreLow_Click
		/// Handles the low score button being clicked.
		/// The sender of the event.
		/// The arguments of the event.
		private void mButtonScoreLow_Click(object sender, RoutedEventArgs e)
		{
			try
			{
				XPGLeaderboardScoreInfo score = lb.Scores[0];
				XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, score.UserScore + 1, SubmitScoreCompleted);
			}
			catch
			{
				XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, 1, SubmitScoreCompleted);
			}
		}
		#endregion mButtonScoreLow_Click

		#region mButtonScoreMed_Click
		/// Handles the medium score button being clicked.
		/// The sender of the event.
		/// The arguments of the event.
		private void mButtonScoreMed_Click(object sender, RoutedEventArgs e)
		{
			try
			{
				XPGLeaderboardScoreInfo score = lb.Scores[0];
				XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, score.UserScore + 5, SubmitScoreCompleted);
			}
			catch
			{
				XPGAPI.Instance.SubmitScore(lb.LeaderboardTag, 5, SubmitScoreCompleted);
			}
		}
		#endregion mButtonScoreMed_Click

		#region OnNavigatedTo
		/// Handles the page being navigated to.
		/// The arguments.
		protected override void OnNavigatedTo(System.Windows.Navigation.NavigationEventArgs e)
		{
			base.OnNavigatedTo(e);
			string lbTag = NavigationContext.QueryString["lbTag"];
			if (string.IsNullOrWhiteSpace(lbTag)) { NavigationService.GoBack(); }

			if (XPGAPI.Instance.CurrentGame != null && XPGAPI.Instance.CurrentGame.Leaderboards != null)
			{
				lb = XPGAPI.Instance.CurrentGame.Leaderboards.Where(x => x.LeaderboardTag.Equals(lbTag, StringComparison.OrdinalIgnoreCase)).FirstOrDefault();
				if (lb == null) { NavigationService.GoBack(); }

				SetBinding(DataContextProperty, new Binding() { Source = lb });
			}
		}
		#endregion OnNavigatedTo

		#endregion Event Handlers

		#region Methods

		#region GetScoresCompleted
		/// Invoked when the get scores call completes.
		/// The servers response.
		public void GetScoresCompleted(XPGAPIResponse response)
		{
			if (!response.Failed)
			{
				lb.Scores.Clear();
				foreach (XPGLeaderboardScoreInfo score in response.Body.Scores)
				{
					lb.Scores.Add(score);
				}
			}
			else
			{
				MessageBox.Show("Request failed: " + response.Message + ".", "XPG Notification", MessageBoxButton.OK);
			}
		}
		#endregion GetScoresCompleted

		#region SubmitScoreCompleted
		/// Invoked when the submit score call completes.
		/// The servers response.
		public void SubmitScoreCompleted(XPGAPIResponse response)
		{
			if (!response.Failed)
			{
				// This is not required, but is shown here for posterity
				XPGAPI.Instance.GetScores(lb.LeaderboardTag, 0, null);
			}
			else
			{
				MessageBox.Show("Request failed. " + response.Message + ".", "XPG Notification", MessageBoxButton.OK);
			}
		}
		#endregion SubmitScoreCompleted

		#endregion Methods
	}
}

How To: Initialize a game on iOS (iPhone/iPad) with XPG

Derik (XPG) — Wed, 11 Jan 2012 17:15:10 +0000

This is a continuation of the How To series. This first post is here.

This article will cover:

Adding the XPG Live API for iOS to your project’s as a framework in XCode
Adding the XPG Live API for MonoTouch reference in MonoDevelop
Initializing the XPG Live API in code
Handling the initialization response

Prerequisites

XCode 4 and the iOS SDK
MonoFramework, and MonoDevelop with MonoTouch
XPG Live API for iOS or MonoTouch
An existing project or XPG Demo Source for iOS or MonoTouch

Adding the XPG Live API for iOS as a framework to your project in XCode

For simplicity sake, and because the source code is freely available, we’ll use the XPG Demo Source for iOS. We’ve also installed the stable release of the XPG Live API for iOS.

In the XCode project navigator, select the top “Project” node
With your target selected in the editor, click the “Build Phases” tab at the top of the editor
Expand the “Link Binary With Libraries” section
Click the “+” button under the list of libraries to open the library chooser
Click the “Add Other…” button to open the finder browse dialog and navigate to “/Developer/XPG/APIs” and select “XPGLive.framework”
Click “Open” to add the framework to your project

Now your project is setup to use XPG Live.

XCode may show the framework in the project root. You can drag this down into the “Frameworks” group for better organization.

Adding the XPG Live API for MonoTouch reference in MonoDevelop

For simplicity sake, and because the source code is freely available, we’ll use the XPG Demo Source for MonoTouch. We’ve also installed the stable release of the XPG Live API for MonoTouch.

Right click the “References” node in your project and select the “Edit References…” option
Click the “.Net Assembly” tab and navigate to “/Developer/XPG/APIs”
Select “XPG.iOS.dll” and click “Add”
Click “OK” to dismiss the window

Now your project is setup to use XPG Live.

Initializing the XPG Live API in code

Game initialization is very simple, but does require that you’re registered a free developer account on XPG Live, create a game and activate your first access key. Since we’re using the demo app we’ve already completed those steps. The first post of this series gives a walk through of the management app and covers games and access keys.

Objective-C Code

static NSString* _secretKey = @"DEMOKEY000000001";

-(void)viewDidLoad
{
	[super viewDidLoad];

	[XPGAPI initializeWith:_secretKey andCallback:nil];
	// Could have also used...
	// [XPGAPI initializeWith:_secretKey andCallback:self];
}

C# Code

private static string _secretKey = @"DEMOKEY000000001";

public override void ViewDidLoad ()
{
	base.ViewDidLoad ();

	XPGAPI.Instance.Initialize (_secretKey, null);
}

This will initialize your game locally unless you haven’t enabled iOS as a platform, you fat fingered the access key, or you forgot to activate the access key for your game. In one of these cases you’ll get back a localized failure response.

Handling the initialization response

The XPG Live API for iOS is pretty flexible when it comes to event handling. In .Net you can handle events on a per call basis with anonymous delegates, delegate method references, or you can wire up event handler to the API instance. In Objective-C you can implement the protocol on a single class and assign it as the API’s delegate, or you can implement the handled methods of the protocol in each class that needs to be notified and pass “self” as the callback parameter of the API methods. The Objective-C protocol defines all methods as optional, so implement what you need and don’t worry about the rest. The API will only invoke one callback per request. If a delegate was provided in the call then it will be invoked, if the delegate passed was null/nil then the API instance event will be raised if there is one.

Additionally, the API will raise events on the UI thread by default. This is done to protect against accidental cross thread access of UI components. The XPG Live API for iOS DOES NOT directly interact with UI components with the exception of social logins which will be discussed in a later post. You can choose to have your delegate raised on a background thread to keep your main thread free for drawing and updates with the following code:

Objective-C Code

[XPGAPI callbackOnUIThread:NO];

C# Code

XPGAPI.Instance.UseUIThreadEvents = false;

If you choose to handle callbacks on background threads it is your responsibility to manage your cross thread interactions appropriately.

Since this is the first callback you’ll always get, this is a great opportunity to mention that when the initialization call is made is when the server becomes aware of the clients locale. This response, and every response after it, will be sent in the clients locale if at all possible, which means that error messages are not only user friendly but in the users language as well. If you defined game titles and descriptions, etc. for your game in the users language they will also be used here.

Here’s a simple callback example for game initialization:

Objective-C Code

/** 
* Handle the API having been initialized.
*/
-(void)initializeCompletedWith:(XPGAPIResponse*)response
{
    if (!response.Failed)
    {
        UIAlertView* alert = [[UIAlertView alloc] initWithTitle:@"XPG Notice" message:@"Initialized" delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil];
        [alert show];
    }
    else
    {
        UIAlertView* alert = [[UIAlertView alloc] initWithTitle:@"XPG Error" message:response.Message delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil];
        [alert show];
    }
}

C# Code

///Handle the API having been initialized.
///The server response to the initialization.
private void HandleXPGAPIInstanceInitializeCompleted (XPGAPIResponse response)
{
	if(!response.Failed)
	{
		UIAlertView alert = new UIAlertView ("XPG Notice", "Initialized", null, "OK", null);
		alert.Show ();
	}
	else
	{
		UIAlertView alert = new UIAlertView ("XPG Error", response.Message, null, "OK", null);
		alert.Show ();
	}
}

You’ll notice that not much is going on here. The XPG Live API for iOS handles it’s state so that your game only needs to be concerned with it’s own state.

During this initialization the background queue will also spin up to process any score postings, achievement awards, or friend requests which might not have made it to the server before the last shut down.

Announcements for your game are also brought down with initialization, so this callback could be useful for alerts or other user notifications. When this callback is raised, the leaderboards will be initializing their first page of the latest scores already, so there isn’t much for you to do other than handle your game logic.

The complete Code

Objective-C Code

//
//  RootViewController.h
//  XPGDemoObjC
//

#import 
#import 

@interface RootViewController : UITableViewController 
{
}

@end

//
//  RootViewController.m
//  XPGDemoObjC
//

#import "RootViewController.h"

@implementation RootViewController

static NSString* _secretKey = @"DEMOKEY000000001";

- (void)viewDidLoad
{
	[super viewDidLoad];

	[XPGAPI setDelegate:self];
	[XPGAPI initializeWith:_secretKey andCallback:nil];
}

// Standard derived/protocol methods and such removed for brevity

-(void)initializeCompletedWith:(XPGAPIResponse*)response
{
	if (!response.Failed)
	{
		UIAlertView* alert = [[UIAlertView alloc] initWithTitle:@"XPG Notice" message:@"Initialized" delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil];
		[alert show];
	}
	else
	{
		UIAlertView* alert = [[UIAlertView alloc] initWithTitle:@"XPG Error" message:response.Message delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil];
		[alert show];
	}
}

@end

C# Code

//
//  RootViewController.cs
//  
//  Author:
//       XPG Inc. 
// 

using System;
using System.Linq;
using System.Drawing;
using MonoTouch.UIKit;
using MonoTouch.Foundation;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using XPG;

namespace XPG.Demo.MT
{
	public partial class RootViewController : UITableViewController
	{
		private static string _secretKey = @"DEMOKEY000000001";

		public RootViewController (string nibName, NSBundle bundle) : base (nibName, bundle)
		{
		}

		public override void ViewDidLoad ()
		{
			base.ViewDidLoad ();

			XPGAPI.Instance.InitializeCompleted += HandleXPGAPIInstanceInitializeCompleted;
			XPGAPI.Instance.Initialize (_secretKey, null);
		}

		// Standard derived methods and such removed for brevity

		///Handle the API having been initialized.
		///The server response to the initialization.
		private void HandleXPGAPIInstanceInitializeCompleted (XPGAPIResponse response)
		{
			if(!response.Failed)
			{
				UIAlertView alert = new UIAlertView ("XPG Notice", "Initialized", null, "OK", null);
				alert.Show ();
			}
			else
			{
				UIAlertView alert = new UIAlertView ("XPG Error", response.Message, null, "OK", null);
				alert.Show ();
			}
		}

		// Data source nested class implementation and such removed for brevity
	}
}

How To: Initialize a game on Android with XPG

Troy (XPG) — Tue, 10 Jan 2012 22:03:45 +0000

This is a continuation of the How To series. This first post is here.

This article will cover:

Adding the XPG Live API for Android to your project’s build path in Eclipse
Adding the XPG Live API for Android reference in Visual Studio
Initializing the XPG Live API in code
Handling the initialization response

Prerequisites

Android SDK
Eclipse or Visual Studio with MonoDroid
XPG Live API for Android or MonoDroid
An existing project or XPG Demo Source for Android or MonoDroid

Adding the XPG Live API for Android to your project’s build path in Eclipse

Copy the XPG.Android_[VERSION].jar and XPG.Android.Doc_[VERSION].jar to your project’s “assets” folder.

In Eclipse, select your project and refresh it

Expand the “assets” folder in your project

Open the context menu on “XPG.Android_[VERSION].jar”

Point to “Build Path” and click “Add to Build Path”

You will see XPG.Android_[VERSION].jar under the “Referenced Libraries” node in your project

Open the context menu for the XPG.Android_[VERSION].jar from the “Referenced Libraries” node

Point to “Build Path” and click “Configure Build Path…”

On the “Libraries” tab, under “XPG.Android_[VERSION].jar, select “Javadoc Location” and click “Edit”

Select “Javadoc in Archive” and “Workspace File”, then click “Browse…”

Expand your project and the “assets” folder, then select “XPG.Android.Doc_[VERSION].jar and click “OK”

Click “OK” again

Now your project is setup to use XPG Live.

Adding the XPG Live API for Android reference in Visual Studio

For simplicity sake, and because the source code is freely available, we’ll use the XPG Demo Source for MonoDroid. We’ve also installed the stable release of the XPG Live API for MonoDroid. This reference dialog may look a bit different than yours because of other installed Visual Studio extensions.

Right click the “References” node in your solution and select the “Add Reference…” option

Click the “Browse…” button and navigate to “C:\Program Files (x86)\XPG\APIs” on 64-bit or “C:\Program Files\XPG\APIs” on 32-bit

Select “XPG.Android.dll” and click “Open”

Click “Add” then click “Close”

Now your project is setup to use XPG Live.

Initializing the XPG Live API in code

Java Code

XPGAPI.Instance.initialize("DEMOKEY000000001", AndroidGameActivity.this, new InitializeCompleted());

C# Code

XPGAPI.Instance.Initialize("DEMOKEY000000001", this, InitializeCompleted);

This will initialize your game locally unless you haven’t enabled Android as a platform, you fat fingered the access key, or you forgot to activate the access key for your game. In one of these cases you’ll get back a localized failure response.

Handling the initialization response

The XPG Live API for Android is pretty flexible when it comes to event handling. You can handle events on a per call basis with anonymous delegates, delegate method references, or you can wire up event handler to the API instance. The API will only invoke one callback per request. If a delegate was provided in the call then it will be invoked, if the delegate passed was null then the API instance event will be raised if there is one.

Additionally, the API will raise events on the UI thread by default. This is done to protect against accidental cross thread access of UI components. The XPG Live API for Android DOES NOT directly interact with UI components with the exception of social logins which will be discussed in a later post. You can choose to have your delegate raised on a background thread to keep your main thread free for drawing and updates with the following code:

Java Code

XPGAPI.Instance.setCallbackOnUiThread(false);

C# Code

XPGAPI.Instance.UseUIThreadEvents = false;

If you choose to handle callbacks on background threads it is your responsibility to manage your cross thread interactions appropriately.

Here’s a simple callback example for game initialization:

Java Code

/** 
* Handle the API having been initialized.
*/
private class InitializeCompleted extends
		XPGAPICallbackGeneric {
	@Override
	public void gotResponse(XPGAPIResponseGeneric response) {
		if (!response.getFailed()) {
			if (response.getBody() == null) {
				Toast.makeText(AndroidGameActivity.this, response.getMessage(), Toast.LENGTH_LONG);
			}
			else {
				/* Use response.getBody() or XPGAPI.Instance to access the game and user */
			}
		}
		else {
			Toast.makeText(AndroidGameActivity.this, response.getMessage(), Toast.LENGTH_LONG);
		}
	}
}

C# Code

///Handle the API having been initialized.
///The server response to the initialization.
public void InitializeCompleted(XPGAPIResponse response)
{
	if (!response.Failed)
	{
		if (response.Body == null)
		{
			Toast.MakeText(this, response.Message, ToastLength.Long).Show();
		}
		else
		{
			// Use response.Body or XPGAPI.Instance to access the game and user
		}
	}
	else
	{
		Toast.MakeText(this, response.Message, ToastLength.Long).Show();
	}
}

You’ll notice that not much is going on here. The XPG Live API for Android handles it’s state so that your game only needs to be concerned with it’s own state.

Announcements for your game are also brought down with initialization, so this callback could be useful for toasts or other user notifications. When this callback is raised, the leaderboards will be initializing their first page of the latest scores already, so there isn’t much for you to do other than handle your game logic.

The complete Code

Java Code

package com.android.game;

import com.xpglive.api.XPGAPI;
import com.xpglive.api.XPGAPICallbackGeneric;
import com.xpglive.api.XPGAPIResponseGeneric;
import com.xpglive.api.XPGInitGameInfo;

import android.app.Activity;
import android.os.Bundle;
import android.widget.Toast;

public class AndroidGameActivity extends Activity {
	/** 
	 * Called when the activity is first created.
	 */
	@Override
	public void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.main);
		XPGAPI.Instance.initialize("DEMOKEY000000001", AndroidGameActivity.this, new InitializeCompleted());
	}

	/** 
	 * Handle the API having been initialized.
	 */
	private class InitializeCompleted extends
			XPGAPICallbackGeneric {
		@Override
		public void gotResponse(XPGAPIResponseGeneric response) {
			if (!response.getFailed()) {
				if (response.getBody() == null) {
					Toast.makeText(AndroidGameActivity.this, response.getMessage(), Toast.LENGTH_LONG);
				}
				else {
					/* Use body or XPGAPI.Instance to access the game and user */
				}
			}
			else {
				Toast.makeText(AndroidGameActivity.this, response.getMessage(), Toast.LENGTH_LONG);
			}
		}
	}
}

C# Code

using System;
using Android.App;
using Android.Content;
using Android.Graphics;
using Android.OS;
using Android.Widget;
using XPG.Demo.MonoDroid;

namespace XPG.Demo.Android
{
	[Activity(Label = "XPG Demo MonoDroid", MainLauncher = true, Icon = "@drawable/Main")]
	public class ActivityMain : Activity
	{
		///Called when the activity is first created.
		///The saved instance state.
		protected override void OnCreate(Bundle bundle)
		{
			base.OnCreate(bundle);
			SetContentView(Resource.Layout.main);
			XPGAPI.Instance.Initialize("DEMOKEY000000001", this, InitializeCompleted);
		}

		///Handle the API having been initialized.
		///The server response to the initialization.
		public void InitializeCompleted(XPGAPIResponse response)
		{
			if (!response.Failed)
			{
				if (response.Body == null)
				{
					Toast.MakeText(this, response.Message, ToastLength.Long).Show();
				}
				else
				{
					// Use response.Body or XPGAPI.Instance to access the game and user
				}
			}
			else
			{
				Toast.MakeText(this, response.Message, ToastLength.Long).Show();
			}
		}
	}
}

How To: Initialize a game on BlackBerry with XPG

Troy (XPG) — Sun, 08 Jan 2012 22:36:34 +0000

This is a continuation of the How To series. The first post is here.

This article will cover:

Adding the XPG Live API for BlackBerry to your project’s build path in Eclipse
Initializing the XPG Live API in code
Handling the initialization response

Prerequisites

Eclipse with BlackBerry plugin
XPG Live API for BlackBerry
An existing project or XPG Demo Source for BlackBerry

Adding the XPG Live API for BlackBerry to your project’s build path in Eclipse

Ensure you have a “lib” folder under your project’s root folder

Copy the XPG.BlackBerry_[VERSION].jar and XPG.BlackBerry.Doc_[VERSION].jar to your project’s “lib” folder.

In Eclipse, select your project and refresh it

Expand the “lib” folder in your project

Open the context menu on “XPG.BlackBerry_[VERSION].jar”

Point to “Build Path” and click “Add to Build Path”

You will see XPG.BlackBerry_[VERSION].jar under the “Referenced Assemblies” node in your project

Open the context menu for the XPG.BlackBerry_[VERSION].jar from the “Referenced Assemblies” node

Point to “Build Path” and click “Configure Build Path…”

On the “Libraries” tab, under “XPG.BlackBerry_[VERSION].jar, select “Javadoc Location” and click “Edit”

Select “Javadoc in Archive” and “Workspace File”, then click “Browse…”

Expand your project and the “lib” folder, then select “XPG.BlackBerry.Doc_[VERSION].jar and click “OK”

Click “OK” again

Select “Order and Export” tab, check the box for “XPG.BlackBerry_[VERSION].jar and click “OK”

Now your project is setup to use XPG Live.

Initializing the XPG Live API in Java code

XPGAPI.Instance.initialize("DEMOKEY000000001", new InitializeCompleted());

This will initialize your game locally unless you haven’t enabled BlackBerry as a platform, you fat fingered the access key, or you forgot to activate the access key for your game. In one of these cases you’ll get back a localized failure response.

Handling the initialization response

The XPG Live API for BlackBerry is pretty flexible when it comes to event handling. You can handle events on a per call basis with anonymous delegates of delegate method references, or you can wire up event handler to the API instance. The API will only invoke one callback per request. If a delegate was provided in the call then it will be invoked, if the delegate passed was null then the API instance event will be raised if there is one.

Additionally, the API will raise events on the UI thread by default. This is done to protect against accidental cross thread access of UI components. The XPG Live API for BlackBerry DOES NOT directly interact with UI components with the exception of social logins which will be discussed in a later post. You can choose to have your delegate raised on a background thread to keep your main thread free for drawing and updates with the following code:

XPGAPI.Instance.setCallbackOnUIThread(false);

If you choose to handle callback on background threads it is your responsibility to manage your cross thread interactions appropriately.

Here’s a simple callback example for game initialization:

private class InitializeCompleted extends XPGAPICallbackInitialize {
	public void gotResponse(XPGAPIResponse response,
			XPGInitGameInfo body) {
		if(!response.getFailed().booleanValue()) {
			if (body == null) {
				Dialog.alert(response.getMessage());
			}
			else {
				/* Use body or XPGAPI.Instance to access the game and user */
			}
		}
		else {
			Dialog.alert(response.getMessage());
		}
	}
}

You’ll notice that not much is going on here. The XPG Live API for BlackBerry handles it’s state so that you’re game only needs to be concerned with it’s own state.

The complete Java Code

package XPG.Demo.BlackBerry;

import com.xpglive.api.XPGAPI;
import com.xpglive.api.XPGAPICallbackInitialize;
import com.xpglive.api.XPGAPIResponse;
import com.xpglive.api.XPGInitGameInfo;

/**
 * A class extending the MainScreen class, which provides default standard
 * behavior for BlackBerry GUI applications.
 */
public final class ScreenMain extends MainScreen {

	/**
	 * Creates a new BlackBerry object
	 */
	public ScreenMain() {
		XPGAPI.Instance.initialize("DEMOKEY000000001", null);
	}

	/**
	 * Handle the API having been initialized.
	 */
	private class InitializeCompleted extends XPGAPICallbackInitialize {
		public void gotResponse(XPGAPIResponse response,
				XPGInitGameInfo body) {
			if(!response.getFailed().booleanValue()) {
				if (body == null) {
					Dialog.alert(response.getMessage());
				}
				else {
					/* Use body or XPGAPI.Instance to access the game and user */
				}
			}
			else {
				Dialog.alert(response.getMessage());
			}
		}
	}
}

How To: Initialize a game on Windows Phone with XPG

Derik (XPG) — Thu, 05 Jan 2012 06:20:00 +0000

This is a continuation of the How To series. This first post is here.

This article will cover:

Adding the XPG Live for Windows Phone reference in Visual Studio
Initializing the XPG Live API in C# code
Handling the initialization response

Prerequisites

Windows Phone SDK 7.1 for Windows Phone
XPG Live API for Windows Phone
An existing project or XPG Demo Source for Windows Phone

Adding the XPG Live for Windows Phone reference in Visual Studio

For simplicity sake, and because the source code is freely available, we’ll use the XPG Demo Source for Windows Phone. We’ve also installed the stable release of the XPG Live API for Windows Phone which will list the assembly needed automatically in the reference dialog. This reference dialog may look a bit different than yours because of other installed Visual Studio extensions.

As with most Visual Studio assemblies, just right click the “References” node in your solution and select the “Add Reference…” option. The XPG.WinPhone assembly will be listed under “Extension” if you have the Productivity Tools installed. Double click the assembly to add it to your project as a reference and close the dialog if it doesn’t close itself.

Initializing the XPG Live API in C# code

string _gameSecretKey = "DEMOKEY000000001";
XPGAPI.Instance.Initialize(_gameSecretKey, Instance_InitializeCompleted);

This will initialize your game locally unless you haven’t enabled Windows Phone as a platform, you fat fingered the access key, or you forgot to activate the access key for your game. In one of these cases you’ll get back a localized failure response.

Handling the initialization response

The XPG Live API for Windows Phone is pretty flexible when it comes to event handling. You can handle events on a per call basis with anonymous delegates of delegate method references, or you can wire up event handler to the API instance. The API will only invoke one callback per request. If a delegate was provided in the call then it will be invoked, if the delegate passed was null then the API instance event will be raised if there is one.

Additionally, the API will raise events on the UI thread by default. This is done to protect against accidental cross thread access of UI components. The XPG Live API for Windows Phone DOES NOT directly interact with UI components with the exception of social logins which will be discussed in a later post. You can choose to have your delegate raised on a background thread to keep your main thread free for drawing and updates with the following code:

XPGAPI.Instance.UseUIThreadEvents = false;

If you choose to handle callback on background threads it is your responsibility to manage your cross thread interactions appropriately.

Here’s a simple callback example for game initialization:

///Handle the API having been initialized.
///The server response to the initialization.
public void Instance_InitializeCompleted(XPGAPIResponse response)
{
	if (!response.Failed)
	{
		if (response.Body == null)
		{
			// Show a simple message so we know it returned successful without a body
			MessageBox.Show(response.Message, "XPG Notification", MessageBoxButton.OK);
		}
	}
	else
	{
		// Show the localized error message
		MessageBox.Show(response.Message, "XPG Notification", MessageBoxButton.OK);
	}
}

You’ll notice that not much is going on here. The XPG Live API for Windows Phone handles it’s state so that you’re game only needs to be concerned with it’s own state.

The complete C# Code

using System.Windows;
using System.Windows.Data;
using Microsoft.Phone.Controls;

namespace XPG.Demo.WinPhone
{
	///The primary application page.
	public partial class PageMain : PhoneApplicationPage
	{
		#region Member Variables

		///The Demo game secret key.
		private string _gameSecretKey = "DEMOKEY000000001";

		#endregion Member Variables

		#region Constructors

		///Creates a new instance of .
		public PageMain()
		{
			InitializeComponent();

			XPGAPI.Instance.Initialize(_gameSecretKey, Instance_InitializeCompleted);
		}

		#endregion Constructors

		#region Methods

		#region Instance_InitializeCompleted
		///Handle the API having been initialized.
		///The server response to the initialization.
		public void Instance_InitializeCompleted(XPGAPIResponse response)
		{
			if (!response.Failed)
			{
				if (response.Body == null)
				{
					MessageBox.Show(response.Message, "XPG Notification", MessageBoxButton.OK);
				}
			}
			else
			{
				MessageBox.Show(response.Message, "XPG Notification", MessageBoxButton.OK);
			}
		}
		#endregion Instance_InitializeCompleted

		#endregion Methods
	}
}

How To: Get started with XPG

Troy (XPG) — Fri, 30 Dec 2011 20:48:00 +0000

This is the first article in a series that will walk you through using all of the features XPG Live has to offer.

Before you can begin using XPG you’ll need to have an XPG Live account.

You’ll notice links in the upper right hand corner of the home page.

You can get an XPG account either by completing our simple registration form or by logging in with you existing Facebook or Twitter account.

Once you’ve registered or logged in you will see your name and a “Log Off” option. XPG Live is Gravatar enabled, so if the email address used in registration is associated to a Gravatar account, there is no need to upload a profile image.

To get to the management area of XPG, you just click on your name or image. When you first arrive in the management section you will have the following tabs available to you “Profile”, “Relationships”, “Messages”, and “Settings”.

The “Profile” page is where you can update basic information (i.e. email, password, name, location, etc.)
The “Relationships” page is where you can send a friend request or respond to incoming requests
The “Messages” page is how you can communicate with your friends on XPG Live.
The “Settings” page allows you to manage profile visibility, notifications, and social accounts. This is where you would go to link a social account if you did not use it to register.

The following steps are intended for developers that are making an XPG Live enabled game.

You will find the “Become a Developer” button near the bottom of the screen on “Profile” page.

After you click this button, you will notice that several of the profile fields have been marked as required. Fill out the additional required information and click the “Save” button.

When the “Please wait…” indicator goes away, you will have the following additional tabs:

The “Publish” page – Manage your publisher specific information
The “Games” page – Manage or create games
The “Leaderboards” page – manage or create leaderboards for your game
The “Achievements” page – manage or create achievements for your game
The “Announcements” page – manage or create announcements for your game

Let’s take a closer look at these pages

The Publish Page

Highlighted in orange is the dropdown that lists all the publishers you own or have access to see. This dropdown also contains a “New Publisher” entry that will allow you to add a publisher.

Highlighted in red is a check box that will indicate the publisher is being created for testing purposes and data associated to it will not be mixed with live data.

The Games Page

Use the “Publishers” dropdown to select the publisher you want to edit a game for

Highlighted in orange is a dropdown that lists all the games associated to the selected publisher. This dropdown also contains a “New Game” entry that will allow you to add a game to the selected publisher.

Highlighted in red is a check box that will indicate the game is being created for testing purposes and data associated to it will not be mixed with live data. This check box is checked and disabled if the publisher is a test only publisher.

Highlighted in green are the game features. Be sure that you check the box for each feature that your game will use.

Highlighted in yellow is the “Add Language” button. This button opens the language selection dialog (below). Check the check boxes next to each language you would like to provide a translation for and those tabs will be added to the property that the “Add Language” button was clicked from.

Below are the additional views for each game

The “Access Key” tab – allows you to add versions of your game
The “Platforms” tab – manage the platforms that your game will be available on and enter your games id from the platform specific store and click “Refresh” button for that platform
The “Images” tab – shows the images that XPG Live automatically imports for you from the platform specific stores

The Leaderboards Page

Highlighted in red are the actions for leaderboard.

From the left:

Edit Leaderboard – displays the leaderboard editing window (below)
Reset Leaderboard – clears scores posted to that leaderboard and cannot be undone
Delete Leaderboard – removes the leaderboard from the game

The Achievements Page

Highlighted in red are the actions for achievement.

From the left:

Edit Achievement – displays the achievement editing window (below)
Reset Achievement – clears all users from having earned the achievement and cannot be undone
Delete Achievement – removes the achievement from the game

The Announcements Page

Highlighted in red are the actions for announcement.

From the left:

Edit Announcement – displays the edit announcement dialog (below)
Delete Announcement – removes the announcement from the game

XPG Live

How To: Use Leaderboards on BlackBerry with XPG

Leaderboard types and setup

Accessing leaderboards in game

Posting a score to a leaderboard

Retrieving scores from a leaderboard

Full Code

How To: Use Leaderboards on Android with XPG

Leaderboard types and setup

Accessing leaderboards in game

Posting a score to a leaderboard

Retrieving scores from a leaderboard

Full Code

How To: Use leaderboards on iOS (iPhone/iPad) with XPG

Leaderboard types and setup

Accessing leaderboards in game

Posting a score to a leaderboard

Retrieving scores from a leaderboard

The full code

How To: Use leaderboards on Windows Phone with XPG

Leaderboard types and setup

Accessing leaderboards in game

Posting a score to a leaderboard

Retrieving scores from a leaderboard

The full code

How To: Initialize a game on iOS (iPhone/iPad) with XPG

Adding the XPG Live API for iOS as a framework to your project in XCode

Adding the XPG Live API for MonoTouch reference in MonoDevelop

Initializing the XPG Live API in code

Handling the initialization response

The complete Code

How To: Initialize a game on Android with XPG

Adding the XPG Live API for Android to your project’s build path in Eclipse

Adding the XPG Live API for Android reference in Visual Studio

Initializing the XPG Live API in code

Handling the initialization response

The complete Code

How To: Initialize a game on BlackBerry with XPG

Adding the XPG Live API for BlackBerry to your project’s build path in Eclipse

Initializing the XPG Live API in Java code

Handling the initialization response

The complete Java Code

How To: Initialize a game on Windows Phone with XPG

Adding the XPG Live for Windows Phone reference in Visual Studio

Initializing the XPG Live API in C# code

Handling the initialization response

The complete C# Code

How To: Get started with XPG

This is the first article in a series that will walk you through using all of the features XPG Live has to offer.

The Publish Page

The Games Page

The Leaderboards Page

The Achievements Page

The Announcements Page

Stay tuned for more in this How To series on XPG Live!