Type Boolean
Return value none
Revision Release 2024.3703
Keywords Google Play Games Services, game network, gpgs
See also gpgs.*


Attempts to log in the current player.


params (required)

Table. Contains parameters — see the next section for details.

Parameter Reference

userInitiated (optional)

Boolean. If true, will show sign in dialog if user is not logged in. Use it when user specifically wants to log in (presses log in button for instance) instead of being logged in automatically.

useDrive (optional)

Boolean. If true will request Google Drive Access. This is needed for Snapshots.

listener (optional)

Listener. Receives login event.