Difference between revisions of "Gaming"

(Methods)
 
Line 18: Line 18:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Methods</translate> ===
 
=== <translate>Methods</translate> ===
[[Special:MyLanguage/Gaming.new|Gaming.new]] <br/><!-- GIDEROSMTD:Gaming.new(backend) -->
+
[[Special:MyLanguage/Gaming.new|Gaming.new]] ''instanciate the Gaming plugin'' <br/><!-- GIDEROSMTD:Gaming.new(backend) instanciate the Gaming plugin -->
 
[[Special:MyLanguage/Gaming:autoMatch|Gaming:autoMatch]] <br/><!-- GIDEROSMTD:Gaming:autoMatch()  -->
 
[[Special:MyLanguage/Gaming:autoMatch|Gaming:autoMatch]] <br/><!-- GIDEROSMTD:Gaming:autoMatch()  -->
[[Special:MyLanguage/Gaming:deleteState|Gaming:deleteState]] <br/><!-- GIDEROSMTD:Gaming:deleteState(key) -->
+
[[Special:MyLanguage/Gaming:deleteState|Gaming:deleteState]] ''remove the specified save/state'' <br/><!-- GIDEROSMTD:Gaming:deleteState(key) remove the specified save/state -->
 
[[Special:MyLanguage/Gaming:getAllPlayers|Gaming:getAllPlayers]] <br/><!-- GIDEROSMTD:Gaming:getAllPlayers()  -->
 
[[Special:MyLanguage/Gaming:getAllPlayers|Gaming:getAllPlayers]] <br/><!-- GIDEROSMTD:Gaming:getAllPlayers()  -->
[[Special:MyLanguage/Gaming:getPlayerId|Gaming:getPlayerId]] <br/><!-- GIDEROSMTD:Gaming:getPlayerId() -->
+
[[Special:MyLanguage/Gaming:getPlayerId|Gaming:getPlayerId]] ''Get the id of current player'' <br/><!-- GIDEROSMTD:Gaming:getPlayerId() Get the id of current player -->
 
[[Special:MyLanguage/Gaming:getPlayerInfo|Gaming:getPlayerInfo]] <br/><!-- GIDEROSMTD:Gaming:getPlayerInfo()  -->
 
[[Special:MyLanguage/Gaming:getPlayerInfo|Gaming:getPlayerInfo]] <br/><!-- GIDEROSMTD:Gaming:getPlayerInfo()  -->
[[Special:MyLanguage/Gaming:getPlayerName|Gaming:getPlayerName]] <br/><!-- GIDEROSMTD:Gaming:getPlayerName() -->
+
[[Special:MyLanguage/Gaming:getPlayerName|Gaming:getPlayerName]] ''Get the name of current player'' <br/><!-- GIDEROSMTD:Gaming:getPlayerName() Get the name of current player -->
[[Special:MyLanguage/Gaming:getPlayerPicture|Gaming:getPlayerPicture]] <br/><!-- GIDEROSMTD:Gaming:getPlayerPicture() -->
+
[[Special:MyLanguage/Gaming:getPlayerPicture|Gaming:getPlayerPicture]] ''Get the profile picture of current player'' <br/><!-- GIDEROSMTD:Gaming:getPlayerPicture() Get the profile picture of current player -->
[[Special:MyLanguage/Gaming:getPlayerScore|Gaming:getPlayerScore]] <br/><!-- GIDEROSMTD:Gaming:getPlayerScore() -->
+
[[Special:MyLanguage/Gaming:getPlayerScore|Gaming:getPlayerScore]] ''Get the score of current player'' <br/><!-- GIDEROSMTD:Gaming:getPlayerScore() Get the score of current player -->
[[Special:MyLanguage/Gaming:incrementAchievement|Gaming:incrementAchievement]] <br/><!-- GIDEROSMTD:Gaming:incrementAchievement(achievementId,numSteps,immediate) -->
+
[[Special:MyLanguage/Gaming:incrementAchievement|Gaming:incrementAchievement]] ''Increment the progress toward an achievement'' <br/><!-- GIDEROSMTD:Gaming:incrementAchievement(achievementId,numSteps,immediate) Increment the progress toward an achievement -->
 
[[Special:MyLanguage/Gaming:invitePlayers|Gaming:invitePlayers]] <br/><!-- GIDEROSMTD:Gaming:invitePlayers()  -->
 
[[Special:MyLanguage/Gaming:invitePlayers|Gaming:invitePlayers]] <br/><!-- GIDEROSMTD:Gaming:invitePlayers()  -->
[[Special:MyLanguage/Gaming:isLoggedIn|Gaming:isLoggedIn]] <br/><!-- GIDEROSMTD:Gaming:isLoggedIn() -->
+
[[Special:MyLanguage/Gaming:isLoggedIn|Gaming:isLoggedIn]] ''Returns the login state in Gaming service'' <br/><!-- GIDEROSMTD:Gaming:isLoggedIn() Returns the login state in Gaming service -->
 
[[Special:MyLanguage/Gaming:joinRoom|Gaming:joinRoom]] <br/><!-- GIDEROSMTD:Gaming:joinRoom()  -->
 
[[Special:MyLanguage/Gaming:joinRoom|Gaming:joinRoom]] <br/><!-- GIDEROSMTD:Gaming:joinRoom()  -->
[[Special:MyLanguage/Gaming:loadAchievements|Gaming:loadAchievements]] <br/><!-- GIDEROSMTD:Gaming:loadAchievements() -->
+
[[Special:MyLanguage/Gaming:loadAchievements|Gaming:loadAchievements]] ''Load all achievements'' <br/><!-- GIDEROSMTD:Gaming:loadAchievements() Load all achievements -->
[[Special:MyLanguage/Gaming:loadPlayerCenteredScores|Gaming:loadPlayerCenteredScores]] <br/><!-- GIDEROSMTD:Gaming:loadPlayerCenteredScores(leaderboardId,timeSpan,collection,maxEntries) -->
+
[[Special:MyLanguage/Gaming:loadPlayerCenteredScores|Gaming:loadPlayerCenteredScores]] ''Load a leaderboard cenetered on the player'' <br/><!-- GIDEROSMTD:Gaming:loadPlayerCenteredScores(leaderboardId,timeSpan,collection,maxEntries) Load a leaderboard cenetered on the player -->
[[Special:MyLanguage/Gaming:loadScores|Gaming:loadScores]] <br/><!-- GIDEROSMTD:Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries) -->
+
[[Special:MyLanguage/Gaming:loadScores|Gaming:loadScores]] ''Load a leaderboard'' <br/><!-- GIDEROSMTD:Gaming:loadScores(leaderboardId,timeSpan,collection,maxEntries) Load a leaderboard -->
[[Special:MyLanguage/Gaming:loadState|Gaming:loadState]] <br/><!-- GIDEROSMTD:Gaming:loadState(key) -->
+
[[Special:MyLanguage/Gaming:loadState|Gaming:loadState]] ''Load a save/state'' <br/><!-- GIDEROSMTD:Gaming:loadState(key) Load a save/state -->
[[Special:MyLanguage/Gaming:login|Gaming:login]] <br/><!-- GIDEROSMTD:Gaming:login() -->
+
[[Special:MyLanguage/Gaming:login|Gaming:login]] ''Log in the Gaming service'' <br/><!-- GIDEROSMTD:Gaming:login() Log in the Gaming service -->
[[Special:MyLanguage/Gaming:logout|Gaming:logout]] <br/><!-- GIDEROSMTD:Gaming:logout() -->
+
[[Special:MyLanguage/Gaming:logout|Gaming:logout]] ''Log out of the gaming service'' <br/><!-- GIDEROSMTD:Gaming:logout() Log out of the gaming service -->
[[Special:MyLanguage/Gaming:reportAchievement|Gaming:reportAchievement]] <br/><!-- GIDEROSMTD:Gaming:reportAchievement(achievementId,numSteps,immediate) -->
+
[[Special:MyLanguage/Gaming:reportAchievement|Gaming:reportAchievement]] ''Report an achievement progress'' <br/><!-- GIDEROSMTD:Gaming:reportAchievement(achievementId,numSteps,immediate) Report an achievement progress -->
[[Special:MyLanguage/Gaming:reportScore|Gaming:reportScore]] <br/><!-- GIDEROSMTD:Gaming:reportScore(leaderboardId,score,immediate) -->
+
[[Special:MyLanguage/Gaming:reportScore|Gaming:reportScore]] ''Report a new score'' <br/><!-- GIDEROSMTD:Gaming:reportScore(leaderboardId,score,immediate) Report a new score -->
[[Special:MyLanguage/Gaming:resolveState|Gaming:resolveState]] <br/><!-- GIDEROSMTD:Gaming:resolveState(key,version,data) -->
+
[[Special:MyLanguage/Gaming:resolveState|Gaming:resolveState]] ''Resolve a save/state conflict'' <br/><!-- GIDEROSMTD:Gaming:resolveState(key,version,data) Resolve a save/state conflict -->
[[Special:MyLanguage/Gaming:revealAchievement|Gaming:revealAchievement]] <br/><!-- GIDEROSMTD:Gaming:revealAchievement(achievementId,immediate) -->
+
[[Special:MyLanguage/Gaming:revealAchievement|Gaming:revealAchievement]] ''Reveal an achievement'' <br/><!-- GIDEROSMTD:Gaming:revealAchievement(achievementId,immediate) Reveal an achievement -->
 
