top of page

Title Manager

The Title Manager plugin is specifically designed to manage the title-wide (game-wide) features, for games built using Construct 3 and Construct 2.


In PlayFab, title refers to the game. The Title Manager plugin lets you access the game-wide features including the following:

  • Catalog

  • Store items

  • Title data (Global game data)

  • Title news (Game news)

  • Server time

  • Title info (Game info)


Catalog and Store items are requested and managed here for purchase transactions of either virtual or real currency through the player clients.

Title data is a game data allocation that is globally accessible by the entire game and is managed here.

Title news is like global game announcements for a game and is retrieved here same as server time and other title information.

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:

  • Game management features

  • Catalog

  • Store items

  • Store listing

  • Game economy management

  • Title data (Global game data)

  • Title news (Game news)

  • Server time

  • Title info (Game info)

  • Organized request and receive features.


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 Title Manager 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 Title Manager 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.



Title Features


The Title Manager plugin has features from its server console, including configurations that'll set you up for your professional online game. These include title data (global game data), title news (game news) and the game's server time in timestamp.



Step 1 : From the Dashboard, select the Content side tab.

​

Step 2 : Then select the Title Data tab.

​

Step 3 : Set the data that is to be read by the client, except the internal data, which is for admin or server automation purposes. Note: Like any other data in PlayFab, these can be managed automatically by the server through server automation, or requested by the client through the Cloud Script plugin or Azure Function plugin to run a cloud function from a script in server automation.



Step 4 : Select the Title News tab.

​

Step 5 : Set here the news you want to announce to your game application users.

​

Step 6 : Access both the Title Data and News from your application using the Title Manager plugin.


The catalog and store are included features as well. However, these are best read in the Virtual Currencies plugin documentation, please click to visit the documentation page.



Related Plugins


  • Publisher - is a plugin that implements studio-wide features, including global data accessible in multiple games belonging to a studio, and studio management features. In comparison, the Title Manager plugin implements title-wide (game-wide) features, including global data accessible in the current title (game), and game management features.

  • Virtual Currencies - is a plugin for managing a user's purchases, subscriptions, claims, redeem codes and player inventory through the PlayFab service. The Title Manager has the features to manage the game economy, and retrieve the catalog and store listing. However, for the user's own inventory, purchases, subscriptions, claims, transactions and buyer information, the Virtual Currencies plugin is needed to manage the user's side of the economy, including making payments, subscriptions and claims.

ACEs

Actions, Conditions & Expressions

Actions

The following action groups:

  • Store Listing

  • Title-Wide

  • Title-Data : Filtered

  • Title-Data : Retrieve Data

Store Listing​

  • Get Catalog Items - Retrieves the specified version of the title's catalog of virtual goods, including all defined properties.

    • Tag - The tag to differentiate requests.​


  • Get Catalog Items with Version - Retrieves the specified version of the title's catalog of virtual goods, including all defined properties.

    • Catalog Version - ​The "Catalog Version" to be requested.

    • Tag - The tag to differentiate requests.


  • Get Store Items - Retrieves the set of items defined for the specified store, including all prices defined.

    • Store ID - ​Unique identifier for the store which is being requested.

    • Tag - The tag to differentiate requests.


  • Get Store Items with Version - Retrieves the set of items defined for the specified store, including all prices defined.

    • Store ID - ​Unique identifier for the store which is being requested.

    • Catalog Version - ​The "Catalog Version" to be requested.

    • Tag - The tag to differentiate requests.


​

Title-Wide​

  • Get Time - Retrieves the current server time.


  • Get All Title Data - Retrieves all the key-value store of custom title settings.​

    • Tag - The tag to differentiate requests.​


  • Get Title News - Retrieves the title news feed, as configured in the developer portal.

    • Count - ​Limits the results to the last "n" entries. Default is "10".


​ Title-Data : Filtered​

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

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


  • Get Title Data - Retrieves the key-value store of custom title settings.

    • Tag - The tag to differentiate requests.​


​ Title-Data : Retrieve Data​

  • Load Title Data - Retrieves the Title-Data value with a key from a previous "Get Title Data".

    • Key - ​The "Key Name" for the Title Data.

Conditions

The following condition groups:

  • Store Listing

  • Title-Wide

  • Title-Data : Retrieve Data

  • Get Catalog Items

  • Get Store Items

  • Get Title News

Store Listing​

  • On Get Catalog Items - Triggers when the Get Catalog Items Succeeded.


  • On Get Catalog Items Error - Triggers when the Get Catalog Items Failed.


  • On Get Store Items - Triggers when the Get Store Items Succeeded.


  • On Get Store Items Error - Triggers when the Get Store Items Failed.​



Title-Wide​

  • On Get Time - Triggers when the Get Time Succeeded.


  • On Get Time Error - Triggers when the Get Time Failed.


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


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


  • On Get Title News - Triggers when the Get Title News Succeeded.


  • On Get Title News Error - Triggers when the Get Title News Failed.


​ Title-Data : Retrieve Data​

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

    • Key - ​The "Key Name" for the Title Data.


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

    • Key - ​The "Key Name" for the Title Data.​


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


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

​

Get Catalog Items

  • For Each Catalog Item - Loops through all the Catalog Items using the "loopCatalogItems" expression.

​

Get Store Items

  • For Each Store Item - Loops through all the Store Items using the "loopStoreItems" expression.

​

Get Title News

  • For Each Title News - Loops through all the Title News using the "loopTitleNews" expression.

Expressions

The following condition groups:

  • Get Catalog Items : Main

  • Get Catalog Items : Virtual Currency

  • Get Catalog Items : Real Currency

  • Get Catalog Items : Check

  • Get Catalog Items : Exclusive

  • Get Catalog Items : Consume

  • Get Catalog Items

  • Get Store Items : Main

  • Get Store ITems : Marketing Data

  • Get Store Items : Source

  • Get Store Items : Store

  • Title-Wide

  • Title-Wide : News

  • Title-Data : Retrieve Data

  • Server Response

  • Request

  • Load

Get Catalog Items : Main

  • catalogItemID - Get the "Item ID" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".


  • catalogItemClass - Get the "Item Class" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​


  • catalogVersion - Get the "Catalog Version" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​


  • catalogDisplayName - Get the "Item Display Name" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​


  • catalogDescription - Get the "Item Description" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​


  • catalogItemImage - Get the "Item Image URL" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​


  • catalogCustomData - Get the "Item Custom Data" from a specific index from the list of Catalog Items.



Get Catalog Items : Virtual Currency

  • catalogVirtualPrice - Get the "Virtual Currency Prices" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".

    • CurrencyKey - The "Key Name" of the Currency.


​ Get Catalog Items : Real Currency

  • catalogRealPrice - Get the "Real Currency Prices" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".

    • CurrencyKey - The "Key Name" of the Currency.


​ Get Catalog Items : Check

  • isStackable - Get the "Is Stackable" from a specific index from the list of Catalog Items. Returns "True" or "False".

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".


  • isLimitedEdition - Get the "Is Limited Edition" from a specific index from the list of Catalog Items. Returns "True" or "False".

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".


​ Get Catalog Items : Exclusive

  • limitedEditionCount - Get the "Initial Limited Edition Count " from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".


​ Get Catalog Items : Consume

  • consumeUsageCount - Get the "Item : Usage Count" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​


  • consumeUsagePeriod - Get the "Item : Usage Period" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​​


  • consumeUsagePeriodGroup - Get the "Item : Usage Period Group" from a specific index from the list of Catalog Items.

    • Index - ​The Index to lookup from the Catalog Items. Collected from the latest "Get Catalog Items".​​


Get Catalog Items

  • loopCatalogItems - Returns the "Catalog Item Index" from the "For Each Catalog Item" looped through the Catalog Items List.


  • countCatalogItems - Returns the "Catalog Item Count" that was retrieved from the server.

​

Get Store Items : Main

  • storeID - Get the "Store ID". The ID of this store.


  • storeCatalogVersion - Get the "Catalog Version". The base catalog that this store is a part of.

​

Get Store Items : Marketing Data

  • marketDescription - Get the "Marketing Description". The Tagline for a store.​


  • marketDisplayName - Get the "Marketing Display Name". The Display name of a store as it will appear to users.


  • marketMetadata - Get the "Marketing Metadata". The Custom data about a store.

    • Key - ​The "Key Name" of the Custom Data or Metadata.


​ Get Store Items : Source

  • sourceType - Get the "Source Type", how the store was last updated (Admin or a third party). Either "Admin", "BackEnd", "GameClient", "GameServer", "Partner", "Custom", or "API".

​

Get Store Items : Store

  • storeDisplayPosition - Get the "Display Position". Intended display position for this item. Note that "0" is the first position.

    • Index - The Index to lookup from the Store Items. Collected from the latest "Get Store Items".


  • storeItemID - Get the "Display Item ID". Unique identifier of the item as it exists in the catalog.

    • Index - The Index to lookup from the Store Items. Collected from the latest "Get Store Items".


  • storeRealPrice - Get the "Real Currency Prices". Override prices for this item for specific currencies.

    • Index - The Index to lookup from the Store Items. Collected from the latest "Get Store Items".

    • CurrencyKey - The "Key Name" of the Currency.


  • storeVirtualPrice - Get the "Virtual Currency Prices". Override prices for this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies).

    • Index - The Index to lookup from the Store Items. Collected from the latest "Get Store Items".

    • CurrencyKey - The "Key Name" of the Currency.


  • storeCustomData - ​Get the "Custom Data". Store specific custom data. The data only exists as part of this store; it is not transferred to item instances.

    • Index - The Index to lookup from the Store Items. Collected from the latest "Get Store Items".

    • Key - The "Key" reference for the Custom Data.


  • loopStoreItems - ​Returns the "Store Item Index" from the "For Each Store Item" looped through the Store Items List.


  • countStoreItems - ​Returns the "Store Item Count" that was retrieved from the server.

​

Title-Wide

  • getTime - Get the "Title Time". The current server time when the request was received, in UTC.

​

Title-Wide : News

  • getNewsTimeStamp - Get the "Title News Timestamp". The Date and time when the news items was posted.

    • Index - The Index to lookup from the Title News List. Collected from the latest "Get Title News".


  • getNewsTitle - Get the "Title News Title". The Title of the news item.

    • Index - The Index to lookup from the Title News List. Collected from the latest "Get Title News".


  • getNewsBody - Get the "Title News Body". The News item text.

    • Index - The Index to lookup from the Title News List. Collected from the latest "Get Title News".


  • getNewsID - Get the "Title News ID". The Unique identifier of news item.

    • Index - The Index to lookup from the Title News List. Collected from the latest "Get Title News".


  • loopTitleNews - Returns the "Title News Index" from the "For Each Title News" that was retrieved from the server.


  • countTitleNews - Returns the "Title News Count" that was retrieved from the server.

​

Title-Data : Retrieve Data

  • retTitleDataValue - Returns the "Title Data Value" from the recent "On Load User Title Data".


  • retTitleDataKey - Returns the "Title Data Key" from the recent "On Load User Title 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.​

​

Load

  • Load - Returns the title (game) data value.

    • Key - The​ key of the title (game) 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