User Data

The PlayFab User Data Module is specifically designed to implement per account data storage to games built using Construct.

Interconnected with major platforms including Facebook, Google Plus, Google Play, Game Center, FB Instant Games, Steam, Instant Games, Xbox Live, Nintendo Switch, PS4 and of course PlayFab's server.
The User Data are henceforth synced throughout, making your player's game or studio data available on every platform.

It has console support in cases you want to port. And it has complete set of tools, able to adapt to your game design's needs.

Easy Project Sample

Sample Setup Project

Specifications

  • Instructions - The sample project has comments and instructions on how to use the addon and its features.

  • A.C.E. Coverage - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks to a better use of the addon and of the event-sheet system alongside it.

Supporters

Only

Publisher

The Publisher addon implements studio-wide game user data. It is a counterpart for the User Data addon's title-wide user data.

Publisher is best used for an entire studio data, for each user.

All games (titles) belonging to the studio will be able to access the data.

 

Intstructions

1. The first step is to add the PlayFab API addon into the project.

2. Then, add the Authentication addon into the project.

3. Finally, add the User Data addon into the project.

Features :

  • User Data & Read-Only Data

  • Other User Data & Read-Only Data

  • Private and Public Data

  • Easy Local Data loading feature.

  • Account synced and profiled.

  • Organized request and update feature.

Network Services :

  • Facebook

  • Google Plus

  • Game Center

  • Google Play

  • Facebook Instant Games

  • Steam

  • Xbox Live

  • Nintendo Switch

  • PS4

  • PlayFab

Actions, Conditions & Expressions

Actions

Action.png

Get User Data:

  • Plan Get User Data - Add a Plan to get a "User Data".

    • Key - ​The "Key" or "User Data Name" to retrieve.

  • Get User Data - Retrieves all the "Planned" title-specific custom data from the "User" which is readable and writable by the client.

    • Tag - ​The tag to differentiate requests.

  • Get All User Data - Retrieves "all" title-specific custom data from the "User" which is readable and writable by the client.

    • Tag - ​The tag to differentiate requests.​

Get Other User Data:

  • Plan Get Other User Data - Retrieves all the "Planned" title-specific custom data from "Another User" which is readable and writable by the client.

    • Key - ​The "Key" or "User Data Name" to retrieve.

  • Get Other User Data - Retrieves all the "Planned" title-specific custom data from "Another User" which is readable and writable by the client.

    • PlayFab ID - ​The Target Player's "PlayFabID".

    • Tag - ​The tag to differentiate requests.​

  • Get All Other User Data - Retrieves "All" the title-specific custom data from "Another User" which is readable and writable by the client.

    • PlayFab ID - The Target Player's "PlayFabID".

    • Tag - ​The tag to differentiate requests.

Get User ReadOnly Data:

  • Plan Get User Read Data - Add a Plan to get the "User's ReadOnly Data".

    • Key - ​The "Key" or "User ReadOnly Data Name" to retrieve.

  • Get User Read Data - Retrieves all the "Planned" title-specific custom data from the "User" which is readable and writable by the client.

    • Tag - ​The tag to differentiate requests.

  • Get All User Read Data - Retrieves "All" the title-specific custom data from the "User" which is readable and writable by the client.

    • Tag - ​The tag to differentiate requests.​

Get Other User ReadOnly Data:

  • Plan Get Other User Read Data - Add a Plan to get "Another User's ReadOnly Data".

    • Key​ - The "Key" or "User ReadOnly Data Name" to retrieve.

  • Get Other User Read Data - Retrieves all the "Planned" title-specific custom data from "Another User" which is readable and writable by the client.

    • PlayFab ID​ - The Target Player's "PlayFabID".

    • Tag - ​The tag to differentiate requests.

  • Get All Other User Read Data - Retrieves "All" the title-specific custom data from "Another User" which is readable and writable by the client.

    • PlayFab IDThe Target Player's "PlayFabID".​

    • Tag - ​The tag to differentiate requests.