[[Special:MyLanguage/Gaming:sendTo|Gaming:sendTo]] <br/><!-- GIDEROSMTD:Gaming:sendTo()  -->
 
[[Special:MyLanguage/Gaming:sendTo|Gaming:sendTo]] <br/><!-- GIDEROSMTD:Gaming:sendTo()  -->
 
[[Special:MyLanguage/Gaming:sendToAll|Gaming:sendToAll]] <br/><!-- GIDEROSMTD:Gaming:sendToAll()  -->
 
[[Special:MyLanguage/Gaming:sendToAll|Gaming:sendToAll]] <br/><!-- GIDEROSMTD:Gaming:sendToAll()  -->
[[Special:MyLanguage/Gaming:showAchievements|Gaming:showAchievements]] <br/><!-- GIDEROSMTD:Gaming:showAchievements() -->
+
[[Special:MyLanguage/Gaming:showAchievements|Gaming:showAchievements]] ''Show the achievements'' <br/><!-- GIDEROSMTD:Gaming:showAchievements() Show the achievements -->
 
[[Special:MyLanguage/Gaming:showInvitations|Gaming:showInvitations]] <br/><!-- GIDEROSMTD:Gaming:showInvitations()  -->
 
[[Special:MyLanguage/Gaming:showInvitations|Gaming:showInvitations]] <br/><!-- GIDEROSMTD:Gaming:showInvitations()  -->
[[Special:MyLanguage/Gaming:showLeaderboard|Gaming:showLeaderboard]] <br/><!-- GIDEROSMTD:Gaming:showLeaderboard(leaderboardId) -->
+
[[Special:MyLanguage/Gaming:showLeaderboard|Gaming:showLeaderboard]] ''Show a leaderboard'' <br/><!-- GIDEROSMTD:Gaming:showLeaderboard(leaderboardId) Show a leaderboard -->
[[Special:MyLanguage/Gaming:showWaitingRoom|Gaming:showWaitingRoom]] <br/><!-- GIDEROSMTD:Gaming:showWaitingRoom() -->
+
[[Special:MyLanguage/Gaming:showWaitingRoom|Gaming:showWaitingRoom]] ''Display the waiting room'' <br/><!-- GIDEROSMTD:Gaming:showWaitingRoom() Display the waiting room -->
[[Special:MyLanguage/Gaming:updateState|Gaming:updateState]] <br/><!-- GIDEROSMTD:Gaming:updateState(key,data,immediate) -->
+
[[Special:MyLanguage/Gaming:updateState|Gaming:updateState]] ''Updates a save/state'' <br/><!-- GIDEROSMTD:Gaming:updateState(key,data,immediate) Updates a save/state -->
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 +
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
 
[[Special:MyLanguage/Event.CONNECTED_TO_ROOM|Event.CONNECTED_TO_ROOM]]<br/><!-- GIDEROSEVT:Event.CONNECTED_TO_ROOM conntectedToRoom-->
 
[[Special:MyLanguage/Event.CONNECTED_TO_ROOM|Event.CONNECTED_TO_ROOM]]<br/><!-- GIDEROSEVT:Event.CONNECTED_TO_ROOM conntectedToRoom-->

Latest revision as of 08:22, 8 January 2021


Supported platforms: Platform android.pngPlatform ios.png
Available since: Gideros 2012.09

Description


The Gaming class is defined in the module "gaming". Therefore, you need to call
require("gaming") before using it. Loading the Gaming module
also creates a global class Gaming.

Currently supports:

  • Gaming.new("googleplay") -- Android
  • Gaming.new("gamekit") -- iOS

Methods

Gaming.new instanciate the Gaming plugin
Gaming:autoMatch
Gaming:deleteState remove the specified save/state
Gaming:getAllPlayers
Gaming:getPlayerId Get the id of current player
Gaming:getPlayerInfo
Gaming:getPlayerName Get the name of current player
Gaming:getPlayerPicture Get the profile picture of current player
Gaming:getPlayerScore Get the score of current player
Gaming:incrementAchievement Increment the progress toward an achievement
Gaming:invitePlayers
Gaming:isLoggedIn Returns the login state in Gaming service
Gaming:joinRoom
Gaming:loadAchievements Load all achievements
Gaming:loadPlayerCenteredScores Load a leaderboard cenetered on the player
Gaming:loadScores Load a leaderboard
Gaming:loadState Load a save/state
Gaming:login Log in the Gaming service
Gaming:logout Log out of the gaming service
Gaming:reportAchievement Report an achievement progress
Gaming:reportScore Report a new score
Gaming:resolveState Resolve a save/state conflict
Gaming:revealAchievement Reveal an achievement
Gaming:sendTo
Gaming:sendToAll
Gaming:showAchievements Show the achievements
Gaming:showInvitations
Gaming:showLeaderboard Show a leaderboard
Gaming:showWaitingRoom Display the waiting room
Gaming:updateState Updates a save/state

Events

Event.CONNECTED_TO_ROOM
Event.DATA_RECEIVED
Event.DISCONNECTED_FROM_ROOM
Event.GAME_STARTED
Event.INVITATION_RECEIVED
Event.JOINED_ROOM
Event.LEFT_ROOM
Event.LOAD_ACHIEVEMENTS_COMPLETE
Event.LOAD_ACHIEVEMENTS_ERROR
Event.LOAD_SCORES_COMPLETE
Event.LOAD_SCORES_ERROR
Event.LOGIN_COMPLETE
Event.LOGIN_ERROR
Event.PEER_CONNECTED
Event.PEER_DECLINED
Event.PEER_DISCONNECTED
Event.PEER_INVITED
Event.PEER_JOINED
Event.PEER_LEFT
Event.PLAYER_INFORMATION_COMPLETE
Event.PLAYER_INFORMATION_ERROR
Event.PLAYER_SCORE_COMPLETE
Event.PLAYER_SCORE_ERROR
Event.REPORT_ACHIEVEMENT_COMPLETE
Event.REPORT_ACHIEVEMENT_ERROR
Event.REPORT_SCORE_COMPLETE
Event.REPORT_SCORE_ERROR
Event.ROOM_AUTO_MATCHING
Event.ROOM_CONNECTED
Event.ROOM_CONNECTING
Event.ROOM_CREATED
Event.STATE_CONFLICT
Event.STATE_DELETED
Event.STATE_ERROR
Event.STATE_LOADED

Constants

Gaming.ALL_PLAYERS
Gaming.ALL_TIME
Gaming.FRIENDS
Gaming.HIDDEN
Gaming.REVEALED
Gaming.TODAY
Gaming.UNLOCKED
Gaming.WEEK