top of page

Publisher

The Publisher plugin is specifically designed to implement PlayFab Publisher Data, which implements studio-wide features for games built using Construct 3 and Construct 2.


Interconnected with major platforms including Google Play, Game Center, Apple Login, Instant Games, Facebook, Facebook Instant Games, Steam, Xbox Live, Nintendo Switch, PS4 and of course PlayFab's own account and login system with email, username and password support  for your own game. The Publisher plugin with the PlayFab service allows your studio data or player's studio data available on every platform for every game in a studio.


PlayFab also has console support, just in case you want to port in the future, especially through porting services. Extending the reach of your player's studio data.

PlayFab API v2.png

Introduction

Step 1.png

The Construct Master Collection supports the full and easy integration of the PlayFab service for both Construct 3 and Construct 2.


Please click here to learn more about PlayFab.

Features


Here are some of the features of the PlayFab service:

  • Studio data

  • Private, public and internal global studio data.

  • Private, public and internal user studio data.

  • User studio data

  • User read-only studio data

  • Other user's studio data

  • Other user's read-only studio data

  • Private, public and internal user studio data.

  • Easy local data loading similar to the Local Storage object.

  • Easy expression data loading similar to the Dictionary object.

  • Account sync

  • User studio data profile

  • Organized request features

  • Update features

  • User studio data accessible to all games in a studio.


For more information about all the integrated PlayFab service features, please click here to learn the introductory lessons to PlayFab.


Network Services


Here are some of the platform services that can be linked:

  • PlayFab

  • Google Play

  • Game Center

  • Facebook

  • Facebook Instant Games

  • Steam

  • Xbox Live

  • Instant Games (Android Studio port)

  • Nintendo Switch (3rd party porting services)

  • PS4 (3rd party porting services)

  • Nintendo Switch (3rd party porting services)


Editor Features


Here are some of the features in the Construct editor:

  • All platforms support, including web, mobile and desktop.

  • Construct 3

  • Construct 2

Introduction
Features

How to use?

It is easy to use the Publisher plugin, you will only need to follow the steps below.

  1. Set up the PlayFab API plugin, please click to visit the documentation. This includes creating a PlayFab account, studio and title.

  2. Set up the Authentication plugin, please click to visit the documentation.

  3. Finally, you can now use the Publisher object, and include more PlayFab addons for more features.


Instructions
Documentation

Documentation

There is currently nothing to show, we will add more in the future.


Server Management


The Publisher plugin implements both player's account studio data read & write for all the players' games (titles) in a studio, and managing, accessing and retrieving global studio data that are available to all games in a studio .These are synced by the PlayFab servers across all connected authentication methods.

There are 3 data types for the user's studio account data, the studio player data, studio read-only data and the studio player 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 Publisher plugin. This is a developer exclusive data for the players, which can be very useful for server automation. In cases of need in reading and writing this data, it would then require the cloud scripting feature from the PlayFab > Automation console with the Cloud Script or Azure Function plugin calling it from the client (application).


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

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


2. Click the Players sidebar tab, then the players list will show. Select a player, then the player overview will show.



3. From the player's overview, select the Player Data (Publisher) tab, which will show you the player's current studio user data.

4. To manually modify a player's writable and readable studio user data, simply add, change or remove the data from the list. Then, finally save changes. You can control everything here as the administrator.



5. To manually modify a player's read-only data, simply add, change or remove the user studio data from the list. Then, finally save changes. You can control everything here as the administrator.



6. To manually modify a player's internal data, simply add, change or remove the studio user data from the list. Then, finally save changes. You can control everything here as the administrator.



​You can also change all the data's privacy types to either Public or Private, just like in the plugin.


Related Plugins


  • User Data - is a plugin that implements title-wide (game-wide) user data. Instead of a user's studio account data for multiple titles (games), this is a user's data that is accessible, available and writable for only the current title (game).

  • Title Manager - is a plugin that implements title-wide global data. It is a title-wide counterpart of the Publisher plugin's studio-wide global data. Instead of a global studio data for multiple games in a studio, this plugin retrieves global title (game) data which is accessible and available for only the current title (game). Data is accessible by everyone in the title (game) including systems, spectators and user player accounts.

ACEs

Actions, Conditions & Expressions

Actions

The following action groups:

  • Get Publisher Data

  • Get User Publisher Data

  • Get User Publisher Read-only Data

  • Update User Publisher Data

  • Get Other User Publisher Data

  • Get Other User Publisher Read-only Data

  • Publisher : Locally Retrieve

  • User Publisher Read-only Data : Locally Retrieve

  • Other Publisher : Locally Retrieve

  • Other Publisher Read-only Data : Locally Retrieve

Get Publisher Dat

  • Plan Get Publisher Data - Plan to get a Publisher Data for the next "Get Publisher Data".

    • Key - ​The "Key" reference for the Publisher Data.


  • Get Publisher Data - Retrieves the key-value store of custom publisher settings.

    • Tag -​ Tag to differentiate requests.


​

Get User Publisher Data​

  • Plan Get User Publisher Data - Plan to get a User Publisher Data for the next "Get User Publisher Data".

    • Key - ​The "Key" reference for the User Publisher Data.


  • Get User Publisher Data - Retrieves the publisher-specific custom data for the user which is readable and writable by the client.

    • Tag -​ Tag to differentiate requests.


  • Get All User Publisher Data - Retrieves all the publisher-specific custom data for the user which is readable and writable by the client.

    • Tag -​ Tag to differentiate requests.


​ Get User Publisher Read-Only Data​

  • Plan Get User Read Data - Plan to get a User Publisher Read-Only Data for the next "Get User Publisher Read Data".

    • Key - ​The "Key" reference for the User Publisher ReadOnly Data.


  • ​Get User Publisher Read Data - Retrieves the publisher-specific custom data for the user which can only be read by the client.

    • Tag -​ Tag to differentiate requests.


  • Get All User Publisher Read Data - Retrieves all the publisher-specific custom data for the user which can only be read by the client.

    • Tag -​ Tag to differentiate requests.


​ Update User Publisher Data​

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

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

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


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

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


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

    • Permission - ​Permission to be applied to all "User Publisher Data Keys" written in this request. If "Public", it will hidden from other Players.

      • Private​

      • Public

    • Tag -​ Tag to differentiate requests.


​ Get Other User Publisher Data​

  • Plan Get Other Publisher Data - Plan to get "Other's" Publisher Data for the next "Get User Publisher Data".

    • Key - ​The "Key" reference for the User Publisher Data.


  • Get Other Publisher Data - Retrieves the publisher-specific custom data from "Other Users" which is readable and writable by the client.

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

    • Tag -​ Tag to differentiate requests.


  • Get All Other Publisher Data - Retrieves all the publisher-specific custom data from "Other Users" which is readable and writable by the client.

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

    • Tag -​ Tag to differentiate requests.


​ Get Other User Publisher Read-Only Data

  • Plan Get Other Read Data - Plan to get Other User's Publisher Read-Only Data for the next "Get User Publisher Read Data".

    • Key - ​The "Key" reference for the User Publisher ReadOnly Data.


  • Get Other Publisher Read Data - Retrieves the publisher-specific custom data from Other Users which can only be read by the client.

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

    • Tag -​ Tag to differentiate requests.


  • Get All Other Publisher Read Data - Retrieves all the publisher-specific custom data from Other Users which can only be read by the client.

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

    • Tag -​ Tag to differentiate requests.


​ Publisher : Locally Retrieve​

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

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


​ User Publisher : Locally Retrieve:​

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

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


​ User Publisher Read-Only Data : Locally Retrieve:​

  • Load User Publisher Read Data - Load the local read-only data from the latest "Get User Publisher Read Data".

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


​ Other Publisher : Locally Retrieve​

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

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


​ Other Publisher Read-Only Data : Locally Retrieve:​

  • Load Other Publisher Read Data - Load the local read-only data from the latest "Get Other Publisher Read Data".

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


Conditions

The following condition groups:

  • Get Publisher Data

  • Get User Publisher Data

  • Get User Publisher Data

  • Get User Publisher Read-only Data

  • Get Other Publisher Data

  • Get Other Publisher Read-only Data

  • Update User Publisher Data

  • Load : Publisher Data

