gpgs

Version: stable

Functions

gpgs.is_supported()

gpgs.is_supported()

Check if Google Play Services are available & ready on the device.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local is_supported = gpgs.is_supported()
end

gpgs.login()

gpgs.login()

Login to GPGS using a button.

PARAMETERS

None

EXAMPLES

Log in to GPGS using a button:

if gpgs then
  gpgs.login()
end

gpgs.silent_login()

gpgs.silent_login()

Silent login to GPGS. This function is trying to retrieve the currently signed-in player’s account. [icon:attention] By default login methods request `GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN`. But if you use Disk, we have to request extra scope `Drive.SCOPE_APPFOLDER`. Or if you use ID token, we have to request ID token with provided client_id. If so it causes the first time silent sign-in to fail, except for users who have already signed in successfully on a different device. Turn off GPGS features you don't want to use in `game.project`.

PARAMETERS

None

EXAMPLES

function init(self)
  if gpgs then
    gpgs.silent_login()
  end
end

gpgs.logout()

gpgs.logout()

Logout from GPGS

PARAMETERS

None

EXAMPLES

if gpgs then
  gpgs.logout()
end

gpgs.get_display_name()

gpgs.get_display_name()

Get the current GPGS player display name.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local name = gpgs.get_display_name()
end

gpgs.get_id()

gpgs.get_id()

Get the current GPGS player id.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local id = gpgs.get_id()
end

gpgs.get_id_token()

gpgs.get_id_token()

Get the current GPGS player id token. Available only if "gpgs.client_id" is configured in game.project and "gpgs.request_id_token = 1".

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local id_token = gpgs.get_id_token()
end

gpgs.get_server_auth_code()

gpgs.get_server_auth_code()

Returns a one-time server auth code to send to your web server which can be exchanged for access token

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local server_auth_code = gpgs.get_server_auth_code()
end

gpgs.is_logged_in()

gpgs.is_logged_in()

Check if a user is logged in currently.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local is_loggedin = gpgs.is_logged_in()
end

gpgs.set_popup_position()

gpgs.set_popup_position(position)

This method sets the position for the login popup.

PARAMETERS

EXAMPLES

if gpgs then
  gpgs.set_popup_position(gpgs.POPUP_POS_BOTTOM_CENTER)
end

gpgs.set_callback()

gpgs.set_callback(callback)

Set callback for receiving messages from GPGS.

PARAMETERS

EXAMPLES

function callback(self, message_id, message)
  if message_id == gpgs.MSG_SIGN_IN or message_id == gpgs.MSG_SILENT_SIGN_IN then
    if message.status == gpgs.STATUS_SUCCESS then
    -- do something after login
    end
  elseif message_id == gpgs.MSG_SIGN_OUT then
  -- do something after logout
  elseif message_id == gpgs.MSG_LOAD_SNAPSHOT then
  -- do something when a save was loaded
  end
end

function init(self)
  gpgs.set_callback(callback)
end

function init(self)
  gpgs.set_callback(nil) -- remove callback
end

gpgs.snapshot_display_saves()

gpgs.snapshot_display_saves(popupTitle,allowAddButton,allowDelete,maxNumberOfSavedGamesToShow)

Provides a default saved games selection user interface.

PARAMETERS

EXAMPLES

if gpgs then
  gpgs.snapshot_display_saves("Choose the save of the game", false, true, 10)
end

gpgs.snapshot_open()

gpgs.snapshot_open(saveName,createIfNotFound,conflictPolicy)

Opens a snapshot with the given `saveName`. If `createIfNotFound` is set to `true`, the specified snapshot will be created if it does not already exist.

PARAMETERS

EXAMPLES

if gpgs then
  gpgs.snapshot_open("my_save_1", true, gpgs.RESOLUTION_POLICY_LONGEST_PLAYTIME)
end

gpgs.snapshot_commit_and_close()

gpgs.snapshot_commit_and_close(metadata)

Save the currently opened save on the server and close it.

PARAMETERS

EXAMPLES

if gpgs then
  local png_img, w, h = screenshot.png()
  gpgs.snapshot_commit_and_close({
      coverImage = png_img,
      description = "LEVEL 31, CAVE",
      playedTime = 12345667,
      progressValue = 657
  })
end

gpgs.snapshot_get_data()

gpgs.snapshot_get_data()

Returns the currently opened snapshot data.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local bytes, error_message = gpgs.snapshot_get_data()
  if not bytes then
      print("snapshot_get_data ERROR:", error_message)
  else
      print("snapshot_get_data",bytes)
      -- Do something with your data
  end
end

gpgs.snapshot_set_data()

gpgs.snapshot_set_data(data)

Sets the data for the currently opened snapshot.

PARAMETERS

RETURNS

EXAMPLES

  if gpgs then
    local success, error_message = gpgs.snapshot_set_data(my_data)
    if not success then
        print("snapshot_set_data ERROR:", error_message)
    end
  end

gpgs.snapshot_is_opened()

gpgs.snapshot_is_opened()

Check if a snapshot was opened.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local is_opened = gpgs.snapshot_is_opened()
end

gpgs.snapshot_get_max_image_size()

gpgs.snapshot_get_max_image_size()

Returns the maximum data size per snapshot cover image in bytes.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local image_size = gpgs.snapshot_get_max_image_size()
end

gpgs.snapshot_get_max_save_size()

gpgs.snapshot_get_max_save_size()

Returns the maximum data size per snapshot in bytes.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local data_size = gpgs.snapshot_get_max_save_size()
end

gpgs.snapshot_get_conflicting_data()

gpgs.snapshot_get_conflicting_data()

Returns the conflicting snapshot data.

PARAMETERS

None

RETURNS

EXAMPLES

if gpgs then
  local bytes, error_message = gpgs.snapshot_get_conflicting_data()
  if not bytes then
      print("snapshot_get_conflicting_data ERROR:", error_message)
  else
      print("snapshot_get_conflicting_data:",bytes)
      -- Do something with conflicting data data
  end
end

gpgs.snapshot_resolve_conflict()

gpgs.snapshot_resolve_conflict(conflictId,snapshotId)

Resolves a conflict using the data from the provided snapshot.

PARAMETERS

EXAMPLES

if gpgs then
  gpgs.snapshot_resolve_conflict(self.conflictId, gpgs.SNAPSHOT_CONFLICTING)
end

gpgs.leaderboard_submit_score()

gpgs.leaderboard_submit_score(leaderboardId,score)

Submit a score to a leaderboard for the currently signed-in player.

PARAMETERS

gpgs.leaderboard_get_top_scores()

gpgs.leaderboard_get_top_scores(leaderboardId,time_span,collection,max_results)

Asynchronously gets the top page of scores for a leaderboard.

PARAMETERS

gpgs.leaderboard_get_player_centered_scores()

gpgs.leaderboard_get_player_centered_scores(leaderboardId,time_span,collection,max_results)

Asynchronously gets a player-centered page of scores for a leaderboard.

PARAMETERS

gpgs.leaderboard_show()

gpgs.leaderboard_show(leaderboardId,time_span,collection)

Show a leaderboard for a game specified by a leaderboardId.

PARAMETERS

gpgs.leaderboard_list()

gpgs.leaderboard_list()

Show the list of leaderboards.

PARAMETERS

None

gpgs.leaderboard_get_player_score()

gpgs.leaderboard_get_player_score(leaderboardId,time_span,collection)

Asynchronously gets a player-centered page of scores for a leaderboard.

PARAMETERS

gpgs.achievement_reveal()

gpgs.achievement_reveal(achievementId)

Reveal achievement

PARAMETERS

gpgs.achievement_unlock()

gpgs.achievement_unlock(achievementId)

Unlock achievement

PARAMETERS

gpgs.achievement_set()

gpgs.achievement_set(achievementId,steps)

Set achievement progress

PARAMETERS

gpgs.achievement_increment()

gpgs.achievement_increment(achievementId,steps)

Increase achievement progress

PARAMETERS

gpgs.achievement_show()

gpgs.achievement_show()

Show achivements

PARAMETERS

None

gpgs.achievement_get()

gpgs.achievement_get()

PARAMETERS

None

gpgs.event_increment()

gpgs.event_increment(eventId,amount)

PARAMETERS

gpgs.event_get()

gpgs.event_get()

PARAMETERS

None

Constants

POPUP_POS_TOP_LEFT

The login popup position at the top-left corner.

POPUP_POS_TOP_CENTER

The login popup position at the top-center.

POPUP_POS_TOP_RIGHT

The login popup position at the top-right corner.

POPUP_POS_CENTER_LEFT

The login popup position at the center-left.

POPUP_POS_CENTER

The login popup position at the center of the screen.

POPUP_POS_CENTER_RIGHT

The login popup position at the center-right.

POPUP_POS_BOTTOM_LEFT

The login popup position at the bottom-left corner.

POPUP_POS_BOTTOM_CENTER

The login popup position at the bottom-centre.

POPUP_POS_BOTTOM_RIGHT

The login popup position at the bottom-right corner.

RESOLUTION_POLICY_MANUAL

