Game Foundation Tutorials

Adding static properties with details

Creating catalog items is a mandatory step to building your static data. But you may need to give more details about your catalog items, other than a name, an id and some categories.

The details give you the possibility to add sets of information, the same way you can add components to a gameobject.

Creating Details

In this tutorial, we'll add details to our item definition, but keep in mind that you can add details to any catalog items (currencies, virtual transactions, IAP transactions, stores).

Adding details to an item definition is done in the Inventory Window. Open this window (Window → Game Foundation → Inventory)

The Detail Definitions section contains the details of the item definition.

Details are blocks of static data you can add to a definition in order to enrich it.

A couple of details are available in Game Foundation. You can see the list of details if you click on the Add Detail button.

The list of available details

The available details are:

For this tutorial, we'll focus on the most flexible one: the Json Detail.

Click on the Add Detail button, then select Json Detail.

Adding a custom field to the the Json Detail

Now that a Json Detail is added to the item definition, we can add custom fields to it. The Json detail always shows the field creation form. You have two fields to fill:

  • the entry name is the name of the field. We'll use this name to access the value in the code.
  • the type of the field. You can see the list of all the supported types in the screenshot above.

Json Detail interface

Create the MyPersonalField field, of type String.
Then click on the large + button at the bottom of the field creation section. It adds the field to the detail.

The field value is now editable

You now can define a value for your field. This is a static value. You won't be able to change it.

Write "Lorem Ipsum Dolot Sirt Amet".

Getting the details at runtime

Let's switch to the coding part now.
As a prerequisite step, please make sure you've followed the steps for getting an item definition found in the inventory tutorial.

In your OnInitSucceeded method, replace the code below the null-check of the definition variable, and append the following code:

var definition = catalog.FindItem(definitionId);

if (definition is null)
{
    Debug.Log($"Definition {definitionId} not found");
    return;
}

// Insert your code here

// Retrieving the detail by its type.
var detail = definition.GetDetail<JsonDetail>();

// If the item hasn't had a json detail added in the inventory
// window, this will return null.
if (detail is null)
{
    Debug.LogError($"Detail {nameof(JsonDetail)} not found in '{definition.displayName}'");
    return;
}

Debug.Log($"Detail {detail.GetType().Name} found");

Compile and start your scene. You should see a new log entry:

! Detail JsonDetail found

Now than you have a reference to your detail, you can use the specific API of this detail to get info.
For the Json detail, you can use the TryGetBuiltInData<> method.
Append the following code to the OnInitSucceeded method.

const string fieldName = "MyPersonalField";

var found = detail.TryGetBuiltInData<string>(fieldName, out var message);
if (!found)
{
    Debug.LogError($"{fieldName} not found");
    return;
}

Debug.Log($"Message found: {message}");

Compile and start your scene. You should see a new log entry:

! Message found: Lorem Ipsum Dolor Sit Amet

Conclusion

A full description of the Json Detail is available in its dedicated page, and you can discover more about the other details via the Details page.

What if I would like to add properties that can be modified within an item instance? We'll see that in the next tutorial.