Get Publisher Data

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


  • On Get Publisher Data Error - Triggers when the Get Publisher Data Failed.


Get User Publisher Data​

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


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

​

Get User Publisher Read Only Data​

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


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

​

Get Other Publisher Data​

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


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

​

Get Other Publisher Read Only Data​

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


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

​

Update User Publisher Data​

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


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

​

Load : Publisher Data​

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

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


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

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


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


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

Expressions

The following expression groups:

  • Get User Publisher Dat

  • Get User Publisher Read-only Data

  • Update User Publisher Data

  • Get Other User Publisher Data

  • Get Other User Publisher Read-only Data

  • Load Publisher Data

  • Load User Publisher Data

  • Load User Publisher Read-only Data

  • Load Other User Publisher Data

  • Load Other User Publisher Read-only Data

  • Server Response

  • Request

  • Publisher

  • Load

Get User Publisher Data

  • getDataVersion - Returns the "User Publisher Data : Data Version" from the latest "Get Publisher Data". Indicates the current version of the data that has been set.


​ Get User Publisher Read-Only Data

  • getReadDataVersion - Returns the "User Publisher Read Data : Data Version" from the latest "Get User Publisher Data". Indicates the current version of the data that has been set.



Update User Publisher Data

  • updateDataVersion - Returns the "Update User Publisher : Data Version" from the latest "Update User Publisher Data". Indicates the current version of the data that has been set.


Get Other User Publisher Data

  • getODataVersion - Returns the "Other Publisher Data : Data Version" from the latest "Get Other Publisher Data". Indicates the current version of the data that has been set.


Get Other User Publisher Read-Only Data

  • getOReadDataVersion - Returns the "Other Publisher Read Data : Data Version" from the latest "Get Other Publisher Read Data". Indicates the current version of the data that has been set.


Load Publisher Data

  • retPublisherValue - Returns the "Publisher Data : Value" loaded from the "Load Publisher Data".


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


Load User Publisher Data

  • retDataValue - Returns the "User Publisher Data : Value" loaded from the "Load User Publisher Data".


  • retDataLastUpdated - Returns the "User Publisher Data : Last Updated" loaded from the "Load User Publisher Data".


  • retDataPermission - Returns the "User Publisher Data : Permission" loaded from the "Load User Publisher Data".


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


Load User Publisher Read-Only Data

  • retReadDataValue - Returns the "User Publisher Read Data : Value" loaded from the "Load User Publisher Read Data".


  • retReadDataLastUpdated - Returns the "User Publisher Read Data : Last Updated" loaded from the "Load User Publisher Read Data".


  • retReadDataPermission - Returns the "User Publisher Read Data : Permission" loaded from the "Load User Publisher Read Data".


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


Load Other User Publisher Data

  • retODataValue - Returns the "Other Publisher Data : Value" loaded from the "Load Other Publisher Data".


  • retODataLastUpdated - Returns the "Other Publisher Data : Last Updated" loaded from the "Load Other Publisher Data".


  • retODataPermission - Returns the "Other Publisher Data : Permission" loaded from the "Load Other Publisher Data".


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


Load Other User Publisher Read-Only Data

  • retOReadDataValue - Returns the "Other Publisher Read Data : Value" loaded from the "Load Other Publisher Read Data".


  • retOReadDataLastUpdated - Returns the "Other Publisher Read Data : Last Updated" loaded from the "Load Other Publisher Read Data".


  • retOReadDataPermission - Returns the "Other Publisher Read Data : Permission" loaded from the "Load Other Publisher Read Data".


  • 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

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


Publisher

  • StudioLoad - Return a publisher (studio) data value.

    • Key - The​ key of the publisher (studio) data.​​


​ Load

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

    • Key - The​ key of another user publisher data.​


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

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


  • UserLoad - Returns the user's studio data value.

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


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

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



Object   Properties

Plugin Properties

Properties
Showcase

Showcase

There is currently nothing to show, we will add more in the future.

Game Projects

Game Projects 

Instructions Kit

Specifications

  • Instructions - The game project contains instructions and steps on how to use the addon and its features.

  • Action, Conditions and Expressions - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks on the recommended ways of using the addon.

Supporters

Only

bottom of page