steam_file_share

Force the Steam API to synchronise the given file with the Steam Cloud.

Syntax:

GML Code Example

steam_file_share(filename);


Argument Description
filename The name of the file synchronise.


Returns: Real


Description

With this function you can force your game to synchronise the given file with the Steam Cloud. This is not normally necessary due to the fact that the game will synchronise automatically at the end of the player's session, nor is it recommended by Steam, but it can be useful to ensure sensitive information is synchronised immediately. The function will return a value of 0 if it fails for whatever reason and a value greater than 0 if it succeeds.


Example:

GML Code Example

if !steam_file_persisted("Save.txt")
    {
    steam_file_share("Save.txt");
    }
 

The above code will check to see if a file has been stored to the Steam Cloud, and if it has not it will then synchronise it.





No Examples Submitted

Does this page need better examples? Be the first to Submit

No Edits Suggested

Is this page unclear or not descriptive enough? Suggest an edit to the page and with enough upvotes your changes will be made.

No Questions Have Been Ask

Do you have a question about this page? Ask it Here