Player manager

The manager rules over the player state and his synchronization with the server. After SDK initialization, there starts the process of player’s synchronization with the server. Upon completion, the ready event will be called.

Overview

Player manager properties FREE:

JavaScript

// The player is logged in
ss.player.isLoggedIn;
// The player uses one of the login methods (authorization, secret code)
ss.player.hasAnyCredentials;
// Player waiting promise
ss.player.ready;

Unity

// The player is logged in
SS_Player.IsLoggedIn();
// The player uses one of the login methods (cookie, authorization, secret code)
SS_Player.HasAnyCredentials();

The player is initialized automatically; you can wait for readiness:

JavaScript

await ss.player.ready;
// The player is ready

// The player is ready
ss.player.on('ready', () => {});

Unity

Initialization in Unity occurs before the game starts

Synchronization

+1 Request

After player model changes, they can be sent to the server and saved locally on the device. It is recommended to sync the player after completing a level and receiving rewards, as well as immediately after an important action, for example, purchasing an item.

JavaScript

// Synchronize, returns the promise
ss.player.sync();
// Overwrite the character on the server (local in priority)
ss.player.sync({ override: true });

// The player is synchronized (success === true)
ss.player.on('sync', (success) => {});

Unity

// Synchronize player
SS_Player.Sync();
// Overwrite the character on the server (local in priority)
SS_Player.Sync(true);

tip

Storage limit: no more than 1 MB per player.

Loading

+1 Request

You can load the player by force from the server (by overwriting the local one).

JavaScript

// Load, returns the promise
ss.player.load();

// The player is loaded (success === true)
ss.player.on('load', (success) => {});

Unity

// Load player
SS_Player.Load();

Login

+0-1 Request

Show the overlay with login options. This is currently the platform login (if it is supported) and login by secret code.

JavaScript

// Login, returns the promise
ss.player.login();

// The player is logged in (success === true)
ss.player.on('login', (success) => {});

Unity

// Open login overlay
SS_Player.Login();

// Event subscription
private void OnEnable()
{
    SS_Player.OnLoginComplete += OnLoginComplete;
    SS_Player.OnLoginError += OnLoginError;
}

// Event unsubscription
private void OnDisable()
{
    SS_Player.OnLoginComplete -= OnLoginComplete;
    SS_Player.OnLoginError -= OnLoginError;
}

// Event handling
private void OnLoginComplete()
{
    Debug.Log("LoginComplete");
}

// Event handling
private void OnLoginError()
{
    Debug.Log("LoginError");
}

Logout

+0-1 Request

Logout player. If supported logout on platform.

JavaScript

// Logout, returns the promise
ss.player.logout();

// The player is logged in (success === true)
ss.player.on('logout', (success) => {});

Unity

// Logout player
SS_Player.Logout();

// Event subscription
private void OnEnable()
{
    SS_Player.OnLogoutComplete += OnLogoutComplete;
    SS_Player.OnLogoutError += OnLogoutError;
}

// Event unsubscription
private void OnDisable()
{
    SS_Player.OnLogoutComplete -= OnLogoutComplete;
    SS_Player.OnLogoutError -= OnLogoutError;
}

// Event handling
private void OnLogoutComplete()
{
    Debug.Log("LogoutComplete");
}

// Event handling
private void OnLogoutError()
{
    Debug.Log("LogoutError");
}

Fetching the fields

+1 Request

See below what player fields are.
You can fetch the player fields using the following method:

JavaScript

// Fetch fields list, returns the promise
ss.player.fetchFields();

// Fields are fetched (success === true)
ss.player.on('fetchFields', (success) => {});

Unity

// Fetch fields list
private Fetch() => SS_Player.FetchFields(OnFetchFields);

// Fields are fetched
private OnFetchFields(List<PlayerFetchFieldsData> data){

}

Notification of other windows

FREE

If the player opens another window with the game at the same time as the other open windows of the game - all other windows will receive event:connect. You can subscribe to it like this:

JavaScript

// will be triggered when the player opens another window with the game
ss.on('event:connect', () => {});

Unity

//Subscribe to event
private void OnEnable()
{
    SS_Player.OnConnect += OnConnect;
}
//Unsubscribe from event
private void OnDisable()
{
    SS_Player.OnConnect -= OnConnect;
}

//On trigger event
private void OnConnect()
{
    Debug.Log("Connect");
}

Stay in Touch

Other documents of this chapter available Here. To get started, welcome to the Tutorials chapter.

SpellSync Community Telegram: @spellsync.

For your suggestions e-mail: [email protected]

We Wish you Success!