SC_Award

The SC_Award class models an award that is available in a game application.

You must configure awards on the Scoreloop developer website at https://developer.scoreloop.com, where you can specify or edit each of the individual properties for the following class.

Once an award is configured on the website, Scoreloop generates an awards bundle, which must be added to the game project after unzipping it. The awards bundle provides local access to the individual properties like:

Instances of Awards are not created directly, but are specified declaratively in the Scoreloop-generated awards bundle.

Awards are static. You can only query the information defined in an award bundle. You can build a screen to list the awards. Achievements bring life to this screen. Achievement describes if and when user gained an award.

Users unlock an award by meeting a certain value that is set inside the bundle. This is defined as the achieving value for the award. You can configure awards so that this value can be reached in incremental stages, if desired. The number of incremental stages is defined by subtraction: SC_Award_GetAchievingValue() - SC_Award_GetInitialValue().

For example, configure an award with the following properties:
  • Initial value: 0, i.e., the starting value.

  • Achieving value: 10,

  • Then the expected progress tracked by an achievement must fall into range: (0,10), that gives 10 incremental stages.

When the game is played, this might mean that the user must collect 10 secret jewels in order to unlock the award. Before the user finds the first jewel the following is true:
  • Initial value = 0.

With each jewel found, the value is incremented by 1. When the number of jewels found equals the achieving value then the current user achieves the award.

The award identifiers with the reverse DNS style names are used to localize, invoke and increment the object on SC_AchievementsController.

See also:

SC_Achievement, SC_AchievementsController, Awards and Achievements

Last modified: 2013-12-23

comments powered by Disqus