Installation

Android

Copy libs folder into your exported project

Copy src folder into your exported project

Add System.loadLibrary("gaming"); to your main activity

Add "com.giderosmobile.android.plugins.gaming.Game" as external class in your main activity

You must install each framework you want to use based on their instalation instructions (usually by adding .jar file to project and modifying AndroidManifest file)

Currently supports:

• Gaming.new("heyzap")
• Gaming.new("googleplay")
• Gaming.new("gamecircle")

IOS

Copy files int your exported project

Add files through xCode

Currently supports:

• Gaming.new("gamekit")

API Reference

Methods

• Gaming.new(framework) -- initialize specified framework
• Gaming.login(param1, param2, ..., paramn) -- authenticate user
• Gaming.logout() -- logout user
• Gaming:showLeaderboard(id) --show leader board window (string leaderboard id)
• Gaming:showAchievements() --show achievements window
• Gaming:reportScore(id, score, immediate) --report new score (string leaderboard Id, number score, bool immediate (true will usually provide events))
• Gaming:reportAchievement(id, steps, immediate) --report new achievement (string achievement Id, number steps - progress of achievement, bool immediate (true will usually provide events))
• Gaming:loadAchievements() --load list of achievements, raises LOAD_ACHIEVEMENTS_COMPLETE or LOAD_ACHIEVEMENTS_ERROR
• Gaming:loadScores(id) --load list of scores for leaderboard Id, raises LOAD_SCORES_COMPLETE or LOAD_SCORES_ERROR
• Gaming:loadState(key) --numeric key, raised STATE_LOADED or STATE_ERROR
• Gaming:updateState(key, data[, immediate]) --update data, numeric key, can raise STATE_CONFLICT or STATE_ERROR
• Gaming:deleteState(key) --delete data for numeric key, can raise STATE_DELETED or STATE_ERROR
• Gaming:resolveState(key, version, data) --resolve state conflict for slot key with version and data, should be called if STATE_CONFLICT event was dispatched, may raise STATE_LOADED event for new resolved data

Events

• Event.LOGIN_COMPLETE
• Event.LOGIN_ERROR
  • e.error - error message
• Event.LOAD_ACHIEVEMENTS_COMPLETE
  • event.achievements
  • event.achievements[].id
  • event.achievements[].name
  • event.achievements[].description
  • event.achievements[].status
  • event.achievements[].currentSteps
  • event.achievements[].totalSteps
  • event.achievements[].lastUpdate
• Event.LOAD_ACHIEVEMENTS_ERROR
  • e.error - error message
• Event.REPORT_ACHIEVEMENT_COMPLETE
  • e.id -- achievement id
• Event.REPORT_ACHIEVEMENT_ERROR
  • e.id -- achievement id
  • e.error - error message
• Event.LOAD_SCORES_COMPLETE
  • event.name -- leader board name
  • event.id -- leader board ID
  • event.scores
  • event.scores[].name
  • event.scores[].timestamp
  • event.scores[].score
  • event.scores[].rank
  • event.scores[].playerId
• Event.LOAD_SCORES_ERROR
  • e.error - error message
  • e.id -- leader board ID
• Event.REPORT_SCORE_COMPLETE
  • e.id - leaderboard id
  • e.score -- score reported
• Event.REPORT_SCORE_ERROR
  • e.id - leaderboard id
  • e.score -- score reported
  • e.error -- error message

Cloud Events

• Event.STATE_LOADED
  • event.key
  • event.data
• Event.STATE_ERROR
  • event.key
• Event.STATE_CONFLICT
  • event.key
  • event.version
  • event.localData
  • event.serverData
• Event.STATE_DELETED
  • event.key