Documentation

 

Rich Presence

Overview

The Rich Presence abstraction attempts to unify the functionality of presenting the status of local users to other clients on a platform.

The implementation and corresponding options of Rich Presence vary across each platform in terms of what and how data is shown to other clients. For this reason, currently only Discord has full Rich Presence functionality as it provides the most options. Other platforms will make use of the Status (or the Headline Data) interface to provide basic presence information.

Rich Presence Service Functions

GetRichPresence

Gets the rich presence data for the local user on the specified platform.

PlatformsDiscord
APICry::GamePlatform::IService::GetRichPresence
Flow Graph NodesGamePlatform:Account:RichPresence
Schematyc NodesFunction::GamePlatform::Service::Accounts::GetRichPresence

SetRichPresence

Sets the rich presence data for the local user on the specified platform.

PlatformsDiscord
APICry::GamePlatform::IService::SetRichPresence
Flow Graph NodesGamePlatform:Account:RichPresence
Schematyc NodesFunction::GamePlatform::Service::Accounts::SetRichPresence

SetStatus

Sets the status string for the local user on the specified platform.

  • The status string is the displayed text that shows what the user is currently doing in a game. For example, playing on a certain map, etc. Each platform implements this differently.
  • To retrieve the status, use GetRichPresence and read the "headline" output.
  • On most, if not all platforms, setting the status string for the local user is not instant and make take up to 3 minutes to be visible by other users on the platform.
  • Executing this too often will cause some calls to be ignored. As a rule of thumb, only execute this function at most every 3 minutes as needed. If the text you want displayed doesn't change, there is no need to set it again.
PlatformsDiscord, Steam
APICry::GamePlatform::IService::SetStatus
Flow Graph NodesGamePlatform:Account:SetStatus
Schematyc NodesFunction::GamePlatform::Service::Accounts::SetStatus
Rich Presence Service Functions
GetRichPresence
SetRichPresence
SetStatus
Crytek GmbH uses cookies on this website to improve your experience, analyze our traffic and integrate with social media. You may adjust cookie preferences by clicking “customize” or withdraw decision to accept or reject cookies at any time. Please find further information in our Privacy and Cookie policies.
Customize