Drag[en]gine Script Module DragonScript 1.23
Loading...
Searching...
No Matches
Dragengine.Services.ServiceSteam Class Reference

Service providing access to Steam SDK functionality if supported. More...

Inheritance diagram for Dragengine.Services.ServiceSteam:
Dragengine.ServiceListener

Classes

class  InitParameters
 Service initialization parameters. More...
 

Public Member Functions

void addStatListener (ServiceStatsListener listener)
 
void dispose ()
 Dispose of Steam SDK service.
 
void getAuthToken (ServiceUserListener listener)
 
BaseServiceConversions getConversions ()
 Conversion helper.
 
void getStatsAndAchievements (Set stats, Set achievements, ServiceStatsListener listener)
 
ServiceUserFeatures getUserFeatures ()
 
void getUserInfo (ServiceUserListener listener)
 
void getUserWalletBalance (ServiceUserListener listener)
 
void loginUser (ServiceUserCredentials credentials, ServiceUserListener listener)
 
ServiceSteam new (InitParameters params)
 Create service ServiceSteamSdk.
 
void removeStatsListener (ServiceStatsListener listener)
 
void removeUserListener (ServiceUserListener listener)
 
void requestResponse (Service service, UniqueID id, ServiceObject response, bool finished)
 Response received for request.
 
void setStatsAndAchievements (Dictionary stats, Dictionary achievements, ServiceStatsListener listener)
 
- Public Member Functions inherited from Dragengine.ServiceListener
void eventReceived (Service service, ServiceObject event)
 Service event received for example notifications.
 
void requestFailed (Service service, UniqueID id, ServiceObject error)
 Request failed.
 

Static Public Member Functions

static bool isServiceSupported ()
 Checks if Steam SDK service is supported.
 

Public Attributes

BaseServiceConversions pConversions
 
Set pGetStatsApiNames
 
InitParameters pInitParameters
 
Dictionary pOnceListeners
 
Service pService
 
Set pSetStatsApiNames
 
SafeArray pStatsListeners
 

Static Public Attributes

static final String authProviderId = "steam"
 Authentification provider identifier.
 

Detailed Description

Service providing access to Steam SDK functionality if supported.

Version
1.23

Provides access to these functionalities:

  • Stats/Achievements
  • User

Member Function Documentation

◆ addStatListener()

void Dragengine.Services.ServiceSteam.addStatListener ( ServiceStatsListener  listener)

◆ dispose()

void Dragengine.Services.ServiceSteam.dispose ( )

Dispose of Steam SDK service.

◆ getAuthToken()

void Dragengine.Services.ServiceSteam.getAuthToken ( ServiceUserListener  listener)

◆ getConversions()

BaseServiceConversions Dragengine.Services.ServiceSteam.getConversions ( )

Conversion helper.

◆ getStatsAndAchievements()

void Dragengine.Services.ServiceSteam.getStatsAndAchievements ( Set  stats,
Set  achievements,
ServiceStatsListener  listener 
)

◆ getUserFeatures()

ServiceUserFeatures Dragengine.Services.ServiceSteam.getUserFeatures ( )

◆ getUserInfo()

void Dragengine.Services.ServiceSteam.getUserInfo ( ServiceUserListener  listener)

◆ getUserWalletBalance()

void Dragengine.Services.ServiceSteam.getUserWalletBalance ( ServiceUserListener  listener)

◆ isServiceSupported()

static bool Dragengine.Services.ServiceSteam.isServiceSupported ( )
static

Checks if Steam SDK service is supported.

Service is reported supported if the Steam SDK Service Module is present. Creating the service can still fail if Steam is not running.

◆ loginUser()

void Dragengine.Services.ServiceSteam.loginUser ( ServiceUserCredentials  credentials,
ServiceUserListener  listener 
)

◆ new()

ServiceSteam Dragengine.Services.ServiceSteam.new ( InitParameters  params)

Create service ServiceSteamSdk.

Parameters
paramsInit parameters.
Exceptions
EInvalidParamSteam service module is not present.
EInvalidActionSteam is not running.
EInvalidActionSteam SDK can not be initialized.

◆ removeStatsListener()

void Dragengine.Services.ServiceSteam.removeStatsListener ( ServiceStatsListener  listener)

◆ removeUserListener()

void Dragengine.Services.ServiceSteam.removeUserListener ( ServiceUserListener  listener)

◆ requestResponse()

void Dragengine.Services.ServiceSteam.requestResponse ( Service  service,
UniqueID  id,
ServiceObject  response,
bool  finished 
)

Response received for request.

Parameters
serviceService receiving the response.
idIdentifier of request this response belongs to.
responseResponse data.
finishedTrue if the request finished or false if more responses will be received.

Implements Dragengine.ServiceListener.

◆ setStatsAndAchievements()

void Dragengine.Services.ServiceSteam.setStatsAndAchievements ( Dictionary  stats,
Dictionary  achievements,
ServiceStatsListener  listener 
)

Member Data Documentation

◆ authProviderId

final String Dragengine.Services.ServiceSteam.authProviderId = "steam"
static

Authentification provider identifier.

◆ pConversions

BaseServiceConversions Dragengine.Services.ServiceSteam.pConversions

◆ pGetStatsApiNames

Set Dragengine.Services.ServiceSteam.pGetStatsApiNames

◆ pInitParameters

InitParameters Dragengine.Services.ServiceSteam.pInitParameters

◆ pOnceListeners

Dictionary Dragengine.Services.ServiceSteam.pOnceListeners

◆ pService

Service Dragengine.Services.ServiceSteam.pService

◆ pSetStatsApiNames

Set Dragengine.Services.ServiceSteam.pSetStatsApiNames

◆ pStatsListeners

SafeArray Dragengine.Services.ServiceSteam.pStatsListeners

The documentation for this class was generated from the following file: