General

Overview

There are various service level interfaces to a platform that don't specifically fall into the other categories.

This includes getting service information (such as whether the service is available), as well as some platform level events such as service errors or shutdown events.

The GamePlatformPlugin also provides each service with "Environment Variables", which allow the implementation to provide data from a platform that doesn't have an abstracted interface.

General Service Functions

GetApplicationId

Retrieves the Application ID of the game on the platform.

Platform(s)Discord, Steam
APICry::GamePlatform::IService::GetApplicationId
Flow Graph NodesGamePlatform:General:ApplicationId
Schematyc NodesFunction::GamePlatform::Service::General::GetApplicationId

GetBuildId

Retrieves the Build ID of the game on the platform.

Platform(s)Steam
APICry::GamePlatform::IService::GetBuildId
Flow Graph NodesGamePlatform:General:BuildId
Schematyc NodesFunction::GamePlatform::Service::General::GetBuildId

GetEnvironmentValue

Retrieves the Environment Variable of the platform.

Platform(s)Discord, Steam
APICry::GamePlatform::IService::GetEnvironmentValue
Flow Graph NodesGamePlatform:General:GetEnvironmentVariable
Schematyc Nodes Function::GamePlatform::Service::General::GetEnvironmentValue

GetService

Retrieves details of the registered game platform service.

Platform(s)Discord, Steam
APICry::GamePlatform::IPlugin::GetService
Flow Graph NodesGamePlatform:General:GetService
Schematyc NodesFunction::GamePlatform::Service::General::GetServiceName

MarkContentCorrupt

Tells the platform to verify the data files on next launch.

Platform(s)Steam
APICry::GamePlatform::IService::MarkContentCorrupt
Flow Graph NodesGamePlatform:General:MarkContentCorrupt
Schematyc NodesFunction::GamePlatform::Service::General::MarkContentCorrupt

OwnsApplication

Checks if the local user owns the specified application on the platform.

Platform(s)Steam
APICry::GamePlatform::IService::OwnsApplication
Flow Graph NodesGamePlatform:General:OwnsApplication
Schematyc NodesFunction::GamePlatform::Service::General::OwnsApplication

General Service Events

OnEnvironmentVariableChanged

Fired when an Environment Variable is updated.

Platform(s)Discord, Steam
APICry::GamePlatform::IService::IListener::OnEnvironmentVariableChanged
Flow Graph NodesGamePlatform:Listener:Service:OnEnvironmentVariableChanged
Schematyc NodesSignal::Receive::[EntityName]::Accounts::PlatformSignalReceiver::Service::OnEnvironmentVariableChanged

OnOverlayActivated

Fired when an overlay (for example, the Steam overlay) has been activated by the user.

Platform(s)Steam
APICry::GamePlatform::IService::IListener::OnOverlayActivated
Flow Graph NodesGamePlatform:Listener:Service:OnOverlayActivated
Schematyc NodesSignal::Receive::[EntityName]::Accounts::PlatformSignalReceiver::Service::OnOverlayActivated

OnShutdown

Fired when the service is about to shut down.

Platform(s)Discord, Steam
APICry::GamePlatform::IService::IListener::OnShutdown
Flow Graph NodesGamePlatform:Listener:Service:OnShutdown
Schematyc NodesSignal::Receive::[EntityName]::Accounts::PlatformSignalReceiver::Service::OnShutdown