Update User Data:

  • Plan Write Data - Plan a "Write User Data" request into the next "Update User Data".

    • Key - Input the "Key" of the User Data. Keys are trimmed of white-space, are limited in size, and may not begin with a "!" character or be null.

    • Value -The Value for the "User Data Key". 

  • Plan Remove Data - Plan a "Remove User Data" request into the next "Update User Data".

    • Key - Input the "Key" of the User Data to remove.

  • Update User Data - Creates and updates the title-specific custom data for the user which is readable and writable by the client.

    • Permission - Permission to be applied to all "User Data Keys" written in this request. If "Private", it will be hidden from other Players, while "Public" allows the data to be viewed by other Players.

    • Tag - ​The tag to differentiate requests.

User :: Locally Retrieve:

  • Load User Data - Load the local data from the latest "Get User Data".

    • Key​ - Input the "Key" of the User Data to load.

  • Load User Read Data - Load the local data from the latest "Get User ReadOnly Data".

    • Key​Input the "Key" of the User Data to load.

Other User :: Locally Retrieve:

  • Load Other User Data - Load the local data from the latest "Get Other User Data".

    • Key​ - Input the "Key" of the User Data to load.

  • Load Other User Read Data - Load the local data from the latest "Get Other User ReadOnly Data".

    • Key​Input the "Key" of the User Data to load.

Conditions

Get User Data:

  • On Get User Data - Triggers when the Get User Data Succeeded.

  • On Get User Data Failed - Triggers when the Get User Data Failed.

Get User ReadOnly Data:

  • On Get User ReadOnly Data - Triggers when the Get User Read-Only Data Succeeded.

  • On Get User ReadOnly Data Failed - Triggers when the Get User Read-Only Data Failed.

Get Other User Data:

  • On Get Other Data - Triggers when the Get Other Data Succeeded.

  • On Get Other Data Failed - Triggers when the Get Other Data Failed.

Get Other User ReadOnly Data:

  • On Get Other ReadOnly Data - Triggers when the Get Other Read-Only Data Succeeded.

  • On Get Other ReadOnly Data Failed - Triggers when the Get Other Read-Only Data Failed.

Update User Data:

  • On Update User Data - Triggers when the Update User Data Succeeded.

  • On Update User Data Failed - Triggers when the Update User Data Failed.

Load User Data:

  • On Load User Data - Triggers when the Load User Data Succeeded.

    • Key -​ The "Key" or "User Data Name" to load for return.

  • On Load User Data Failed - Triggers when the Load User Data Failed.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Any Load User Data - Triggers when any Load User Data Succeeded.

  • On Any Load User Data Failed - Triggers when any Load User Data Failed.

Load User ReadOnly Data:

  • On Load User Read Data - Triggers when the Load User Read Only Data Succeeded.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Load User Read Data Failed - Triggers when the Load User Read Only Data Failed.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Any Load User Read Data - Triggers when any Load User Data Succeeded.

  • On Any Load User Data Read Failed - Triggers when any Load User Data Failed.

Load Other User Data:

  • On Load Other Data - Triggers when the Load Other User Data Succeeded.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Load Other Data Failed - Triggers when the Load Other User Data Failed.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Any Load Other Data - Triggers when any Load Other User Data Succeeded.

  • On Any Load Other Data Failed - Triggers when any Load Other User Data Failed.

Load Other User ReadOnly Data:

  • On Load Other Read Data - Triggers when the Load Other User Read Only Data Succeeded.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Load Other Read Data Failed - Triggers when the Load Other User Read Only Data Failed.

    • Key -​ The "Key" or "User Data Name" to load for return.​

  • On Any Load Other Read Data - Triggers when any Load Other User Read Only Data Succeeded.

  • On Any Load Other Read Data Failed - Triggers when any Load Other User Read Only Data Failed.

Expressions

Get User Data:

  • getDataVersion- Returns the "Data Version", the current version of the data that has been set.

Get User ReadOnly Data:

  • getReadDataVersion- Returns the "Data Version", the current version of the data that has been set.

Update User Data:

  • getUpdateDataVersion- Returns the "Data Version", the current version of the data that has been set.

 

Load User Data:

  • retDataLastUpdated - Returns the "Last Updated". Timestamp for when this data was last updated.

  • retDataPermission  - Returns the "Permission". Indicates whether this data can be read by all users (public) or only the user (private).

  • retDataValue - Returns the "Value". Data stored for the specified user data key.

  • retDataKey - Returns the "Key" of the loaded data.

