Title Manager

The PlayFab Title Manager Module is specifically designed to manage and utilize the title-wide features. 

 

In PlayFab, title refers to the game. Henceforth, this plugin lets you access the game-wide features including the following:

  • Store Items and Catalog

  • Title Data (Game Data)

  • Title News (Game News)

  • Server Time

  • Title Info (Game Info)

Catalog and Store items are request & managed here by the player clients for purchase transactions, of either virtual or real currency.

Title data, accessible by the entire game is managed here.

Title News like announcements are collected here, same as with the server time and other title info.

 

Intstructions

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

2. Then, add the Title Manager addon into the project.

Features :

  • Complete with Title (Game) management features.

  • Title Data, Title News and Title datetime.

  • Easy Title Loading features.

  • Store Listing and Catalog Items.

  • Organized request and receive feature.

Network Services :

  • Facebook

  • Google Plus

  • Game Center

  • Google Play

  • Facebook Instant Games

  • Steam

  • Xbox Live

  • Nintendo Switch

  • PS4

  • PlayFab

Actions, Conditions & Expressions

Actions

Actions.png

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 : Filtered:

  • 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

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

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.

Title Features

The Title Manager plugin has a few server console configurations that'll set you up for your professional game. These include game data, game news and game datetime. The complete store-listing feature is also included but that's best to discuss with the Virtual Currencies plugin. The configuration process will be discussed below:

Title Data.png

Step 1 : From PlayFab's Dashboard, select the Content side-tab.

Step 2 : Then select the Title Data tab.

Step 3 : Set the data that is to read by the client, except the internal data,  which is for admin or server automation reading purposes.

Title News.png

Step 4 : Select the Title News tab.

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

Step 6 : Access both the Title Data and News from your application using the Title Manager 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

Publisher

The Title Manager is a global game-wide scope of management, including global game data, it has a counterpart where it stores not only in the scope of the game, but the scope of the entire studio and its collection of games. Hence, global studio-wide scope of management and data. This is the Publisher plugin.

Virtual Currencies

The Title Manager can request for the complete store list and item catalogs, but the Virtual Currencies have this feature in its essential form. In making virtual stores which involves virtual currencies and virtual items, use the Virtual Currencies plugin to add that feature into your game applications.

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: