Links

Data Layer

Simple structs, powerful features!

Like what your seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

A mid level abstraction of Steam API and a common code base between Godot and Unity. These `Data` objects such as UserData, LobbyData, AchievementData and more have engine specific features such as returning avatars, icons, etc. in the engine's native "texture" format but will have identical functionality between the two engines.
Data objects are simple structs that are implicitly convertible with the underlying native data type for example one can convert a ulong value to a UserData object
UserData myFriend = 123456789987;
Data objects are also implictly convertable with Steam's native types for each artifact for example
CSteamID friendNativeId = new CSteamID(123456789987);
UserData myFriend = friendNativeId;
This implicit conversion means that you can use Heathen's Data layer interchangeably with any other system for either the underlying primitive type or the Steam API native type without needing to manually convert your self.
This also means you can easily get all of the core features of each artifact quickly and easily and with no need of reference objects or use of APIs ours or raw Steam API.
Debug.Log($"Hello {myFriend.Nickname} its good to see you!");
Data objects provide simple static `Get` methods for those of you uncomfortable with implicit conversion.
UserData myFriend = UserData.Get(123456789987);
In most cases we have Get overloads for multiple valid types for example the UserData object can read a ulong value and interpret it as a CSteamID and it can read an int value and interpret it as an account / friend ID.
The addition of the Data Layer brings a new level of utility to the Steamworks integration which is of great use for scripters and programmers but also simplifies work for designers and UI/UX teams. Scriptable Objects will still be present and have all the functionality they do now they will simply be changed to work with the new Data Layer.