Steam Settings
Configuration and easy access to key artefacts
Last updated
Configuration and easy access to key artefacts
Last updated
Support us as a 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 ... become a sponsor today!
SteamSettings is the root of Heathen's Steamworks.
SteamSettings inherits from ScriptableObject, which means it can be referenced at development time and across all scenes without the overhead a MonoBehavior brings with it. In addition the SteamSettings object includes static references to the active Steamworks Behaviour, Client settings DLC, Stats and Achievements and most other referenced artefacts.
There are three ways to interact with and access the most important parts of SteamSettings at runtime.
This is a static reference to the initialized SteamSettings object. It gets initialized when the Init Method gets called by the Steamworks Behaviour component.
This is a static reference to the initialized SteamSettings.GameClient. The GameClient member provides easy access to features and systems relevant for your "client", that is the application the end user is actually playing e.g. your game. This would include features such as overlay, friends, clans, stats, achievements, and more.
This is a static reference to the initialized SteamSettings.GameServer. The GameServer member in contrast deals with the configuration of Steamworks server related features, and only comes into play for server builds.
This and its related functionality is stripped out of the compile on client builds. That is this code will not compile and will not be available for use in normal / client builds.
A static reference to the currently initialized Steam Settings object.
A static reference to the Steamworks Behaviour that initialized the Steam API and is managing the Steam update loop.
A static reference to the collection of achievement objects being managed by the system.
A static reference to the App ID recorded for the active settings object.
A static valid indicating rather or not the API experienced an error on initialization.
If initialization had an error a message will be available in this field indicating what or why.
A static value indicating rather or not the Steam API has been initialized.
A static reference to the active client tools and features if available. Note it is possible to have this stripped out of compilation for server builds.
A static reference to the active server tools and features if available. Note it is possible to have this stripped out of compilation for client builds.
occurs when steam initializes, This event handler does not take any arguments
occurs when steam initialization has an error, This event handler provides a string message indicating the likely problem or response from Steam.
Initializes the Steam API based on the configuration settings defined in the settings object. This will initialize the Steam Game Server APIs for server builds or the Steam API (client api) for client builds.
Used to create a SteamworksBehaviour at run time if required. If one is already present this will do nothing.
Static version of CreteatBehaviiour
A static reference to the collection of being managed by the system.
A static reference to the collection of being managed by the system.
A static reference to the collection of stat objects being managed by the system. This includes both and based stats.