This page explains the formats Metadata can be stored in, how Tags work, and how Game Read access controls where Metadata can be read from.
Types of Metadata
Metadata can be stored in a variety of formats:
- String: Ideal for storing text, such as names or descriptions.
- Base64: Used for encoding files like icons, thumbnails or other binary data.
- Boolean: A true/false value, useful for toggling settings such as whether a store item is featured.
- Number: Stores numeric values, such as scores or item prices.
- JSON: A structured format for storing complex objects, like configurations or items with a list of stats.
Tags
Tags are an optional input that let you categorize or label Metadata entries. This makes it easier to search and filter Metadata in the client or on the server. For example, you can use tags to flag certain Metadata entries as "seasonal" or "limited edition" to tailor in-game content accordingly.
Game Read Access
The Game Read checkbox controls whether Metadata can be accessed via the Game API. If selected, the Metadata is available to the game client through the Game API. If not selected, the Metadata is only accessible via the Server API. This is primarily used for security purposes, to keep sensitive information server-side and out of reach from the game client.
Conclusion
Now that you understand Metadata types, Tags, and Game Read access, see Add Metadata in Console to create your first Metadata field.