Type Boolean
Return value none
Revision Current Public Release (2018.3326)
Keywords Google Play Games Services, game network, gpgs, login
See also gpgs.init()


Attempts to log in the current player. You must call gpgs.init() before making this function call.


gpgs.login( params )
params (required)

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

Parameter Reference

The params table includes parameters for the login.

userInitiated (optional)

Boolean. If true, a sign-in dialog will appear if the user is not logged in. Use this when the user specifically wants to log in via a UI button/element instead of being logged in automatically.

listener (optional)

Listener. Listener function which receives a login event.