Load User ReadOnly Data:

  • retReadDataLastUpdated - Returns the "Last Updated". Timestamp for when this data was last updated.

  • retReadDataPermission - Returns the "Permission". Indicates whether this data can be read by all users (public) or only the user (private).

  • retReadDataValue - Returns the "Value". Data stored for the specified user data key.

  • retReadDataKey - Returns the "Key" of the loaded data.

Get Other User Data:

  • getODataVersion - Returns the "Data Version", the current version of the data that has been set.

Get Other User ReadOnly Data:

  • getOReadDataVersion - Returns the "Data Version", the current version of the data that has been set.

Load Other User Data:

  • retODataLastUpdated - Returns the "Last Updated". Timestamp for when this data was last updated.

  • retODataPermission - Returns the "Permission". Indicates whether this data can be read by all users (public) or only the user (private).

  • retODataKey - Returns the "Value". Data stored for the specified user data key.

  • retODataKey - Returns the "Key" of the loaded data.

Load Other User ReadOnly Data:

  • retOReadDataLastUpdated - Returns the "Last Updated". Timestamp for when this data was last updated.

  • retOReadDataPermission - Returns the "Permission". Indicates whether this data can be read by all users (public) or only the user (private).

  • retOReadDataValue - Returns the "Value". Data stored for the specified user data key.

  • retOReadDataKey - Returns the "Key" of the loaded data.

Server Response:

  • ServerResponse - Return the "Server Response" from every request from the PlayFab Server. The server response can also be shown in the "Chrome Developer Tools : Console", if in "debug mode".

Request:OtherLoad - Returns the another user's data value.

  • Tag - Return the "Tag" of the latest request.

Load:

  • OtherLoad - Returns the another user's data value.

    • Key - The​ key of another user data.

  • OtherReadLoad - Returns the another user's read-only data value.

    • Key - The​ key of another user read-only data.

  • UserLoad - Returns the user's data value.

    • Key - The​​ key of the user data.

  • UserReadLoad - Returns the user's read-only data value.

    • Key - The​​ key of the user read-only data.

 

Server Management

The User Data addon implements player-specific data read & write for current game (title), these are then sent to the PlayFab servers and synced across all connected (synced) authentication methods. There are 3 data types,  the player data, read-only data and the internal data

  • Player data - both readable and writable data, customized for each player and can be public or private.

  • Read-only data - exclusively read-only data, customized for each player and can be public or private.

  • Internal data - unreadable and can't be altered from the client or the User Data addon. This is a developer exclusive data for the players, which can be very useful for server automation. In cases of needs in alteration of this data, it would then require the Cloud Scripting feature from the PlayFab - Automation console with the Cloud Script addon calling it from the client (application).

 

Admin privileges allow you to modify each player's data automatically through the Server API automation, Cloud Script or manually using the Admin Console.

Screenshot - 1.png

Step 1 : Login to your PlayFab account, select the title from the studio.

Step 2 : Click on the Players tab. Then the Players list will show. Select a player, then the player overview will open.

Screenshot - 2.png

Step 3 : From the player overview, select the Player Data (Title), which will show you the player's  current data.

Player Data.png

Step 4 : To manually modify a player's writable and readable data.

Simply add, change or remove the data from the list. Then finally save changes.

You can control everything here as the administrator.

Player ReadData.png

Step 5 : To manually modify a player's read-only data.

Simply add, change or remove the data from the list. Then finally save changes.

You can control everything here as the administrator.

Internal Data.png

Step 6 : To manually modify a player's internal data.

Simply add, change or remove the data from the list. Then finally save changes.

You can also set all data types from Public to Private. Just like in the plugin.

 
 

Game Project

Sample Setup Project

Specifications

  • Instructions - The sample project has comments and instructions on how to use the addon and its features.

  • A.C.E. Coverage - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks to a better use of the addon and of the event-sheet system alongside it.

Supporters

Only

Get the tools

for your pro games!

Constuct Master Collection - Itch.io
Constuct Master Collection - Discord
Constuct Master Collection - Construct 3

© Construct Master Collection 2020 • All rights reserved

Contact Information: