game_rc_login_result Struct Reference

**Payload of AddonToKodiFuncTable_Game::RCOnLoginResult** More...

#include <game.h>

Public Attributes
bool	success
	True if the player was logged in.
const char *	username
	Account name of the player, or NULL
const char *	display_name
	Display name of the player, or NULL
const char *	icon_url
	URL of the player's avatar, or NULL if the add-on has none.
unsigned int	points
	Total points earned by the player.
const char *	error_message
	Reason the login failed, or NULL if it succeeded.
bool	credentials_rejected
	True if the account or token was rejected, rather than the attempt failing for some other reason.

Detailed Description

**Payload of AddonToKodiFuncTable_Game::RCOnLoginResult**

Member Data Documentation

credentials_rejected

bool game_rc_login_result::credentials_rejected

True if the account or token was rejected, rather than the attempt failing for some other reason.

Kodi drops the saved token only for this. A login that failed because RetroAchievements could not be reached leaves it alone, so an outage does not sign the player out and leave the add-on nothing to reconnect with.

display_name

const char* game_rc_login_result::display_name

Display name of the player, or NULL

error_message

const char* game_rc_login_result::error_message

Reason the login failed, or NULL if it succeeded.

icon_url

const char* game_rc_login_result::icon_url

URL of the player's avatar, or NULL if the add-on has none.

points

unsigned int game_rc_login_result::points

Total points earned by the player.

success

bool game_rc_login_result::success

True if the player was logged in.

username

const char* game_rc_login_result::username

Account name of the player, or NULL

---

The documentation for this struct was generated from the following file:

• c-api/addon-instance/game.h