Steamworks Ext (1.5.0)
IMPORTANT
- This extension version will be compatible with the GM 2022.0.1 LTSr1 (upon release)
- This extension is to be used with GM 2023.1 and future releases.
- Requires Steamworks SDK version 1.55 (or recent)
- Works with Windows, macOS and Ubuntu.
- macOS (VM) not supported
CHANGES SINCE 1.4.5
Async Event app_resuming_from_suspend
:
Thrown when Steam Deck has resumed from suspend.
Has no members besides event_type
.
Async Event steam_shutdown
:
Thrown when the Steam client is about to shutdown, usually you have a few seconds to finish stuff.
Has no members besides event_type
.
Async Event remote_storage_local_file_change
:
Has no additional members besides event_type
, use functions steam_get_local_file_change_count
and steam_get_local_file_change
to get the actual change data.
Function steam_get_local_file_change_count
:
Parameters: None
Returns: Amount of changes in a local file change event, use steam_get_local_file_change
to get the data
Function steam_get_local_file_change
:
Parameters: {Real} index Zero-based index of the file change
Returns: File change struct
Struct SteamLocalFileChange
:
Members:
Member local_file_change
- what happened to the file? a constant.
steam_local_file_change_invalid
- impossible value
steam_local_file_change_updated
- file's contents were updated
steam_local_file_change_deleted
- the file was deleted
Member file_path_type
- what file type is this? a constant.
steam_local_file_path_type_invalid
- impossible value
steam_local_file_path_type_absolute
- absolute path to a file inside the Auto Cloud folder (should be your save folder, which means it should be already in the filesystem sandbox)
steam_local_file_path_type_api_filename
- a file for the steam_file_*
functions
Member name
- either a full path or an api filename. a string.
If file_path_type == steam_local_file_path_type_api_filename
then pass name
to the steam_file_*
functions.
If file_path_type == steam_local_file_path_type_absolute
then use buffer_load
or any other function to read a file.
Function steam_user_cancel_auth_ticket
:
Parameters: {Real} [ticket_handle] OPTIONAL ticket handle to cancel
Returns: Nothing
Async Event ticket_response
:
Members:
result
- Steam EResult code
success
- result == EResultOK
auth_ticket_handle
- the handle of the auth ticket, can be passed to steam_user_cancel_auth_ticket
Function steam_utils_is_steam_in_big_picture_mode
:
Parameters: None
Returns: Bool, whether the game is running in Big Picture mode or not
Function steam_utils_set_game_launcher_mode
:
Parameters: {Bool} launcher_mode
Returns: Nothing
Can be used to set your game into "launcher mode" if your launcher is written with GameMaker (can be used alongside game_change
?)
DESCRIPTION
Steamworks is a set of tools and services that help game developers and publishers build their games and get the most out of distributing on Steam.
FEATURES
- General API
- Achievements
- Statistics
- Leaderboards
- Cloud Storage
- DLC
- UGC
- Network
- Matchmaking
- Lobby
- Inventory
- Input
DOCUMENTATION
The full documentation of the API is included in the extension asset (included files).