-
Notifications
You must be signed in to change notification settings - Fork 155
API Reference
The greenworks
module gives you ability to access Steam APIs, a simple example:
var greenworks = require('./greenworks-osx');
if (greenworks.initAPI()) {
console.log('Steam API has been initalized.');
} else {
console.log('Error on initializing Steam API');
}
##References
###Greenworks.initAPI()
Returns a Boolean
whether Steam APIs were successfully initialized or not.
Note: You need to launch and log in the Steam Client, and put steam_appid.txt
under your app directory.
###Greenworks.saveTextFoFile(file_name, file_content, success_callback, error_callback)
-
file_name
String -
file_content
String -
success_callback
Function() -
error_callback
Function(err)
###Greenworks.readTextFromFile(file_name, success_callback, error_callback)
-
file_name
String -
success_callback
Function(file_content)-
file_content
String: represents the content offile_name
file.
-
-
error_callback
Function(err)
###Greenworks.isCloudEnabled()
Returns a Boolean
indicates whether cloud is enabled for the current app.
###Greenworks.enableCloud(flag)
-
flag
Boolean
Enables/Disables the cloud feature for the current app.
###Greenworks.getCloudQuota(success_callback, error_callback)
-
success_callback
Function(total_bytes, available_bytes)-
total_bytes
Integer: total bytes of quota -
available_bytes
Integer: available bytes of quota
-
-
error_callback
Function(err)
###Greenworks.activateAchievement(achievement, success_callback, error_callback)
-
achievement
String -
success_callback
Function() -
error_callback
Function(err)
The achievement
represents the unlocked achievement in your game.