Live Data Overview #

The Player Data service contains classes and interfaces for templating a player data feature’s live data. In the service, live data is stored as an Entity, and Entities allow you to customize your own data model from a list of user-defined Components. This formula allows the developer to fully contextualize their live data models for a player data feature within the Player Data service, rather than fit their player data feature to an already existing live data model.

 Boxes showcasing how Entities and Components store live data for two seperate players.

An Entity is created and assigned to players in an Operation function, including its structure and list of Components. The Components utilized in an Entity must be defined first before they can be authored in an Operation. Operations are also in charge of modifying and deleting Entities and their lists of Components when they’re live for a player.

An Entity and its list of Components are all defined in Kotlin. However, a Component can utilize data from a predefined Content Schema class and JSON catalog if desired.

Live data in the form of an Entity are useful for various different parts of a player data feature, and there are many different ways of solving how to model your data with Entities and Components.

Continue reading for more information about the important classes associated with live data.

Component Class #

Components are data classes for storing user-defined player data. A Component must be registered to an Entity. An Entity is a Pragma Engine class that holds a collection of Components. To create, update, and

Learn how to implement this class in the Define a Component class task.

Hidden Component Class #

Hidden Components are data classes for storing user-defined player data that will not be sent to the PLAYER gateway and the game client. Instead of inheriting the Component interface, a hidden Component class implements HiddenComponent, which contains logic for the Player Data service to recognize that the data should reside solely in the backend and database. In other words, all other backend gateways (SERVICE, PARTNER, and OPERATOR) will still get an unfiltered view of HiddenComponent data.