Official [GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/SnapshotsClient.html#RESOLUTION_POLICY_MANUAL) for this constant

RESOLUTION_POLICY_LONGEST_PLAYTIME

Official [GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/SnapshotsClient.html#RESOLUTION_POLICY_LONGEST_PLAYTIME) for this constant

RESOLUTION_POLICY_LAST_KNOWN_GOOD

Official [GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/SnapshotsClient.html#RESOLUTION_POLICY_LAST_KNOWN_GOOD) for this constant

RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED

Official [GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/SnapshotsClient.html#RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED) for this constant

RESOLUTION_POLICY_HIGHEST_PROGRESS

Official [GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/SnapshotsClient.html#RESOLUTION_POLICY_HIGHEST_PROGRESS) for this constant

MSG_SIGN_IN

The message type that GPGS sends when finishing the asynchronous operation after calling `gpgs.login()`

MSG_SILENT_SIGN_IN

The message type that GPGS sends when finishing the asynchronous operation after calling `gpgs.silent_login()`

MSG_SIGN_OUT

The message type that GPGS sends when finishing the asynchronous operation after calling `gpgs.logout()`

MSG_SHOW_SNAPSHOTS

The message type that GPGS sends when finishing the asynchronous operation after calling `gpgs.snapshot_display_saves()`

MSG_LOAD_SNAPSHOT

The message type that GPGS sends when finishing the asynchronous operation after calling `gpgs.snapshot_open()`

MSG_SAVE_SNAPSHOT

The message type that GPGS sends when finishing the asynchronous operation after calling `gpgs.snapshot_commit_and_close()`

STATUS_SUCCESS

An operation success.

STATUS_FAILED

An operation failed. Check the error field in the massage table.

STATUS_CREATE_NEW_SAVE

A user wants to create new save as a result of `gpgs.snapshot_display_saves()` method. Turn off this button in `gpgs.snapshot_display_saves()` if you don't want to have this functionality.

STATUS_CONFLICT

The result of the calling `gpgs.snapshot_open()` or 'gpgs.snapshot_resolve_conflict()' is a conflict. You need to make decision on how to solve this conflict using 'gpgs.snapshot_resolve_conflict()'.

SNAPSHOT_CURRENT

The second parameter for 'gpgs.snapshot_resolve_conflict()' method, which means that you want to choose the current snapshot as a snapshot for conflict solving.

SNAPSHOT_CONFLICTING

The second parameter for 'gpgs.snapshot_resolve_conflict()' method, which means that you want to choose the conflicting snapshot as a snapshot for conflict solving.

ERROR_STATUS_SNAPSHOT_NOT_FOUND

This constant is used in `message.error_status` table when `MSG_LOAD_SNAPSHOT` is `STATUS_FAILED`. [Official GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/GamesStatusCodes.html#STATUS_SNAPSHOT_NOT_FOUND) for this constant

ERROR_STATUS_SNAPSHOT_CREATION_FAILED

This constant is used in `message.error_status` table when `MSG_LOAD_SNAPSHOT` is `STATUS_FAILED`. [Official GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/GamesStatusCodes.html#STATUS_SNAPSHOT_CREATION_FAILED) for this constant

ERROR_STATUS_SNAPSHOT_CONTENTS_UNAVAILABLE

This constant is used in `message.error_status` table when `MSG_LOAD_SNAPSHOT` is `STATUS_FAILED`. [Official GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/GamesStatusCodes.html#STATUS_SNAPSHOT_CONTENTS_UNAVAILABLE) for this constant

ERROR_STATUS_SNAPSHOT_COMMIT_FAILED

This constant is used in `message.error_status` table when `MSG_LOAD_SNAPSHOT` is `STATUS_FAILED`. [Official GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/GamesStatusCodes.html#STATUS_SNAPSHOT_COMMIT_FAILED) for this constant

ERROR_STATUS_SNAPSHOT_FOLDER_UNAVAILABLE

This constant is used in `message.error_status` table when `MSG_LOAD_SNAPSHOT` is `STATUS_FAILED`. [Official GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/GamesStatusCodes.html#STATUS_SNAPSHOT_FOLDER_UNAVAILABLE) for this constant

ERROR_STATUS_SNAPSHOT_CONFLICT_MISSING

This constant is used in `message.error_status` table when `MSG_LOAD_SNAPSHOT` is `STATUS_FAILED`. [Official GPGS documentation](https://developers.google.com/android/reference/com/google/android/gms/games/GamesStatusCodes.html#STATUS_SNAPSHOT_CONFLICT_MISSING) for this constant